mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-13 13:29:56 +00:00

History

Jeremy Ruston 0cf5dc699e Refactor the filter mechanism Long overdue rewrite to make it simpler, and break the filter operators out into individual modules.		2013-05-25 17:26:22 +01:00
..
source	Move the editions into a subfolder	2012-11-16 21:20:27 +00:00
target	Move the editions into a subfolder	2012-11-16 21:20:27 +00:00
tiddlers/system	Refactor the filter mechanism	2013-05-25 17:26:22 +01:00
readme.md	Docs updates	2013-03-02 13:14:56 +00:00
tiddlywiki.info	Update TW2 edition	2013-02-09 17:10:18 +00:00

readme.md

Building classic TiddlyWiki with TiddlyWiki5

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, 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