mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-24 17:10:29 +00:00
Docs update
This commit is contained in:
parent
4e37fa7e47
commit
15a41d7e57
@ -1,34 +1,4 @@
|
||||
<h1 class=''>
|
||||
Building classic <span>
|
||||
TiddlyWiki</span> with <span>
|
||||
TiddlyWiki5</span></h1><p>
|
||||
<span>
|
||||
TiddlyWiki5</span> can be used to build older 2.x.x versions of <span>
|
||||
TiddlyWiki</span> from their constituent components. Doing so involves these additional features over and above those used for building <span>
|
||||
TiddlyWiki5</span>:</p><ul>
|
||||
<li>
|
||||
The <code>
|
||||
tiddlywiki2/loadrecipe</code> plugin, containing a deserializer module which allows tiddlers to be loaded from <span>
|
||||
TiddlyWiki</span> 2.x.x <code>
|
||||
.recipe</code> files</li><li>
|
||||
The <code>
|
||||
tiddlywiki2/stripcomments</code> plugin, containing a new viewer format for the <code>
|
||||
<$view></code> widget that strips single line <span>
|
||||
JavaScript</span> comments starting <code>
|
||||
//#</code></li><li>
|
||||
The <code>
|
||||
stripTitlePrefix='yes'</code> attribute of the <code>
|
||||
<$fields></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>
|
||||
<span>
|
||||
TiddlyWikiClassic</span> is built from the command line by running <span>
|
||||
TiddlyWiki5</span> under node.js. A typical usage would be:</p><pre>
|
||||
node ../../tiddlywiki.js \
|
||||
<h1 class=''>Building <span>TiddlyWikiClassic</span></h1><p><span>TiddlyWiki5</span> can be used to build older 2.x.x versions of <span>TiddlyWikiClassic</span> from their constituent components. Doing so involves these features:</p><ul><li>The <code>tiddlywiki/classictools</code> plugin, containing a deserializer module which allows tiddlers to be loaded from <span>TiddlyWiki</span> 2.x.x <code>.recipe</code> files</li><li>The <code>stripcomments</code> format for the <span>ViewWidget</span>, which strips single line <span>JavaScript</span> comments starting <code>//#</code></li><li>The <code>stripTitlePrefix='yes'</code> attribute of the <span>FieldsWidget</span>, 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><span>TiddlyWikiClassic</span> is built from the command line by running <span>TiddlyWiki on Node.js</span>. A typical usage would be:</p><pre>node ../../tiddlywiki.js \
|
||||
--verbose \
|
||||
--load <path_to_recipe_file> \
|
||||
--rendertiddler $:/core/templates/tiddlywiki2.template.html <path_to_write_index_file> text/plain \
|
||||
|
@ -1,7 +1,7 @@
|
||||
created: 20131216100000000
|
||||
modified: 20131221205551616
|
||||
tags: releasenote
|
||||
title: Release 5.0.4-prerelease
|
||||
title: Release 5.0.4-beta
|
||||
type: text/vnd.tiddlywiki
|
||||
released: 201312221544
|
||||
|
||||
|
@ -1,15 +1,19 @@
|
||||
created: 20131129094758194
|
||||
modified: 20131129094808390
|
||||
modified: 20131222161808390
|
||||
title: ReadMe
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
\define tw-wikilink-template() http://tiddlywiki.com/static/$uri_encoded$.html
|
||||
! Welcome to TiddlyWiki5
|
||||
! Welcome to TiddlyWiki
|
||||
|
||||
{{HelloThere}}
|
||||
|
||||
! Getting started with TiddlyWiki under Node.js
|
||||
|
||||
{{TiddlyWiki5 on Node.js}}
|
||||
{{TiddlyWiki on Node.js}}
|
||||
|
||||
//This readme file was automatically generated by TiddlyWiki5//
|
||||
! Working with the TiddlyWiki5 repository
|
||||
|
||||
{{Working with the TiddlyWiki5 repository}}
|
||||
|
||||
//This readme file was automatically generated by TiddlyWiki//
|
||||
|
@ -1,5 +1,5 @@
|
||||
title: TiddlyWiki2ReadMe
|
||||
|
||||
\define tw-wikilinks() no
|
||||
! Building classic TiddlyWiki with TiddlyWiki5
|
||||
{{Building classic TiddlyWiki with TiddlyWiki5}}
|
||||
! Building TiddlyWikiClassic
|
||||
{{Building TiddlyWikiClassic}}
|
||||
|
Loading…
Reference in New Issue
Block a user