Move developer docs into their own separate wiki

Will be served at http://five.tiddlywiki.com/dev/
This commit is contained in:
Jermolene committed 2013-11-27 10:27:57 +00:00
1 parent 3a9dc1a36d
commit f534d98e8b
33 files changed
+96 -103

No files matched your search

+22 -10
View File
@@ -16,18 +16,19 @@ if not exist %TW5_BUILD_OUTPUT%\nul (
echo Using TW5_BUILD_OUTPUT as %TW5_BUILD_OUTPUT%
echo.
rem Create the `static` directory if necessary
rem Create the `static` and `dev` directories if necessary
setlocal enableextensions
mkdir %TW5_BUILD_OUTPUT%\static
mkdir %TW5_BUILD_OUTPUT%\dev
mkdir %TW5_BUILD_OUTPUT%\dev\static
setlocal disableextensions
rem Delete any existing content
del /q /s %TW5_BUILD_OUTPUT%\static
rem First,
rem readme.md: the readme file for GitHub
rem First, the tw5.com wiki
rem index.html: the main file, including content
rem empty.html: the main file, excluding content
rem static.html: the static version of the default tiddlers
@@ -35,8 +36,6 @@ rem static.html: the static version of the default tiddlers
node .\tiddlywiki.js ^
.\editions\tw5.com ^
--verbose ^
--rendertiddler ReadMe .\readme.md text/html ^
--rendertiddler ContributingTemplate .\contributing.md text/html ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\index.html text/plain ^
--rendertiddler $:/editions/tw5.com/save-empty %TW5_BUILD_OUTPUT%\empty.html text/plain ^
--rendertiddler $:/core/templates/static.template.html %TW5_BUILD_OUTPUT%\static.html text/plain ^
@@ -53,7 +52,20 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\encrypted.html text/plain ^
|| exit 1
rem Third, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
rem Third, dev.html: developer info wiki
node .\tiddlywiki.js ^
.\editions\dev ^
--verbose ^
--rendertiddler ReadMe .\readme.md text/html ^
--rendertiddler ContributingTemplate .\contributing.md text/html ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\dev\index.html text/plain ^
--rendertiddler $:/core/templates/static.template.html %TW5_BUILD_OUTPUT%\dev\static.html text/plain ^
--rendertiddler $:/core/templates/static.template.css %TW5_BUILD_OUTPUT%\dev\static\static.css text/plain ^
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html %TW5_BUILD_OUTPUT%\dev\static text/plain ^
|| exit 1
rem Fourth, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
node .\tiddlywiki.js ^
.\editions\tahoelafs ^
@@ -61,7 +73,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\tahoelafs.html text/plain ^
|| exit 1
rem Fourth, d3demo.html: wiki to demo d3 plugin
rem Fifth, d3demo.html: wiki to demo d3 plugin
node .\tiddlywiki.js ^
.\editions\d3demo ^
@@ -69,7 +81,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\d3demo.html text/plain ^
|| exit 1
rem Fifth, codemirrordemo.html: wiki to demo codemirror plugin
rem Sixth, codemirrordemo.html: wiki to demo codemirror plugin
node .\tiddlywiki.js ^
.\editions\codemirrordemo ^
@@ -77,7 +89,7 @@ node .\tiddlywiki.js ^
--rendertiddler $:/core/save/all %TW5_BUILD_OUTPUT%\codemirrordemo.html text/plain ^
|| exit 1
rem Sixth, codemirrordemo.html: wiki to demo codemirror plugin
rem Seventh, codemirrordemo.html: wiki to demo codemirror plugin
node .\tiddlywiki.js ^
.\editions\markdowndemo ^
@@ -90,6 +102,6 @@ rem Make the CNAME file that GitHub Pages requires
echo five.tiddlywiki.com > %TW5_BUILD_OUTPUT%\CNAME
rem Seventh, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
rem Eighth, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
.\test.cmd
+22 -10
View File
@@ -19,16 +19,17 @@ echo "Using TW5_BUILD_OUTPUT as [$TW5_BUILD_OUTPUT]"
echo "five.tiddlywiki.com" > $TW5_BUILD_OUTPUT/CNAME
# Create the `static` directory if necessary
# Create the `static` and `dev` directories if necessary
mkdir -p $TW5_BUILD_OUTPUT/static
mkdir -p $TW5_BUILD_OUTPUT/dev
mkdir -p $TW5_BUILD_OUTPUT/dev/static
# Delete any existing content
rm $TW5_BUILD_OUTPUT/static/*
# First,
# readme.md: the readme file for GitHub
# First, the tw5.com wiki
# index.html: the main file, including content
# empty.html: the main file, excluding content
# static.html: the static version of the default tiddlers
@@ -36,8 +37,6 @@ rm $TW5_BUILD_OUTPUT/static/*
node ./tiddlywiki.js \
./editions/tw5.com \
--verbose \
--rendertiddler ReadMe ./readme.md text/html \
--rendertiddler ContributingTemplate ./contributing.md text/html \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/index.html text/plain \
--rendertiddler $:/editions/tw5.com/save-empty $TW5_BUILD_OUTPUT/empty.html text/plain \
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
@@ -54,7 +53,20 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/encrypted.html text/plain \
|| exit 1
# Third, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
# Third, dev.html: developer info wiki
node ./tiddlywiki.js \
./editions/dev \
--verbose \
--rendertiddler ReadMe ./readme.md text/html \
--rendertiddler ContributingTemplate ./contributing.md text/html \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/dev/index.html text/plain \
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/dev/static.html text/plain \
--rendertiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/dev/static/static.css text/plain \
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/dev/static text/plain \
|| exit 1
# Fourth, tahoelafs.html: empty wiki with plugin for Tahoe-LAFS
node ./tiddlywiki.js \
./editions/tahoelafs \
@@ -62,7 +74,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/tahoelafs.html text/plain \
|| exit 1
# Fourth, d3demo.html: wiki to demo d3 plugin
# Fifth, d3demo.html: wiki to demo d3 plugin
node ./tiddlywiki.js \
./editions/d3demo \
@@ -70,7 +82,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/d3demo.html text/plain \
|| exit 1
# Fifth, codemirrordemo.html: wiki to demo codemirror plugin
# Sixth, codemirrordemo.html: wiki to demo codemirror plugin
node ./tiddlywiki.js \
./editions/codemirrordemo \
@@ -78,7 +90,7 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/codemirrordemo.html text/plain \
|| exit 1
# Sixth, codemirrordemo.html: wiki to demo codemirror plugin
# Seventh, codemirrordemo.html: wiki to demo codemirror plugin
node ./tiddlywiki.js \
./editions/markdowndemo \
@@ -86,6 +98,6 @@ node ./tiddlywiki.js \
--rendertiddler $:/core/save/all $TW5_BUILD_OUTPUT/markdowndemo.html text/plain \
|| exit 1
# Seventh, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
# Eighth, run the test edition to run the Node.js tests and to generate test.html for tests in the browser
./test.sh
+24
View File
@@ -0,0 +1,24 @@
created: 20130822170200000
creator: JeremyRuston
modified: 20131126220042886
modifier: JeremyRuston
tags: introduction
title: HelloThere
type: text/vnd.tiddlywiki
This is the developer documentation hub for TiddlyWiki. For convenience, it also contains all of the end user documentation that appears at http://five.tiddlywiki.com/.
! Overview
* TiddlyWikiArchitecture
* [[TiddlyWiki5 Development Environment]]
* [[Building classic TiddlyWiki with TiddlyWiki5]]
! Developer Cookbooks
<$list filter="[tag[dev]tag[howto]sort[title]]"/>
! Internal Objects and Mechanisms
<$list filter="[tag[mechanism]sort[title]]"/>
File renamed without changes.
@@ -0,0 +1,6 @@
title: $:/DefaultTiddlers
HelloThere
Resources
ReleaseHistory
RoadMap
@@ -0,0 +1,4 @@
title: SiteSubtitle
modifier: JeremyRuston
developer information for ~TiddlyWiki5
@@ -0,0 +1,4 @@
title: SiteTitle
modifier: JeremyRuston
five.tiddlywiki.com/dev
+13
View File
@@ -0,0 +1,13 @@
{
"plugins": [
"tiddlywiki/fullscreen",
"tiddlywiki/googleanalytics",
"tiddlywiki/github-fork-ribbon"
],
"themes": [
"tiddlywiki/snowwhite"
],
"includeWikis": [
"../tw5.com"
]
}
@@ -1,32 +0,0 @@
created: 201308251537
creator: JeremyRuston
modified: 201308260831
modifier: JeremyRuston
tags: introduction dev
title: DeveloperDocs
This is the developer documentation hub for TiddlyWiki.
! Overview
* TiddlyWikiArchitecture
* [[TiddlyWiki5 Development Environment]]
! Developer Cookbooks
<$list filter="[tag[dev]tag[howto]sort[title]]" type="ul"/>
! Internal Objects and Mechanisms
<$list filter="[tag[mechanism]sort[title]]" type="ul"/>
! Module types
!! SyncAdaptorModules
See SyncAdaptorModules.
!! DeserializerModules
Deserializers are modules that load tiddlers from different text formats:
<$list filter="[tag[deserializers]sort[title]]" type="ul"/>
@@ -1,48 +0,0 @@
created: 201308252217
creator: JeremyRuston
modified: 201308270750
modifier: JeremyRuston
tags: dev
title: Plan for moving from Alpha to Beta
! Goals for moving to Beta
To move from alpha to beta, TiddlyWiki5 needs a better release and deployment process. At a minimum:
* Each release should be automatically assigned a unique revision number, with a simple manual process to bump the major or minor version number
* Each release should be available as a zip download on GitHub and tiddlywiki.com
* Releases should be automatically pushed to NPM
* A release note for end users should be automatically generated from the commits
** The process should allow for manual editing of the release note
* A clear distinction between a new release of the TW5 core plugins and revised content for the tw5.com website
It would also be nice to have:
* Automatic tweets from @TiddlyWiki announcing each release
! Tasks for moving to Beta
!! Update https://github.com/Jermolene/tiddlywiki.com
This is the repository for the content and build tools for tiddlywiki.com, forked from https://github.com/TiddlyWiki/tiddlywiki.com. It needs updating to include both TW5 and TW classic, with a unified build and deployment process for the website. The content from `TiddlyWiki5/editions/tw5.com` would be moved here.
The pull request will be merged when we switch into beta. Until then, we'll build to http://jermolene.github.com, meaning that http://five.tiddlywiki.com will be a replica of tiddlywiki.com post-beta switchover.
The basic build process for tw5.com is:
Preparation
* Update the content and commit as needed
* Pull down the correct version of TW5 for the build
* Pull down the content repos
* Fork tiddlywiki.github.com and pull it down
Build cycle
* Run the build scripts
* Review pull request for tiddlywiki.github.com
Deployment
* Merge pull request on github.com
+1 -3
View File
@@ -1,6 +1,4 @@
<h1 class=''>Welcome to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a></h1><p>Welcome to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a>, a reboot of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a>, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/JavaScript.html'>JavaScript</a> that can be run from a <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/How%20to%20use%20TiddlyWiki5%20as%20a%20standalone%20HTML%20file.html'>single HTML file in the browser</a> or as a powerful <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/Node.js.html'>Node.js application</a>.</p><div class='tw-message-box'><p><img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAACzCAYAAAAzOiFXAAAMRWlDQ1BJQ0MgUHJvZmlsZQAASA2tV2dYU0kXPrckgZCEEoiAlNCbKL1K74KCVGEthCSQUGIIBBW76+IKrgUVC1Z0VcS2ugKyFkTsLordtXyoi4KyLhZsqHxzQ3G/fXb/ffd5Zu6b95w59z3nzp3MAGjaCuTyXFwLIE9WqIiPCOZPSE3jM+4DE/SBDjYwTCAskAfFxcXAv15vbwJGGa85UrH+1e2fDdoicYEQAItD5gxRgTAP4Z8BSI5QrigEoDUj3mJaoZzCHQjrKpBAhD9ROEuF6Ug96Gb0Y0uVT2J8CADdC0CNJRAosgA4oYjnFwmzUByOCGEnmUgqQ3gVwv5CiQBxnOsIj8jLm4qwJoJgm/GXOFl/wQJBxlBMgSBrCPfnQg0FtVBpgTxXMEP14//Z5eUqUb1UlxnqWRJFZDy666K6bciZGk1hFsIHZBnjYhHWQfiolMq4H7dIlJFJCFP+bcKCEFRL4CH8RiQIjUbYCABnKnOSggawtUCBkMofD5YWRiUO4GTF1PiB+Hi2LHccNT9QHHyWRBw1iMvFBWEJiEca8OxMaXgUwuhd4buKJYkpCCOdeH2RNHkcwhyEmwtyEigNVJyrxZIQilf5KJTxlGZLxHdkKsKpHJEPwcorQEgVnzAXClTP0ke8W6EkMRLxaCwRIxKHhiGMnktMEMuSBvQQEnlhMBWH8i+W56rmN9JJlItzIyjeHOHtBUUJg2PPFCoSKR7VjbiZLRhDzVekmXgmL4yjakLpeQ8xEAKhwAclahkwFbJB2tJV14V+9VvCQQAKyAIxOA4wgyNSVBYZ6hOgGP4AGfIpGBoXrLKKoQjxn4fY/rGOkKmyFqlG5MAT9IQ80pD0J33JGNQHouZCepHeg+P4moM66WH0UHokPZxuN8iAEKnORU0B0n/gopFNjLJToF42mMPXeLQntFbaI9oNWhvtDiTD76ooA5lOkS5QDCoYijwW2lC0/qqIUcVk0DnoQ1oj1e5kMOmH9CPtJI80BEfSDWUSRAag3NwRO1g9SrVySNvXWg7WfdCPUs3/S44DPMee4z6gImMwK/QmByvx9yhfLVIQIa/ov3sS3xOHiLPESeI8cZSoAz5xgqgnLhHHKDygOVxVnayhp8WrKpqDcpAO+jjVOHU6fRr8NZSrADGUAuodoPlfKJ5eiOYfhEyVz1BIsySF/CC0Cov5UTLhyBF8FydnVwBqTad8AF7zVGs1xrvwlctvBPAuRWsAtZzyKS8AgQXAkScA3LdfOYtX6JNaDnDsilCpKOr3I6kbDf1baKIvwwBMwAJsUU4u4AG+EAhhMAZiIRFSYTKqugTykOppMAvmQwmUwXJYDethM2yDXbAXDkIdHIWTcAYuwhW4AXfR3GiH59ANb6EXwzAGxsa4mAFmillhDpgL5oX5Y2FYDBaPpWLpWBYmw5TYLOxbrAwrx9ZjW7Fq7CfsCHYSO4+1Ynewh1gn9gr7iBM4C9fFjXFrfBTuhQfh0XgiPgnPwvPxYnwhvhRfi1fhe/Ba/CR+Eb+Bt+HP8R4CCA2CR5gRjoQXEULEEmlEJqEg5hClRAVRRewjGtC7vka0EV3EB5JOckk+6YjmZySZRArJfHIOuYRcT+4ia8lm8hr5kOwmv9DYNCOaA82HFkWbQMuiTaOV0CpoO2iHaafRt9NOe0un03l0G7on+jZT6dn0mfQl9I30/fRGeiv9Mb2HwWAYMBwYfoxYhoBRyChhrGPsYZxgXGW0M96raaiZqrmohaulqcnUFqhVqO1WO652Ve2pWq+6lrqVuo96rLpIfYb6MvXt6g3ql9Xb1XuZ2kwbph8zkZnNnM9cy9zHPM28x3ytoaFhruGtMV5DqjFPY63GAY1zGg81PrB0WPasENZElpK1lLWT1ci6w3rNZrOt2YHsNHYheym7mn2K/YD9nsPljOREcUScuZxKTi3nKueFprqmlWaQ5mTNYs0KzUOalzW7tNS1rLVCtARac7QqtY5o3dLq0eZqO2vHaudpL9HerX1eu0OHoWOtE6Yj0lmos03nlM5jLsG14IZwhdxvudu5p7ntunRdG90o3WzdMt29ui263Xo6em56yXrT9Sr1jum18QieNS+Kl8tbxjvIu8n7OMx4WNAw8bDFw/YNuzrsnf5w/UB9sX6p/n79G/ofDfgGYQY5BisM6gzuG5KG9objDacZbjI8bdg1XHe473Dh8NLhB4f/ZoQb2RvFG8002mZ0yajH2MQ4wlhuvM74lHGXCc8k0CTbZJXJcZNOU66pv6nUdJXpCdNnfD1+ED+Xv5bfzO82MzKLNFOabTVrMes1tzFPMl9gvt/8vgXTwssi02KVRZNFt6Wp5VjLWZY1lr9ZqVt5WUms1lidtXpnbWOdYr3Ius66w0bfJsqm2KbG5p4t2zbANt+2yva6Hd3Oyy7HbqPdFXvc3t1eYl9pf9kBd/BwkDpsdGgdQRvhPUI2omrELUeWY5BjkWON48ORvJExIxeMrBv5YpTlqLRRK0adHfXFyd0p12m7011nHecxzgucG5xfudi7CF0qXa67sl3DXee61ru+dHNwE7ttcrvtznUf677Ivcn9s4enh8Jjn0enp6VnuucGz1teul5xXku8znnTvIO953of9f7g4+FT6HPQ509fR98c392+HaNtRotHbx/92M/cT+C31a/Nn++f7r/Fvy3ALEAQUBXwKNAiUBS4I/BpkF1QdtCeoBfBTsGK4MPB70J8QmaHNIYSoRGhpaEtYTphSWHrwx6Em4dnhdeEd0e4R8yMaIykRUZHroi8FWUcJYyqjuoe4zlm9pjmaFZ0QvT66Ecx9jGKmIax+NgxY1eOvTfOapxsXF0sxEbFroy9H2cTlx/3y3j6+LjxleOfxDvHz4o/m8BNmJKwO+FtYnDissS7SbZJyqSmZM3kicnVye9SQlPKU9omjJowe8LFVMNUaWp9GiMtOW1HWs83Yd+s/qZ9ovvEkok3J9lMmj7p/GTDybmTj03RnCKYciidlp6Svjv9kyBWUCXoyYjK2JDRLQwRrhE+FwWKVok6xX7icvHTTL/M8syOLL+slVmdkgBJhaRLGiJdL32ZHZm9OftdTmzOzpy+3JTc/Xlqeel5R2Q6shxZ81STqdOntsod5CXytnyf/NX53YpoxY4CrGBSQX2hLto8X1LaKr9TPizyL6osej8tedqh6drTZdMvzbCfsXjG0+Lw4h9nkjOFM5tmmc2aP+vh7KDZW+dgczLmNM21mLtwbvu8iHm75jPn58z/dYHTgvIFb75N+bZhofHCeQsffxfxXU0Jp0RRcmuR76LN35PfS79vWey6eN3iL6Wi0gtlTmUVZZ+WCJdc+MH5h7U/9C3NXNqyzGPZpuX05bLlN1cErNhVrl1eXP545diVtav4q0pXvVk9ZfX5CreKzWuYa5Rr2tbGrK1fZ7lu+bpP6yXrb1QGV+7fYLRh8YZ3G0Ubr24K3LRvs/Hmss0ft0i33N4asbW2yrqqYht9W9G2J9uTt5/90evH6h2GO8p2fN4p29m2K35Xc7VndfVuo93LavAaZU3nnol7ruwN3Vu/z3Hf1v28/WUH4IDywLOf0n+6eTD6YNMhr0P7frb6ecNh7uHSWqx2Rm13naSurT61vvXImCNNDb4Nh38Z+cvOo2ZHK4/pHVt2nHl84fG+E8UnehrljV0ns04+bprSdPfUhFPXm8c3t5yOPn3uTPiZU2eDzp4453fu6Hmf80cueF2ou+hxsfaS+6XDv7r/erjFo6X2sufl+iveVxpaR7cevxpw9eS10Gtnrkddv3hj3I3Wm0k3b9+aeKvttuh2x53cOy9/K/qt9+68e7R7pfe17lc8MHpQ9R+7/+xv82g79jD04aVHCY/uPhY+fv57we+f2hc+YT+Line truncated
</p></div><p>This is <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> version <strong>5.0.0-alpha.16-prerelease</strong> (see the detailed <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/ReleaseHistory.html'>ReleaseHistory</a> and the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/RoadMap.html'>RoadMap</a> for getting to the full release). It is a great time to get involved and support the future development of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a>. <em><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> is a free, open source project that depends on <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/HelpingTiddlyWiki.html'>your love and support</a> for its survival</em>.
</p><h1 class=''>Getting started with <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> under Node.js</h1><p><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on tiddlers, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolders</a>, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlerFiles.html'>TiddlerFiles</a> and <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWikiFiles.html'>TiddlyWikiFiles</a>. For example, the following command loads the tiddlers from a <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> HTML file and then saves one of them in HTML:</p><pre>node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</pre><p>In order to use <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> on the command line you must first install node.js from <a class='tw-tiddlylink-external' href='http://nodejs.org/' target='_blank'>http://nodejs.org/</a></p><h2 class=''>Usage</h2><p>Running <code>tiddlywiki.js</code> from the command line boots the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>The first argument is the optional path to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p>The commands and their individual arguments follow, each command being identified by the prefix <code>--</code>.</p><pre>node tiddlywiki.js [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</pre><h2 class=''>Script Files</h2><p>For trying <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> out under Node.js, several scripts are provided (.sh for *nix and .cmd for Windows):</p><h3 class=''><code>bld</code>: builds tw5.com</h3><p>This script builds several variants of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> for deployment on tiddlywiki.com.</p><p>By default, files are output to a folder called <code>jermolene.github.com</code>, sibling to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> source directory. For example:</p><pre>/TiddlyWork/ - Directory for working with TiddlyWiki5
<h1 class=''>Welcome to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a></h1><p>This is the developer documentation hub for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a>. This site contains all of the end user documentation that appears at <a class='tw-tiddlylink-external' href='http://five.tiddlywiki.com/' target='_blank'>http://five.tiddlywiki.com/</a>.</p><h1 class=''>Overview</h1><ul><li><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiArchitecture.html'>TiddlyWikiArchitecture</a></li><li><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5%20Development%20Environment.html'>TiddlyWiki5 Development Environment</a></li><li><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/Building%20classic%20TiddlyWiki%20with%20TiddlyWiki5.html'>Building classic TiddlyWiki with TiddlyWiki5</a></li></ul><h1 class=''>Developer Cookbooks</h1><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/Using%20TiddlyWiki%20for%20GitHub%20Pages%20project%20documentation.html'>Using TiddlyWiki for GitHub Pages project documentation</a></div><h1 class=''>Internal Objects and Mechanisms</h1><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/BootMechanism.html'>BootMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/DraftMechanism.html'>DraftMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/EncryptionMechanism.html'>EncryptionMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/LazyLoadingMechanism.html'>LazyLoadingMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/ParsingMechanism.html'>ParsingMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/PluginMechanism.html'>PluginMechanism</a></div><div><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/RenderingMechanism.html'>RenderingMechanism</a></div><h1 class=''>Getting started with <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> under Node.js</h1><p><a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on tiddlers, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolders</a>, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlerFiles.html'>TiddlerFiles</a> and <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWikiFiles.html'>TiddlyWikiFiles</a>. For example, the following command loads the tiddlers from a <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> HTML file and then saves one of them in HTML:</p><pre>node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</pre><p>In order to use <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> on the command line you must first install node.js from <a class='tw-tiddlylink-external' href='http://nodejs.org/' target='_blank'>http://nodejs.org/</a></p><h2 class=''>Usage</h2><p>Running <code>tiddlywiki.js</code> from the command line boots the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>The first argument is the optional path to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p>The commands and their individual arguments follow, each command being identified by the prefix <code>--</code>.</p><pre>node tiddlywiki.js [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</pre><h2 class=''>Script Files</h2><p>For trying <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> out under Node.js, several scripts are provided (.sh for *nix and .cmd for Windows):</p><h3 class=''><code>bld</code>: builds tw5.com<Line truncated
/TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
/jermolene.github.com/ - Directory for output files</pre><p>You can override the build output directory by defining the environment variable <code>TW5_BUILD_OUTPUT</code>. The easiest way to do this is to create a personal batch file to invoke <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> that first sets the environment variable and then invokes <code>bld</code>.</p><p>The files output by <code>bld</code> are:</p><ul><li><code>readme.md</code> main readme file, output to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> directory</li><li><code>index.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> standalone HTML file with content from the <code>tw5.com</code> edition</li><li><code>empty.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> standalone HTML file with no content</li><li><code>encrypted.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> standalone HTML file encrypted with the password <code>password</code></li><li><code>test.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> browser-based test suite (see <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TestingMechanism.html'>TestingMechanism</a>)</li><li><code>static.html</code> static HTML version of the <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/DefaultTiddlers.html'>DefaultTiddlers</a> of the <code>tw5.com</code> edition</li><li><code>static/*.html</code> and <code>static/static.css</code> static HTML versions of individual tiddlers</li></ul><p><code>bld</code> also runs the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> Node.js-based test suite (see <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TestingMechanism.html'>TestingMechanism</a>)</p><h3 class=''><code>serve.sh &lt;username&gt;</code> or <code>serve.cmd &lt;username&gt;</code>: serves tw5.com</h3><p>This script starts <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> running as an HTTP server with the content from the <code>clientserver</code> edition. By default, the Node.js serves on port 8080. If the optional <code>username</code> parameter is provided, it is used for signing edits.</p><p>To experiment with this configuration, run the script and then visit <code>http://0.0.0.0:8080</code> in a browser.</p><p>Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).</p><h3 class=''><code>wbld</code>: builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>TiddlyWeb</a></h3><p>This script builds and deploys the code for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5%20in%20the%20Sky%20for%20TiddlyWeb.html'>TiddlyWiki5 in the Sky for TiddlyWeb</a>. If you want to experiment with your own builds of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>TiddlyWeb</a> you could use this batch file as a base.</p><h3 class=''><code>2bld</code>: builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> 2.6.5</h3><p>This script builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> 2.6.5 from the original source and then displays the differences between them (<code>diff</code> is used for *nix, <code>fc</code> for Windows).</p><h2 class=''>Commands</h2><p>The following commands are available:</p><h3 class=''>LoadCommand</h3><p>Load tiddlers from 2.x.x <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> files (<code>.html</code>), <code>.tiddler</code>, <code>.tid</code>, <code>.json</code> or other files </p><pre>--load &lt;filepath&gt;</pre><h3 class=''>PasswordCommand</h3><p>Set a password for subsequent crypto operations</p><pre>--password &lt;password&gt;</pre><h3 class=Line truncated
</p>