mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-24 00:50:28 +00:00
Updated docs
This commit is contained in:
parent
693cb67c6b
commit
f40c096443
@ -10,7 +10,7 @@ node tiddlywiki.js <options>
|
||||
The command line options are processed sequentially from left to right. Processing pauses during long operations, like loading a [[recipe file|RecipeFiles]] and all the subrecipes and [[tiddlers|TiddlerFiles]] that it references. The following options are available:
|
||||
|{{{--recipe <filepath>}}} |Loads a specfied `.recipe` file |
|
||||
|{{{--load <filepath>}}} |Load additional tiddlers from 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}}} |
|
||||
|{{{--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 |
|
||||
|{{{--servewiki <port>}}} |Serve the cooked TiddlyWiki over HTTP at {{{/}}} |
|
||||
|
@ -131,17 +131,3 @@ The compilation process has several steps:
|
||||
* First, the parse tree is used to generate a JavaScript tree
|
||||
* The JavaScript tree is scanned to determine the tiddlers on which this one depends
|
||||
* Finally, executable JavaScript text is generated by walking the JavaScript tree
|
||||
|
||||
!! Macros
|
||||
|
||||
Macros should be examples of javascript tiddlers that are invoked with parameters. The familiar ones all generate text/html output. For example:
|
||||
|
||||
function tiddler_macro(args) {
|
||||
return getTiddlerText(args.tiddler,"text/html");
|
||||
}
|
||||
|
||||
These tiddlers should also have extractable and translateable docs, and perhaps some metadata about how the parameters should be parsed.
|
||||
|
||||
Maybe we can use the compiler to convert this form into the former? Yes, of course, we just lift and shift the parse tree from the macro definition into the point where it is used. Yay. So when we're walking the tree, we don't walk into the macro nodes children so much as into the definition tree.
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user