mirrors
/
TiddlyWiki5
mirror of https://github.com/Jermolene/TiddlyWiki5
1
0
Fork 0
Code Issues Releases Wiki Activity

Docs update

This commit is contained in:
Jeremy Ruston 2013-01-26 23:38:59 +00:00
parent 07e8348b8e
commit ea715bd3f2
4 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/Docs.tid
View File

@ -83,12 +83,7 @@ Macros give WikiText dynamic functionality:
When run under node.js, TiddlyWiki supports a [[command line interface|Getting started with TiddlyWiki under node.js]] with the following built-in commands:
* DumpCommand
* LoadCommand
* SaveTiddlerCommand
* ServerCommand
* VerboseCommand
* VersionCommand
{{{ [tag[command]sort[title]] }}}
! Miscellaneous

6
editions/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid
View File

@ -5,14 +5,14 @@ tags: guide
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:
{{{
node core/boot.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html
node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html
}}}
!!Usage
Running `boot.js` from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces. The commands are identified by the prefix `--`.
Running `tiddlywiki.js` from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces. The commands are identified by the prefix `--`.
{{{
node core/boot.js [--<option> [<arg>[,<arg>]]]
node tiddlywiki.js [--<option> [<arg>[,<arg>]]]
}}}
!! Batch Files

2
editions/tw5.com/tiddlers/mechanisms/PluginMechanism.tid
View File

@ -36,7 +36,7 @@ The titles of the individual tiddlers within a plugin are automatically prefixed
On the server, plugins can be stored as ordinary JSON tiddlers but it is often more convenient to store them as separate tiddler files within folders. Plugin folders must contain a `plugin.tiddlywiki` file that contains the metadata for the plugin. It can also optionally identify files external to the plugin folder that should be loaded as tiddlers.
The `plugin.tiddlywiki` file should contain the following JSON structure:
The `plugin.bundle` file should contain the following JSON structure:
{{{
{

2
editions/tw5.com/tiddlers/roadmap/RoadMap.tid
View File

@ -41,4 +41,4 @@ Some of the additional features under consideration during the beta include:
! 1.0 Release
Hopefully, TiddlyWiki5 will reach version 1.0 around --September-- ... the end of 2012. This is the point at which it is declared stable enough for general use. It will continue to improve and evolve after 1.0, although constrained to remain backwards compatible so that plugins and content created for version 1.0 will continue to work into the indefinite future.
Hopefully, TiddlyWiki5 will reach version 1.0 while we're still early in 2013. This is the point at which it is declared stable enough for general use. It will continue to improve and evolve after 1.0, although constrained to remain backwards compatible so that plugins and content created for version 1.0 will continue to work into the indefinite future.