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

Docs updates

This commit is contained in:
Jeremy Ruston 2013-01-22 09:30:24 +00:00
parent e885cfc3c9
commit 8bc522d48d
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
editions/tw2/readme.md
View File

@ -1 +1,5 @@
<h1 class=''>Using <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> to build <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWikiClassic'>TiddlyWikiClassic</a></h1><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> can be used to build older 2.x.x versions of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> from their constituent components. Doing so involves these additional features over and above those used for building <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a>:</p><ul><li>The <code>tiddlywiki2/loadrecipe</code> plugin, which allows tiddlers to be loaded from <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> 2.x.x <code>.recipe</code> files</li><li>The <code>tiddlywiki2/stripcomments</code> plugin, which adds a new viewer format for the <code>&lt;$view&gt;</code> macro that strips single line <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> comments starting <code>//#</code></li><li>The <code>stripTitlePrefix='yes'</code> attribute of the <code>&lt;$fields&gt;</code> widget, which removes prefixes wrapped in curly braces from the <code>title</code> attribute</li></ul>
<h1 class=''>Using <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> to build <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWikiClassic'>TiddlyWikiClassic</a></h1><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> can be used to build older 2.x.x versions of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> from their constituent components. Doing so involves these additional features over and above those used for building <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a>:</p><ul><li>The <code>tiddlywiki2/loadrecipe</code> plugin, containing a deserializer module which allows tiddlers to be loaded from <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> 2.x.x <code>.recipe</code> files</li><li>The <code>tiddlywiki2/stripcomments</code> plugin, containing a new viewer format for the <code>&lt;$view&gt;</code> widget that strips single line <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> comments starting <code>//#</code></li><li>The <code>stripTitlePrefix='yes'</code> attribute of the <code>&lt;$fields&gt;</code> widget, which removes prefixes wrapped in curly braces from the <code>title</code> attribute<ul><li>For example, <code>{tiddler}HelloThere</code> would be transformed to <code>HelloThere</code></li></ul></li></ul><h1 class=''>Usage</h1><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWikiClassic'>TiddlyWikiClassic</a> is built from the command line by running <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> under node.js. A typical usage would be:</p><pre>node ../../tiddlywiki.js \
--verbose \
--load &lt;path_to_recipe_file&gt; \
--savetiddler $:/core/templates/tiddlywiki2.template.html &lt;path_to_write_index_file&gt; text/plain \
|| exit 1</pre>

17
editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid
View File

@ -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 <path_to_recipe_file> \
--savetiddler $:/core/templates/tiddlywiki2.template.html <path_to_write_index_file> text/plain \
|| exit 1
```