diff --git a/readme.md b/readme.md index a18644787..c7cf66d55 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@
node tiddlywiki.js <options>
-
--recipe <filepath> | Loads a specfied .recipe file |
--load <filepath> | Load additional tiddlers from 2.x.x TiddlyWiki files (.html ), .tiddler , .tid , .json or other files |
--savewiki <dirpath> | Saves all the loaded tiddlers as a single file TiddlyWiki called index.html and an RSS feed called index.xml in a new directory of the specified name |
--savetiddler <title> <filename> [<type>] | Save an individual tiddler as a specified MIME type, defaults to text/html |
--savetiddlers <outdir> | Saves all the loaded tiddlers as .tid files in the specified directory |
--savehtml <outdir> | Saves all the loaded tiddlers as static, unstyled .html files in the specified directory |
--servewiki <port> | Serve the cooked TiddlyWiki over HTTP at / |
--servetiddlers <port> | Serve individual tiddlers over HTTP at /tiddlertitle |
--wikitest <dir> | Run wikification tests against the tiddlers in the given directory |
--dumpstore | Dump the TiddlyWiki store in JSON format |
--dumprecipe | Dump the current recipe in JSON format |
--verbose | verbose output, useful for debugging |
+
--recipe <filepath> | Loads a specfied .recipe file |
--load <filepath> | Load additional tiddlers from 2.x.x TiddlyWiki files (.html ), .tiddler , .tid , .json or other files |
--savewiki <dirpath> | Saves all the loaded tiddlers as a single file TiddlyWiki called index.html and an RSS feed called index.xml in a new directory of the specified name |
--savetiddler <title> <filename> [<type>] | Save an individual tiddler as a specified MIME type, defaults to text/html |
--savetiddlers <outdir> | Saves all the loaded tiddlers as .tid files in the specified directory |
--savehtml <outdir> | Saves all the loaded tiddlers as static, unstyled .html files in the specified directory |
--servewiki <port> | Serve the cooked TiddlyWiki over HTTP at / |
--servetiddlers <port> | Serve individual tiddlers over HTTP at /tiddlertitle |
--wikitest <dir> | Run wikification tests against the tiddlers in the given directory |
--dumpstore | Dump the TiddlyWiki store in JSON format |
--dumprecipe | Dump the current recipe in JSON format |
--verbose | verbose output, useful for debugging |
node tiddlywiki.js --load mywiki.html --servewiki 127.0.0.1:8000
node tiddlywiki.js --recipe tiddlywiki.com/index.recipe --savewiki tmp/
@@ -24,7 +24,7 @@ var renderer = parseTree.compile("text/html");
myNode.innerHTML = renderer.render(tiddler,store);
// And then, later:
renderer.rerender(node,changes,tiddler,store,renderStep);
-The parameters to rerender()
are:
Name Description node A reference to the DOM node containing the rendering to be rerendered changes A hashmap of {title: "created|modified|deleted"}
indicating which tiddlers have changed since the original rendering tiddler The tiddler providing the rendering context store The store to use for resolving references to other tiddlers renderStep See below
Currently, the only macro that supports rerendering is the <<story>>
macro; all other macros are rerendered by calling the ordinary render()
method again. The reason that the <<story>>
macro goes to the trouble of having a rerender()
method is so that it can be carefully selective about not disturbing tiddlers in the DOM that aren't affected by the change. If there were, for instance, a video playing in one of the open tiddlers it would be reset to the beginning if the tiddler were rerendered.
Planned WikiText Features
It is proposed to extend the existing TiddlyWiki WikiText syntax with the following extensions
- Addition of
**bold**
character formatting - Addition of
`backtick for code`
character formatting - Addition of WikiCreole-style forced line break, e.g.
force\\linebreak
- Addition of WikiCreole-style headings, e.g.
==Heading
- Addition of WikiCreole-style headings in tables, e.g.
|=|=table|=header|
- Addition of white-listed HTML tags intermixed with wikitext
- Addition of WikiCreole-style pretty links, e.g.
[[description -> link]]
- Addition of multiline macros, e.g.
<<myMacro
+
The parameters to rerender()
are:
Name Description node A reference to the DOM node containing the rendering to be rerendered changes A hashmap of {title: "created|modified|deleted"}
indicating which tiddlers have changed since the original rendering tiddler The tiddler providing the rendering context store The store to use for resolving references to other tiddlers renderStep See below
Currently, the only macro that supports rerendering is the <<story>>
macro; all other macros are rerendered by calling the ordinary render()
method again. The reason that the <<story>>
macro goes to the trouble of having a rerender()
method is so that it can be carefully selective about not disturbing tiddlers in the DOM that aren't affected by the change. If there were, for instance, a video playing in one of the open tiddlers it would be reset to the beginning if the tiddler were rerendered.
Planned WikiText Features
It is proposed to extend the existing TiddlyWiki WikiText syntax with the following extensions
- Addition of
**bold**
character formatting - Addition of
`backtick for code`
character formatting - Addition of WikiCreole-style forced line break, e.g.
force\\linebreak
- Addition of WikiCreole-style headings, e.g.
==Heading
- Addition of WikiCreole-style headings in tables, e.g.
|=|=table|=header|
- Addition of white-listed HTML tags intermixed with wikitext
- Addition of WikiCreole-style pretty links, e.g.
[[description -> link]]
- Addition of multiline macros, e.g.
<<myMacro
param1: Parameter value
param2: value
"unnamed parameter"