Add a readme file for the tw2 edition

2bld.sh

@@ -6,7 +6,18 @@
 mkdir -p tmp
 mkdir -p tmp/tw2
 
-# cook TiddlyWiki5
+# Prepare the readme file from the revelant content in the tw5.com content
+
+pushd editions/tw5.com > /dev/null
+
+node ../../tiddlywiki.js \
+	--verbose \
+	--savetiddler TiddlyWiki2ReadMe ../tw2/readme.md text/html \
+	|| exit 1
+
+popd > /dev/null
+
+# cook the TiddlyWiki 2.x.x index file
 
 pushd editions/tw2 > /dev/null
 

editions/tw2/readme.md

@@ -0,0 +1 @@
+<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>

editions/tw5.com/tiddlers/guides/TiddlyWiki2ReadMe.tid

@@ -0,0 +1,10 @@
+title: TiddlyWiki2ReadMe
+
+! 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:
+
+* 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 `stripTitlePrefix='yes'` attribute of the `<$fields>` widget, which removes prefixes wrapped in curly braces from the `title` attribute
+