mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-23 18:17:20 +00:00
Docs updates
This commit is contained in:
Jeremy Ruston
parent
d7896f051a
commit
82bb5c3688
@ -1,7 +1,8 @@
|
||||
<h1 class=''>
|
||||
Using <span>
|
||||
TiddlyWiki5</span> to build <span>
|
||||
TiddlyWikiClassic</span></h1><p>
|
||||
Building classic <span>
|
||||
TiddlyWiki</span> with <span>
|
||||
TiddlyWiki5</span></h1><div class='tw-transclude'>
|
||||
<p>
|
||||
<span>
|
||||
TiddlyWiki5</span> can be used to build older 2.x.x versions of <span>
|
||||
TiddlyWiki</span> from their constituent components. Doing so involves these additional features over and above those used for building <span>
|
||||
@ -32,4 +33,4 @@ node ../../tiddlywiki.js \
|
||||
--verbose \
|
||||
--load <path_to_recipe_file> \
|
||||
--savetiddler $:/core/templates/tiddlywiki2.template.html <path_to_write_index_file> text/plain \
|
||||
|| exit 1</pre>
|
||||
|| exit 1</pre></div>
|
||||
@ -1,7 +1,5 @@
|
||||
title: TiddlyWiki2ReadMe
|
||||
|
||||
\define tw-wikilinks() no
|
||||
! Using TiddlyWiki5 to build TiddlyWikiClassic
|
||||
title: Building classic TiddlyWiki with TiddlyWiki5
|
||||
tags: docs
|
||||
|
||||
TiddlyWiki5 can be used to build older 2.x.x versions of TiddlyWiki from their constituent components. Doing so involves these additional features over and above those used for building TiddlyWiki5:
|
||||
|
||||
10
editions/tw5.com/tiddlers/Demos.tid
Normal file
10
editions/tw5.com/tiddlers/Demos.tid
Normal file
@ -0,0 +1,10 @@
|
||||
title: Demos
|
||||
tags: introduction
|
||||
|
||||
Here are a few features of TiddlyWiki that you can explore:
|
||||
|
||||
* Invoke a demonstration wizard: <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">demo</$button> (the text of the wizard is in the tiddler SampleWizard)
|
||||
* Save this wiki as a static HTML file: <$button message="tw-save-wiki" param="$:/core/templates/static.template.html" class="btn">Save Static</$button>
|
||||
* Browse the list of AllTiddlers or the ShadowTiddlers
|
||||
* Examine the example [[bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]]
|
||||
* Check out the TaskManagementExample
|
||||
@ -1,4 +1,4 @@
|
||||
title: Internals
|
||||
title: DeveloperDocs
|
||||
tags: docs introduction dev
|
||||
|
||||
This is the developer documentation hub for TiddlyWiki.
|
||||
@ -1,17 +1,13 @@
|
||||
title: Docs
|
||||
tags: docs introduction
|
||||
|
||||
This is the main documentation hub for TiddlyWiki. See also:
|
||||
This is the main documentation hub for TiddlyWiki. See also the DeveloperDocs.
|
||||
|
||||
* [[Internals]] for developer documentation
|
||||
! Editions
|
||||
|
||||
! Guides
|
||||
TiddlyWiki5 can be used via these editions:
|
||||
|
||||
How to get things done with TiddlyWiki:
|
||||
|
||||
* [[Getting started with TiddlyWiki in the browser]]
|
||||
* [[Getting started with TiddlyWiki under node.js]]
|
||||
* [[Getting involved in TiddlyWiki development]]
|
||||
{{{ [tag[edition]sort[title]] }}}
|
||||
|
||||
! Concepts
|
||||
|
||||
@ -37,51 +33,17 @@ The machinery tying those concepts together includes:
|
||||
|
||||
These are the individual rules that make up WikiText:
|
||||
|
||||
* ClassBlockWikiText
|
||||
* CodeBlockWikiText
|
||||
* CodeRunWikiText
|
||||
* DashWikiText
|
||||
* EmphasisWikiText
|
||||
* EntityWikiText
|
||||
* ExternalLinkWikiText
|
||||
* HeadingWikiText
|
||||
* HtmlWikiText
|
||||
* ImageWikiText
|
||||
* ListWikiText
|
||||
* MacroWikiText
|
||||
* PrettyLinkWikiText
|
||||
* RuleWikiText
|
||||
* StyleBlockWikiText
|
||||
* TranscludeWikiText
|
||||
* TypedBlockWikiText
|
||||
* WikiLinkWikiText
|
||||
{{{ [tag[wikitextrule]sort[title]] }}}
|
||||
|
||||
! Macros
|
||||
! Widgets
|
||||
|
||||
Macros give WikiText dynamic functionality:
|
||||
Widgets give WikiText dynamic functionality:
|
||||
|
||||
* ButtonMacro
|
||||
* ColorMacro
|
||||
* CommentMacro
|
||||
* DownloadMacro
|
||||
* EchoMacro
|
||||
* EditMacro
|
||||
* HideMacro
|
||||
* ImageMacro
|
||||
* IncludeMacro
|
||||
* LinkMacro
|
||||
* LinkCatcherMacro
|
||||
* ListMacro
|
||||
* SliderMacro
|
||||
* StoryMacro
|
||||
* TiddlerMacro
|
||||
* TranscludeMacro
|
||||
* VideoMacro
|
||||
* ViewMacro
|
||||
{{{ [tag[widget]sort[title]] }}}
|
||||
|
||||
! Commands
|
||||
|
||||
When run under node.js, TiddlyWiki supports a [[command line interface|Getting started with TiddlyWiki under node.js]] with the following built-in commands:
|
||||
When run under node.js, TiddlyWiki supports a [[command line interface|TiddlyWiki5 Node Edition]] with the following built-in commands:
|
||||
|
||||
{{{ [tag[command]sort[title]] }}}
|
||||
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
title: EmbeddingTiddlyWiki
|
||||
tags: docs scenarios dev
|
||||
|
||||
TiddlyWiki can be embedded into a desktop or mobile application to enable it to perform operations that are not possible from a conventional browser.
|
||||
|
||||
For example, Mobile Safari on iOS runs TiddlyWiki well but doesn't provide any practical means to persistently save changes on the device. A wrapper application can embed TiddlyWiki using the ~UIWebView control.
|
||||
@ -8,9 +8,10 @@ Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the reusable non-linear personal
|
||||
|
||||
TiddlyWiki is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be structured with links, tags and macros. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
|
||||
|
||||
TiddlyWiki5 has many [[improvements|Improvements]] over the original. It is currently labelled alpha, meaning it is working but incomplete. It is the best possible time to get involved and support its future development. You can:
|
||||
TiddlyWiki5 has many [[improvements|Improvements]] over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its [[future development|RoadMap]]. You can:
|
||||
|
||||
* Explore its features online at http://five.tiddlywiki.com/
|
||||
* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]]
|
||||
* Join the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]]
|
||||
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news
|
||||
* Learn how to [[help the TiddlyWiki project and community|HelpingTiddlyWiki]]
|
||||
|
||||
@ -4,6 +4,19 @@ Here are some ideas how anyone can join in to help make TiddlyWiki better.
|
||||
|
||||
! 1. Tell The World
|
||||
|
||||
If you find TiddlyWiki useful, please tell the world. The best possible way to assure its future is for it to become a hundred times more popular than before.
|
||||
If you find TiddlyWiki useful, spread the word. The best possible way to assure its future is for it to become a hundred times more popular than before.
|
||||
|
||||
* [[Tweet about TiddlyWiki|https://twitter.com/intent/tweet?text=I+love+TiddlyWiki+because...&source=tiddlywiki5]]
|
||||
|
||||
! 2. Join the discussion
|
||||
|
||||
There's lively discussion about TiddlyWiki in the Google Groups:
|
||||
|
||||
* The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki
|
||||
* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev
|
||||
|
||||
! 3. Improve the Documentation and Code
|
||||
|
||||
The main TiddlyWiki documentation and code lives on GitHub, and so can be forked and pulled freely:
|
||||
|
||||
https://github.com/Jermolene/TiddlyWiki5
|
||||
|
||||
@ -2,7 +2,7 @@ title: Improvements
|
||||
modifier: JeremyRuston
|
||||
tags: docs introduction
|
||||
|
||||
TiddlyWiki5 is a complete rewrite of the original TiddlyWiki, incorporating many of the improvements that I've wanted to make over the years. It is now based on an elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules. The new code is much easier to work with, and will hopefully prove an even more fertile ground for the community of open source developers around TiddlyWiki.
|
||||
TiddlyWiki5 is a complete rewrite of the original TiddlyWiki. It is now based on an elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules. The new code is much easier to work with, and will hopefully prove an even more fertile ground for the community of open source developers around TiddlyWiki.
|
||||
|
||||
For end users, the important improvements include:
|
||||
|
||||
@ -10,6 +10,6 @@ For end users, the important improvements include:
|
||||
* Flexible TiddlerFilters that make it easier to work with several tiddlers in a single operation
|
||||
* TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server
|
||||
* Tiddlers containing images are now supported just like WikiText tiddlers, including integrated editing of bitmap and SVG images
|
||||
* TiddlyWiki5 can directly build both itself and previous (2.6.x) versions of TiddlyWiki from their constituent separate files, without needing external tools
|
||||
* TiddlyWiki5 can directly build both itself and previous (2.x.x) versions of TiddlyWiki from their constituent separate files, without needing external tools
|
||||
|
||||
The internal changes mean that TiddlyWiki5 is not compatible with previous versions, using different plugins, themes and so on. The changes to the WikiText have been carefully developed to try to maximise backwards compatibility but content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5.
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
title: Introduction
|
||||
tags: introduction
|
||||
|
||||
Here are a few features of TiddlyWiki that you can explore:
|
||||
|
||||
* Try editing some tiddlers here on five.tiddlywiki.com to try out the new WikiText. Your changes will not be visible to other users
|
||||
* Download an empty copy of TiddlyWiki5 from http://five.tiddlywiki.com/empty.html
|
||||
* Invoke a demonstration wizard: <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">demo</$button>
|
||||
* Use TiddlySpot to host an instance of TiddlyWiki5
|
||||
* Save this wiki as a static HTML file: <$button message="tw-save-wiki" param="$:/core/templates/static.template.html" class="btn">Save Static</$button>
|
||||
* Browse the list of AllTiddlers or the ShadowTiddlers
|
||||
* Examine the example [[bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]]
|
||||
* Check out the TaskManagementExample
|
||||
* Learn how to use TiddlyWiki5 to [[build older 2.x versions of TiddlyWiki|TiddlyWiki2ReadMe]]
|
||||
* Explore the RoadMap of TiddlyWiki5's ongoing development
|
||||
* Play with the new CecilyView
|
||||
@ -8,20 +8,20 @@ TiddlyWiki5 isn't yet built in to TiddlySpot but you can use it by following the
|
||||
# Sign up for a new wiki at http://tiddlyspot.com/, and remember the wiki name and password
|
||||
# Open TiddlyWiki5 in your browser from http://five.tiddlywiki.com/
|
||||
# Fill in the information listed below
|
||||
# Click the "Save Changes" button in the top navigation bar to trigger a save. You should get a confirmation message `0 - Fileindex.html`
|
||||
# Click the "Save Changes" button. You should get a confirmation message `0 - Fileindex.html`
|
||||
# Navigate to your TiddlySpot URL at http://{wikiname}.tiddlyspot.com/
|
||||
# You should see a copy of TiddlyWiki5. You can edit and create tiddlers, and click "Save Changes" to save changes back up to TiddlySpot (you'll need to re-enter your password below before it will work)
|
||||
# You should see a copy of TiddlyWiki5. You can edit and create tiddlers, and click "Save Changes" to save changes back up to TiddlySpot (you'll need to re-enter your password the first time you visit the wiki on TiddlySpot)
|
||||
|
||||
! TiddlySpot details
|
||||
|
||||
Wiki name: <<edit tiddler:[[$:/UploadName]] default:"" type:input>>
|
||||
Wiki name: <$edit tiddler="$:/UploadName" default="" type="input"/>
|
||||
|
||||
Password: <<password upload>>
|
||||
Password: <$password name="upload"/>
|
||||
|
||||
----
|
||||
|
||||
If you're using a server other than TiddlySpot, you can set the server URL here:
|
||||
|
||||
Service URL: <<edit tiddler:[[$:/UploadURL]] default:"" type:input>>
|
||||
Service URL: <$edit tiddler="$:/UploadURL" default="" type="input"/>
|
||||
|
||||
//(by default, the server URL is `http://<wikiname>.tiddlyspot.com/store.cgi`)//
|
||||
|
||||
11
editions/tw5.com/tiddlers/TiddlyWiki5_Editions.tid
Normal file
11
editions/tw5.com/tiddlers/TiddlyWiki5_Editions.tid
Normal file
@ -0,0 +1,11 @@
|
||||
title: TiddlyWiki5 Editions
|
||||
tags: introduction
|
||||
|
||||
The core TiddlyWiki5 code is packaged into several distinct editions designed for different situations:
|
||||
|
||||
* [[TiddlyWiki5 Standalone Edition]] for working purely within the browser
|
||||
** Including [[TiddlyWiki5 in the Sky for TiddlySpot|TiddlySpot]]
|
||||
* [[TiddlyWiki5 Node Edition]] for advanced command line work
|
||||
** Including [[Building classic TiddlyWiki with TiddlyWiki5]]
|
||||
* [[TiddlyWiki5 in the Sky for TiddlyWeb]] (and TiddlySpace)
|
||||
* [[TiddlyWiki5 in the Sky for Dropbox]]
|
||||
@ -4,7 +4,7 @@ tags: docs internals
|
||||
|
||||
! Overview
|
||||
|
||||
The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||
The heart of TiddlyWiki can be seen as an extensible representation transformation engine for text and images. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
|
||||
|
||||
The primary use of the engine is to convert raw `text/vnd.tiddlywiki` WikiText into a `text/html` or `text/plain` representation for display. The transclusion and templating features of WikiText allow the engine to also be used to generate TiddlyWiki HTML files from raw tiddlers.
|
||||
|
||||
@ -20,4 +20,4 @@ If the tiddler `HelloThere` is visible then you'll see it instantly change to re
|
||||
$tw.wiki.addTiddler({title: "IntentionallyMissingTiddler", text: "This tiddler now exists"});
|
||||
```
|
||||
|
||||
If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the [[Docs]] and read the code -- start with the boot kernel [[$:/core/boot.js]].
|
||||
If you're interested in understanding more about the internal operation of TiddlyWiki, it is recommended that you review the DeveloperDocs and read the code -- start with the boot kernel [[$:/core/boot.js]].
|
||||
|
||||
@ -7,4 +7,4 @@ For TiddlyWiki, [[node.js]] means that we can have a single code base that can r
|
||||
|
||||
For end users, [[node.js]] is no more complicated to install than a web browser, but unlocks powerful capabilities such as the ability to run TiddlyWiki as a web server that you can connect to from other devices.
|
||||
|
||||
See [[Getting started with TiddlyWiki under node.js]] for more details.
|
||||
See [[TiddlyWiki5 Node Edition]] for more details.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
title: Getting started with TiddlyWiki under node.js
|
||||
title: TiddlyWiki5 Node Edition
|
||||
modifier: JeremyRuston
|
||||
tags: guide
|
||||
tags: docs edition
|
||||
|
||||
TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:
|
||||
|
||||
@ -0,0 +1,11 @@
|
||||
title: TiddlyWiki5 Standalone Edition
|
||||
tags: docs edition
|
||||
|
||||
The standalone edition of TiddlyWiki5 is a single HTML file that contains both your content and the JavaScript code needed to provide a user interface for viewing and editting it. Your changes are preserved by generating an updated HTML file which can be saved in various ways, depending on your browser and configuration:
|
||||
|
||||
* Using the TiddlySpot upload service (or compatible)
|
||||
* Using the Firefox extension TiddlyFox changes can be saved directly to the file system, so that your TiddlyWiki documents are updated in place
|
||||
* Using the HTML `<a>` element letting the user manually save the modified file
|
||||
** Recent browsers supporting the `download` attribute can automatically force the download at the cost of losing control of the location of the downloaded file
|
||||
|
||||
You can start with an empty copy of TiddlyWiki5 from http://five.tiddlywiki.com/empty.html
|
||||
@ -1,5 +0,0 @@
|
||||
title: Working with the TiddlyWiki5 source code
|
||||
modifier: JeremyRuston
|
||||
tags: guide
|
||||
|
||||
The TiddlyWiki5 source code is maintained on GitHub at https://github.com/Jermolene/TiddlyWiki5
|
||||
@ -9,6 +9,6 @@ tags: introduction
|
||||
|
||||
! Getting started with TiddlyWiki under node.js
|
||||
|
||||
{{Getting started with TiddlyWiki under node.js}}
|
||||
{{TiddlyWiki5 Node Edition}}
|
||||
|
||||
//This readme file was automatically generated by TiddlyWiki5//
|
||||
5
editions/tw5.com/tiddlers/readme/TiddlyWiki2ReadMe.tid
Normal file
5
editions/tw5.com/tiddlers/readme/TiddlyWiki2ReadMe.tid
Normal file
@ -0,0 +1,5 @@
|
||||
title: TiddlyWiki2ReadMe
|
||||
|
||||
\define tw-wikilinks() no
|
||||
! Building classic TiddlyWiki with TiddlyWiki5
|
||||
{{Building classic TiddlyWiki with TiddlyWiki5}}
|
||||
@ -1,4 +1,5 @@
|
||||
title: StyleBlockWikiText
|
||||
tags: docs wikitextrule
|
||||
|
||||
This syntax enables you to assign arbitrary styles and classes to generated elements. For example:
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
title: $:/DefaultTiddlers
|
||||
|
||||
HelloThere
|
||||
Introduction
|
||||
[[TiddlyWiki5 Editions]]
|
||||
Demos
|
||||
Improvements
|
||||
WikiText
|
||||
Docs
|
||||
Docs
|
||||
|
||||
@ -14,7 +14,8 @@ tiddlers</span> – and give them titles so that they can be structured with
|
||||
TiddlyWiki</span> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p><p>
|
||||
<span>
|
||||
TiddlyWiki5</span> has many <span>
|
||||
improvements</span> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is the best possible time to get involved and support its future development. You can:</p><ul>
|
||||
improvements</span> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its <span>
|
||||
future development</span>. You can:</p><ul>
|
||||
<li>
|
||||
Explore its features online at <span>
|
||||
http://five.tiddlywiki.com/</span></li><li>
|
||||
@ -23,7 +24,9 @@ development on GitHub</span></li><li>
|
||||
Join the discussions on <span>
|
||||
the TiddlyWikiDev Google Group</span></li><li>
|
||||
Follow <span>
|
||||
@TiddlyWiki on Twitter</span> for the latest news</li></ul></div><h1 class=''>
|
||||
@TiddlyWiki on Twitter</span> for the latest news</li><li>
|
||||
Learn how to <span>
|
||||
help the TiddlyWiki project and community</span></li></ul></div><h1 class=''>
|
||||
Getting started with <span>
|
||||
TiddlyWiki</span> under node.js</h1><div class='tw-transclude'>
|
||||
<p>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user