From 8bc522d48dccc54e00d1851228c4167497cfd0fa Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Tue, 22 Jan 2013 09:30:24 +0000 Subject: [PATCH] Docs updates --- editions/tw2/readme.md | 6 +++++- .../tiddlers/guides/TiddlyWiki2ReadMe.tid | 17 +++++++++++++++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/editions/tw2/readme.md b/editions/tw2/readme.md index 5ab008ea3..0191aba92 100644 --- a/editions/tw2/readme.md +++ b/editions/tw2/readme.md @@ -1 +1,5 @@ -

Using TiddlyWiki5 to build TiddlyWikiClassic

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:

\ No newline at end of file +

Using TiddlyWiki5 to build TiddlyWikiClassic

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:

Usage

TiddlyWikiClassic is built from the command line by running TiddlyWiki5 under node.js. A typical usage would be:

node ../../tiddlywiki.js \
+	--verbose \
+	--load <path_to_recipe_file> \
+	--savetiddler $:/core/templates/tiddlywiki2.template.html <path_to_write_index_file> text/plain \
+	|| exit 1
\ No newline at end of file diff --git a/editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid b/editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid index aef8aeeda..464ad5868 100644 --- a/editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid +++ b/editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid @@ -4,7 +4,20 @@ title: TiddlyWiki2ReadMe 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: -* The `tiddlywiki2/loadrecipe` plugin, which allows tiddlers to be loaded from TiddlyWiki 2.x.x `.recipe` files -* The `tiddlywiki2/stripcomments` plugin, which adds a new viewer format for the `<$view>` macro that strips single line JavaScript comments starting `//#` +* The `tiddlywiki2/loadrecipe` plugin, containing a deserializer module which allows tiddlers to be loaded from TiddlyWiki 2.x.x `.recipe` files +* The `tiddlywiki2/stripcomments` plugin, containing a new viewer format for the `<$view>` widget that strips single line JavaScript comments starting `//#` * The `stripTitlePrefix='yes'` attribute of the `<$fields>` widget, which removes prefixes wrapped in curly braces from the `title` attribute +** For example, `{tiddler}HelloThere` would be transformed to `HelloThere` + +! Usage + +TiddlyWikiClassic is built from the command line by running TiddlyWiki5 under node.js. A typical usage would be: + +``` +node ../../tiddlywiki.js \ + --verbose \ + --load \ + --savetiddler $:/core/templates/tiddlywiki2.template.html text/plain \ + || exit 1 +```