mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-06-25 23:03:15 +00:00
Docs updates
This commit is contained in:
Jeremy Ruston
parent
56913bf061
commit
c23014dca4
|
|
@ -1,4 +1,4 @@
|
|||
<h1>Welcome to <a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a></h1>Welcome to <a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a>, a reboot of <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a>, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file or as a powerful <a href='What%20is%20node.js%3F' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>node.js application</a>.<br><br>Some useful tiddlers for feature testing:<br><ul><li> <a href='ClockTiddler' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>ClockTiddler</a> showing automatic refreshing of tiddlers</li><li> <a href='ImageTests' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>ImageTests</a> showing different ways of embedding images</li><li> <a href='SampleData' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>SampleData</a> showing how JSON tiddlers are handled</li><li> <a href='VideoTests' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>VideoTests</a> showing how different online video formats can be embedded</li></ul><br>Technical documentation includes:<br><ul><li> <a href='Testing' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>Testing</a> regimen</li><li> Details of the <a href='CommandLineInterface' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>CommandLineInterface</a></li><li> Overview of <a href='TiddlyWikiArchitecture' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWikiArchitecture</a></li><ul><li> <a href='MacroInternals' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>MacroInternals</a></li></ul><li> Information about <a href='TiddlerFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlerFiles</a> and <a href='RecipeFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>RecipeFiles</a></li><li> <a href='NewWikiTextFeatures' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>NewWikiTextFeatures</a></li></ul><br><a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a> is currently in early beta, which is to say that it is useful but incomplete. You can get involved in the development on <a href='GitHub' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>GitHub</a> and the discussions on Google Groups:<br><br><a href='https://github.com/Jermolene/TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-external'>https://github.com/Jermolene/TiddlyWiki5</a><br><a href='http://groups.google.com/group/TiddlyWikiDev' class='tw-tiddlylink tw-tiddlylink-external'>http://groups.google.com/group/TiddlyWikiDev</a><br><br><blockquote>Bug: this link doesn't work:<br><a href='HelloThere' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>HelloThere</a><br></blockquote><br><h1>Usage</h1><a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <a href='RecipeFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>RecipeFiles</a>, <a href='TiddlerFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlerFiles</a> and <a href='TiddlyWikiFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWikiFiles</a>.<br><br>Usage:<br><code>
|
||||
<h1>Welcome to <a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a></h1>Welcome to <a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a>, a reboot of <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a>, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file or as a powerful <a href='What%20is%20node.js%3F' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>node.js application</a>.<br><br><a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a> is currently in early beta, which is to say that it is useful but incomplete. You can get involved in the <a href='https://github.com/Jermolene/TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-external'>development on GitHub</a> and the discussions on <a href='http://groups.google.com/group/TiddlyWikiDev' class='tw-tiddlylink tw-tiddlylink-external'>the TiddlyWikiDev Google Group</a>.<br><br><h1>Usage</h1><a href='TiddlyWiki5' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <a href='RecipeFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>RecipeFiles</a>, <a href='TiddlerFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlerFiles</a> and <a href='TiddlyWikiFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing'>TiddlyWikiFiles</a>.<br><br>Usage:<br><code>
|
||||
node tiddlywiki.js <options>
|
||||
</code><br>The command line options are processed sequentially from left to right. Processing pauses during long operations, like loading a <a href='RecipeFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>recipe file</a> and all the subrecipes and <a href='TiddlerFiles' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>tiddlers</a> that it references, and then resumes with the next command line option in sequence. The following options are available:<br><table class='twtable'><tbody><tr class='evenRow'><td align='left'><code>--recipe <filepath></code></td><td align='left'>Loads a specfied <code>.recipe</code> file</td></tr><tr class='oddRow'><td align='left'><code>--load <filepath></code></td><td align='left'>Load additional tiddlers from 2.x.x <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a> files (<code>.html</code>), <code>.tiddler</code>, <code>.tid</code>, <code>.json</code> or other files</td></tr><tr class='evenRow'><td align='left'><code>--savewiki <dirpath></code></td><td align='left'>Saves all the loaded tiddlers as a single file <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a> called <code>index.html</code> and an RSS feed called <code>index.xml</code> in a new directory of the specified name</td></tr><tr class='oddRow'><td align='left'><code>--savetiddler <title> <filename> [<type>]</code></td><td align='left'>Save an individual tiddler as a specified MIME type, defaults to <code>text/html</code></td></tr><tr class='evenRow'><td align='left'><code>--savetiddlers <outdir></code></td><td align='left'>Saves all the loaded tiddlers as <code>.tid</code> files in the specified directory</td></tr><tr class='oddRow'><td align='left'><code>--servewiki <port></code></td><td align='left'>Serve the cooked <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a> over HTTP at <code>/</code></td></tr><tr class='evenRow'><td align='left'><code>--servetiddlers <port></code></td><td align='left'>Serve individual tiddlers over HTTP at <code>/tiddlertitle</code></td></tr><tr class='oddRow'><td align='left'><code>--wikitest <dir></code></td><td align='left'>Run wikification tests against the tiddlers in the given directory</td></tr><tr class='evenRow'><td align='left'><code>--dumpstore</code></td><td align='left'>Dump the <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a> store in JSON format</td></tr><tr class='oddRow'><td align='left'><code>--dumprecipe</code></td><td align='left'>Dump the current recipe in JSON format</td></tr><tr class='evenRow'><td align='left'><code>--verbose</code></td><td align='left'>verbose output, useful for debugging</td></tr></tbody></table><h2> Examples</h2>This example loads the tiddlers from a <a href='TiddlyWiki' class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves'>TiddlyWiki</a> HTML file and makes them available over HTTP:<br><code>
|
||||
node tiddlywiki.js --load mywiki.html --servewiki 127.0.0.1:8000
|
||||
|
|
|
|||
|
|
@ -3,26 +3,4 @@ modifier: JeremyRuston
|
|||
|
||||
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file or as a powerful [[node.js application|What is node.js?]].
|
||||
|
||||
Some useful tiddlers for feature testing:
|
||||
* ClockTiddler showing automatic refreshing of tiddlers
|
||||
* ImageTests showing different ways of embedding images
|
||||
* SampleData showing how JSON tiddlers are handled
|
||||
* VideoTests showing how different online video formats can be embedded
|
||||
|
||||
Technical documentation includes:
|
||||
* [[Testing]] regimen
|
||||
* Details of the CommandLineInterface
|
||||
* Overview of TiddlyWikiArchitecture
|
||||
** MacroInternals
|
||||
* Information about TiddlerFiles and RecipeFiles
|
||||
* NewWikiTextFeatures
|
||||
|
||||
TiddlyWiki5 is currently in early beta, which is to say that it is useful but incomplete. You can get involved in the development on GitHub and the discussions on Google Groups:
|
||||
|
||||
https://github.com/Jermolene/TiddlyWiki5
|
||||
http://groups.google.com/group/TiddlyWikiDev
|
||||
|
||||
<<<
|
||||
Bug: this link doesn't work:
|
||||
<<view title link>>
|
||||
<<<
|
||||
TiddlyWiki5 is currently in early beta, which is to say that it is useful but incomplete. You can get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] and the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]].
|
||||
|
|
|
|||
|
|
@ -1,9 +1,22 @@
|
|||
title: Introduction
|
||||
|
||||
<<slider name "Motovun Jack.jpg" "TiddlyWiki Kitten" "See the kitten">>
|
||||
|
||||
TiddlyWiki5 gains new capabilities through a [[completely rebuilt architecture|TiddlyWikiArchitecture]] using the latest features of HTML5 and node.js. It runs natively under node.js, and can also use its own components to construct a version of itself that works entirely within the browser, just as TiddlyWiki has always done.
|
||||
|
||||
TiddlyWiki5 also functions as the build system for earlier versions of TiddlyWiki, replacing the elderly Cook and Ginsu tools (see https://github.com/TiddlyWiki/cooker for details). See the CommandLineInterface for details.
|
||||
|
||||
Some useful tiddlers for feature testing:
|
||||
* ClockTiddler showing automatic refreshing of tiddlers
|
||||
* ImageTests showing different ways of embedding images
|
||||
* SampleData showing how JSON tiddlers are handled
|
||||
* VideoTests showing how different online video formats can be embedded
|
||||
|
||||
Technical documentation includes:
|
||||
* [[Testing]] regimen
|
||||
* Details of the CommandLineInterface
|
||||
* Overview of TiddlyWikiArchitecture
|
||||
** MacroInternals
|
||||
* Information about TiddlerFiles and RecipeFiles
|
||||
* NewWikiTextFeatures
|
||||
|
||||
All tiddlers:
|
||||
<<list all>>
|
||||
4
tiddlywiki5/tiddlers/JackSlider.tid
Normal file
4
tiddlywiki5/tiddlers/JackSlider.tid
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
title: JackSlider
|
||||
modifier: JackBeNimble
|
||||
|
||||
closed
|
||||
5
tiddlywiki5/tiddlers/SliderTests.tid
Normal file
5
tiddlywiki5/tiddlers/SliderTests.tid
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
title: SliderTests
|
||||
|
||||
The status of this slider is stored in the tiddler JackSlider:
|
||||
<<slider JackSlider "Motovun Jack.jpg" "TiddlyWiki Kitten" "See the kitten">>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user