mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Start building the static files

Browse Source 
There's a few parts that don't work yet
This commit is contained in:
Jeremy Ruston 2013-10-18 15:20:33 +01:00
parent 3f151ba70e
commit 35c7094306
3 changed files with 92 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
contributing.md
View File

@ -1,10 +1,8 @@
<h1 class=''> <h1 class=''>
Contributing to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> Contributing to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a></h1><div class='tw-tiddler'> TiddlyWiki5</a></h1><p>
<div class='tw-transclude'> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
<p> TiddlyWiki5</a> welcomes contributions to its code and documentation via <a class=' tw-tiddlylink tw-tiddlylink-missing' href='https://github.com/Jermolene/TiddlyWiki5'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> welcomes contributions to its code and documentation via <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>
GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h2 class=''> GitHub</a>. Please take a moment to read these notes to help make the process as smooth as possible.</p><h2 class=''>
Bug Reports</h2><p> Bug Reports</h2><p>
From the perspective of the developers, a bug report that says little more than &quot;it doesn't work&quot; can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:</p><ul> From the perspective of the developers, a bug report that says little more than &quot;it doesn't work&quot; can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:</p><ul>
@ -16,24 +14,24 @@ Expected behaviour</li><li>
Context (OS, browser etc.)</li></ul><p> Context (OS, browser etc.)</li></ul><p>
There's a lot of good material on the web about bug reports:</p><ul> There's a lot of good material on the web about bug reports:</p><ul>
<li> <li>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report'> <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report'>
http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a></li><li> http://mhay68.tumblr.com/post/1648223018/what-makes-a-good-bug-report</a></li><li>
<a class='tw-tiddlylink tw-tiddlylink-external' href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html'> <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://www.chiark.greenend.org.uk/~sgtatham/bugs.html'>
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></li></ul><h2 class=''> http://www.chiark.greenend.org.uk/~sgtatham/bugs.html</a></li></ul><h2 class=''>
Pull Requests</h2><p> Pull Requests</h2><p>
Like other <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/OpenSource.html'> Like other <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='OpenSource'>
OpenSource</a> projects, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> OpenSource</a> projects, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> needs a signed <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/ContributorLicenseAgreement.html'> TiddlyWiki5</a> needs a signed <a class=' tw-tiddlylink tw-tiddlylink-missing' href='ContributorLicenseAgreement'>
ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/UnaMesa.html'> ContributorLicenseAgreement</a> from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the <a class=' tw-tiddlylink tw-tiddlylink-missing' href='UnaMesa'>
UnaMesa</a> Association (the legal entity that owns <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> UnaMesa</a> Association (the legal entity that owns <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> on behalf of the community).</p><ul> TiddlyWiki</a> on behalf of the community).</p><ul>
<li> <li>
For individuals use: <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md'> For individuals use: <a class=' tw-tiddlylink tw-tiddlylink-missing' href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-individual.md'>
CLA-individual</a></li><li> CLA-individual</a></li><li>
For entities use: <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md'> For entities use: <a class=' tw-tiddlylink tw-tiddlylink-missing' href='https://github.com/Jermolene/TiddlyWiki5/tree/master/licenses/cla-entity.md'>
CLA-entity</a></li></ul><p> CLA-entity</a></li></ul><p>
<em> <em>
This is a first pass at a CLA for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> This is a first pass at a CLA for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a>. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again</em></p><h3 class=''> TiddlyWiki</a>. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again</em></p><h3 class=''>
How to sign the CLA</h3><pre> How to sign the CLA</h3><pre>
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5 git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5
@ -51,10 +49,10 @@ Go to your github repo and create a pull request.</strong></p><p>
<strong> <strong>
Thank you!</strong></p><h4 class=''> Thank you!</strong></p><h4 class=''>
Attribution</h4><p> Attribution</h4><p>
The CLA documents used for this project where created using <a class='tw-tiddlylink tw-tiddlylink-external' href='http://www.harmonyagreements.org'> The CLA documents used for this project where created using <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://www.harmonyagreements.org'>
Harmony Project Templates</a>. &quot;HA-CLA-I-LIST Version 1.0&quot; for &quot;CLA-individual&quot; and &quot;HA-CLA-E-LIST Version 1.0&quot; for &quot;CLA-entity&quot; Harmony Project Templates</a>. &quot;HA-CLA-I-LIST Version 1.0&quot; for &quot;CLA-individual&quot; and &quot;HA-CLA-E-LIST Version 1.0&quot; for &quot;CLA-entity&quot;
</p></div></div><p> </p><p>
<em> <em>
This file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> This file was automatically generated by <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a></em> TiddlyWiki5</a></em>
</p> </p>

3
nbld.sh
View File

@ -21,6 +21,9 @@ node ./tiddlywiki.js \
./editions/tw5.com \ ./editions/tw5.com \
--verbose \ --verbose \
--new_rendertiddler $:/core/templates/tiddlywiki5.template.html $TW5_BUILD_OUTPUT/index.html text/plain \ --new_rendertiddler $:/core/templates/tiddlywiki5.template.html $TW5_BUILD_OUTPUT/index.html text/plain \
--new_rendertiddler ReadMe ./readme.md text/html \
--new_rendertiddler ContributingTemplate ./contributing.md text/html \
--new_rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
|| exit 1 || exit 1
# Run tests # Run tests

189
readme.md
View File

@ -1,105 +1,101 @@
<h1 class=''> <h1 class=''>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> Welcome to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a></h1><div class='tw-tiddler'> TiddlyWiki5</a></h1><p>
<div class='tw-transclude'> Welcome to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
<p> TiddlyWiki5</a>, a reboot of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.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='JavaScript'>
TiddlyWiki5</a>, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='node.js'>
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-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/JavaScript.html'>
JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/node.js.html'>
node.js application</a>.</p><p> node.js application</a>.</p><p>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> is currently in alpha, meaning it is working but incomplete. It is a great time to get involved and support its <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/RoadMap.html'> TiddlyWiki5</a> is currently in alpha, meaning it is working but incomplete. It is a great time to get involved and support its <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='RoadMap'>
future development</a>:</p><ul> future development</a>:</p><ul>
<li> <li>
Explore its features online at <a class='tw-tiddlylink tw-tiddlylink-external' href='http://five.tiddlywiki.com/'> Explore its features online at <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://five.tiddlywiki.com/'>
http://five.tiddlywiki.com/</a></li><li> http://five.tiddlywiki.com/</a></li><li>
Join the discussions on <a class='tw-tiddlylink tw-tiddlylink-external' href='http://groups.google.com/group/TiddlyWikiDev'> Join the discussions on <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://groups.google.com/group/TiddlyWikiDev'>
the TiddlyWikiDev Google Group</a></li><li> the TiddlyWikiDev Google Group</a></li><li>
Get involved in the <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'> Get involved in the <a class=' tw-tiddlylink tw-tiddlylink-missing' href='https://github.com/Jermolene/TiddlyWiki5'>
development on GitHub</a></li><li> development on GitHub</a></li><li>
Follow <a class='tw-tiddlylink tw-tiddlylink-external' href='http://twitter.com/#!/TiddlyWiki'> Follow <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://twitter.com/#!/TiddlyWiki'>
@TiddlyWiki on Twitter</a> for the latest news</li></ul><p> @TiddlyWiki on Twitter</a> for the latest news</li></ul><p>
<em> <em>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> is a free, open source project that depends on <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/HelpingTiddlyWiki.html'> TiddlyWiki</a> is a free, open source project that depends on <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='HelpingTiddlyWiki'>
your love and support</a> for its survival</em> your love and support</a> for its survival</em>
</p></div></div><h1 class=''> </p><h1 class=''>
Getting started with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> Getting started with <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> under node.js</h1><div class='tw-tiddler'> TiddlyWiki</a> under node.js</h1><p>
<div class='tw-transclude'> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
<p> 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='TiddlyWikiFolders'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> TiddlyWikiFolders</a>, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlerFiles'>
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-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'> TiddlerFiles</a> and <a class=' tw-tiddlylink tw-tiddlylink-missing' href='TiddlyWikiFiles'>
TiddlyWikiFolders</a>, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlerFiles.html'> TiddlyWikiFiles</a>. For example, the following command loads the tiddlers from a <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlerFiles</a> and <a class='tw-tiddlylink tw-tiddlylink-internal 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-internal 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> 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> node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</pre><p>
In order to use <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> In order to use <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> on the command line you must first install node.js from <a class='tw-tiddlylink tw-tiddlylink-external' href='http://nodejs.org/'> TiddlyWiki5</a> on the command line you must first install node.js from <a class=' tw-tiddlylink tw-tiddlylink-missing' href='http://nodejs.org/'>
http://nodejs.org/</a></p><h2 class=''> http://nodejs.org/</a></p><h2 class=''>
Usage</h2><p> Usage</h2><p>
Running <code> Running <code>
tiddlywiki.js</code> from the command line boots the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> tiddlywiki.js</code> from the command line boots the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
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> 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-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'> The first argument is the optional path to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWikiFolders'>
TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p> 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> The commands and their individual arguments follow, each command being identified by the prefix <code>
--</code>.</p><pre> --</code>.</p><pre>
node tiddlywiki.js [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</pre><h2 class=''> node tiddlywiki.js [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</pre><h2 class=''>
Batch Files</h2><p> Batch Files</h2><p>
For trying <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> For trying <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> out under node.js, several batch files are provided:</p><h3 class=''> TiddlyWiki5</a> out under node.js, several batch files are provided:</p><h3 class=''>
<code> <code>
bld.sh</code> builds tw5.com</h3><p> bld.sh</code> builds tw5.com</h3><p>
This batch file builds several variants of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> This batch file builds several variants of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> for deployment on tiddlywiki.com.</p><p> TiddlyWiki5</a> for deployment on tiddlywiki.com.</p><p>
By default, files are output to a folder called <code> By default, files are output to a folder called <code>
jermolene.github.com</code> in the same directory as the main <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> jermolene.github.com</code> in the same directory as the main <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> directory. You will need to create the directory before running the batch file. For example:</p><pre> TiddlyWiki5</a> directory. You will need to create the directory before running the batch file. For example:</p><pre>
* /TiddlyWork/ - Directory for working with TiddlyWiki5 * /TiddlyWork/ - Directory for working with TiddlyWiki5
* /TiddlyWork/TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub * /TiddlyWork/TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
* /TiddlyWork/jermolene.github.com/ - Directory for output files</pre><p> * /TiddlyWork/jermolene.github.com/ - Directory for output files</pre><p>
You can override the build output directory by defining the environment variable <code> 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-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> 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='TiddlyWiki5'>
TiddlyWiki5</a> that first sets the environment variable and then invokes <code> TiddlyWiki5</a> that first sets the environment variable and then invokes <code>
bld.sh</code>.</p><p> bld.sh</code>.</p><p>
The files output by <code> The files output by <code>
bld.sh</code> are:</p><ul> bld.sh</code> are:</p><ul>
<li> <li>
<code> <code>
readme.md</code> main readme file, output to the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> readme.md</code> main readme file, output to the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> directory</li><li> TiddlyWiki5</a> directory</li><li>
<code> <code>
index.html</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> index.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> standalone HTML file with content from the <code> TiddlyWiki5</a> standalone HTML file with content from the <code>
tw5.com</code> edition</li><li> tw5.com</code> edition</li><li>
<code> <code>
empty.html</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> empty.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> standalone HTML file with no content</li><li> TiddlyWiki5</a> standalone HTML file with no content</li><li>
<code> <code>
encrypted.html</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> encrypted.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> standalone HTML file encrypted with the password <code> TiddlyWiki5</a> standalone HTML file encrypted with the password <code>
password</code></li><li> password</code></li><li>
<code> <code>
test.html</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> test.html</code> <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> browser-based test suite (see <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TestingMechanism.html'> TiddlyWiki5</a> browser-based test suite (see <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TestingMechanism'>
TestingMechanism</a>)</li><li> TestingMechanism</a>)</li><li>
<code> <code>
static.html</code> static HTML version of the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/DefaultTiddlers.html'> static.html</code> static HTML version of the <a class=' tw-tiddlylink tw-tiddlylink-missing' href='DefaultTiddlers'>
DefaultTiddlers</a> of the <code> DefaultTiddlers</a> of the <code>
tw5.com</code> edition</li><li> tw5.com</code> edition</li><li>
<code> <code>
static/*.html</code> and <code> static/*.html</code> and <code>
static/static.css</code> static HTML versions of individual tiddlers</li></ul><p> static/static.css</code> static HTML versions of individual tiddlers</li></ul><p>
<code> <code>
bld.sh</code> also runs the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> bld.sh</code> also runs the <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> node.js-based test suite (see <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TestingMechanism.html'> TiddlyWiki5</a> node.js-based test suite (see <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TestingMechanism'>
TestingMechanism</a>)</p><h3 class=''> TestingMechanism</a>)</p><h3 class=''>
<code> <code>
serve.sh</code> serves tw5.com</h3><p> serve.sh</code> serves tw5.com</h3><p>
This batch file starts <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> This batch file starts <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> running as an HTTP server with the content from the <code> TiddlyWiki5</a> running as an HTTP server with the content from the <code>
clientserver</code> edition. By default, the script serves on port 8080.</p><pre> clientserver</code> edition. By default, the script serves on port 8080.</p><pre>
./server.sh UserName</pre><p> ./server.sh UserName</pre><p>
@ -108,49 +104,33 @@ To experiment with this configuration, run the script and then visit <code>
http://0.0.0.0:8080</code> in a browser.</p><p> 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=''> 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> <code>
wbld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> wbld.sh</code> builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'> TiddlyWiki5</a> for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWeb'>
TiddlyWeb</a></h3><p> TiddlyWeb</a></h3><p>
This batch file builds and deploys the code for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5%20in%20the%20Sky%20for%20TiddlyWeb.html'> This batch file builds and deploys the code for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5 in the Sky for TiddlyWeb'>
TiddlyWiki5 in the Sky for TiddlyWeb</a>. If you want to experiment with your own builds of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.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='TiddlyWiki5'>
TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'> TiddlyWiki5</a> for <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWeb'>
TiddlyWeb</a> you could use this batch file as a base.</p><h3 class=''> TiddlyWeb</a> you could use this batch file as a base.</p><h3 class=''>
<code> <code>
2bld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> 2bld.sh</code> builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> 2.6.5</h3><p> TiddlyWiki</a> 2.6.5</h3><p>
This batch file builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> This batch file builds <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
TiddlyWiki</a> 2.6.5 from the original source and then uses the <code> TiddlyWiki</a> 2.6.5 from the original source and then uses the <code>
opendiff</code> program to display the differences between them.</p><h2 class=''> opendiff</code> program to display the differences between them.</p><h2 class=''>
Commands</h2><p> Commands</h2><p>
The following commands are available:</p><div class='tw-list-frame'> The following commands are available:</p><h3 class=''>
<div class='tw-list-element'> LoadCommand</h3><p>
<div class='tw-tiddler'> Load tiddlers from 2.x.x <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/LoadCommand.html'>
LoadCommand</a></span></h3><div class='tw-transclude'>
<p>
Load tiddlers from 2.x.x <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
TiddlyWiki</a> files (<code> TiddlyWiki</a> files (<code>
.html</code>), <code> .html</code>), <code>
.tiddler</code>, <code> .tiddler</code>, <code>
.tid</code>, <code> .tid</code>, <code>
.json</code> or other files </p><pre> .json</code> or other files </p><pre>
--load &lt;filepath&gt;</pre></div></div></div><div class='tw-list-element'> --load &lt;filepath&gt;</pre><h3 class=''>
<div class='tw-tiddler'> PasswordCommand</h3><p>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/PasswordCommand.html'>
PasswordCommand</a></span></h3><div class='tw-transclude'>
<p>
Set a password for subsequent crypto operations</p><pre> Set a password for subsequent crypto operations</p><pre>
--password &lt;password&gt;</pre></div></div></div><div class='tw-list-element'> --password &lt;password&gt;</pre><h3 class=''>
<div class='tw-tiddler'> PrintCommand</h3><p>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/PrintCommand.html'>
PrintCommand</a></span></h3><div class='tw-transclude'>
<p>
The <code> The <code>
print</code> command outputs specified information. </p><h3 class=''> print</code> command outputs specified information. </p><h3 class=''>
print tiddlers</h3><p> print tiddlers</h3><p>
@ -164,39 +144,24 @@ Print the titles of the system tiddlers in the wiki store </p><pre>
--print system</pre><h3 class=''> --print system</pre><h3 class=''>
print config</h3><p> print config</h3><p>
Print the current core configuration </p><pre> Print the current core configuration </p><pre>
--print config</pre></div></div></div><div class='tw-list-element'> --print config</pre><h3 class=''>
<div class='tw-tiddler'> RenderTiddlerCommand</h3><p>
<h3 class=''> Render an individual tiddler as a specified <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='ContentType'>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/RenderTiddlerCommand.html'>
RenderTiddlerCommand</a></span></h3><div class='tw-transclude'>
<p>
Render an individual tiddler as a specified <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/ContentType.html'>
ContentType</a>, defaults to <code> ContentType</a>, defaults to <code>
text/html</code> and save it to the specified filename </p><pre> text/html</code> and save it to the specified filename </p><pre>
--rendertiddler &lt;title&gt; &lt;filename&gt; [&lt;type&gt;]</pre></div></div></div><div class='tw-list-element'> --rendertiddler &lt;title&gt; &lt;filename&gt; [&lt;type&gt;]</pre><h3 class=''>
<div class='tw-tiddler'> RenderTiddlersCommand</h3><p>
<h3 class=''> Render a set of tiddlers matching a filter to separate files of a specified <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='ContentType'>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/RenderTiddlersCommand.html'>
RenderTiddlersCommand</a></span></h3><div class='tw-transclude'>
<p>
Render a set of tiddlers matching a filter to separate files of a specified <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/ContentType.html'>
ContentType</a> (defaults to <code> ContentType</a> (defaults to <code>
text/html</code>) and extension (defaults to <code> text/html</code>) and extension (defaults to <code>
.html</code>).</p><pre> .html</code>).</p><pre>
--rendertiddlers &lt;filter&gt; &lt;template&gt; &lt;pathname&gt; [&lt;type&gt;] [&lt;extension&gt;]</pre><p> --rendertiddlers &lt;filter&gt; &lt;template&gt; &lt;pathname&gt; [&lt;type&gt;] [&lt;extension&gt;]</pre><p>
For example:</p><pre> For example:</p><pre>
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain</pre></div></div></div><div class='tw-list-element'> --rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain</pre><h3 class=''>
<div class='tw-tiddler'> ServerCommand</h3><p>
<h3 class=''> The server built in to <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
<span class='tw-view-link'> TiddlyWiki5</a> is very simple. Although compatible with <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWeb'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/ServerCommand.html'> TiddlyWeb</a> it doesn't support many of the features needed for robust Internet-facing usage - in particular, <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
ServerCommand</a></span></h3><div class='tw-transclude'>
<p>
The server built in to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> is very simple. Although compatible with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>
TiddlyWeb</a> it doesn't support many of the features needed for robust Internet-facing usage - in particular, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> is an old-school wiki in the sense that it offers no authentication.</p><p> TiddlyWiki5</a> is an old-school wiki in the sense that it offers no authentication.</p><p>
At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for <code> At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for <code>
GET</code>, <code> GET</code>, <code>
@ -216,25 +181,15 @@ servetype</strong> - the content type with which the root tiddler should be serv
<strong> <strong>
username</strong> - the default username for signing edits</li></ul><p> username</strong> - the default username for signing edits</li></ul><p>
For example:</p><pre> For example:</p><pre>
--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName</pre></div></div></div><div class='tw-list-element'> --server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName</pre><h3 class=''>
<div class='tw-tiddler'> VerboseCommand</h3><p>
<h3 class=''>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/VerboseCommand.html'>
VerboseCommand</a></span></h3><div class='tw-transclude'>
<p>
Triggers verbose output, useful for debugging </p><pre> Triggers verbose output, useful for debugging </p><pre>
--verbose</pre></div></div></div><div class='tw-list-element'> --verbose</pre><h3 class=''>
<div class='tw-tiddler'> VersionCommand</h3><p>
<h3 class=''> Displays the version number of <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki'>
<span class='tw-view-link'>
<a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/VersionCommand.html'>
VersionCommand</a></span></h3><div class='tw-transclude'>
<p>
Displays the version number of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
TiddlyWiki</a>.</p><pre> TiddlyWiki</a>.</p><pre>
--version</pre></div></div></div></div></div></div><p> --version</pre><p>
<em> <em>
This readme file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> This readme file was automatically generated by <a class=' tw-tiddlylink tw-tiddlylink-resolves' href='TiddlyWiki5'>
TiddlyWiki5</a></em> TiddlyWiki5</a></em>
</p> </p>