TiddlyWiki5/readme.md

<h1 class=''>Welcome to <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></h1><p>Welcome to <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a>, a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/JavaScript.html'>JavaScript</a>. It can be used as a <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/SingleFileApplication.html'>single HTML file in the browser</a> or as a powerful <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Node.js.html'>Node.js application</a>. It is highly customisable: the entire user interface is itself implemented in hackable <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/WikiText.html'>WikiText</a>.</p><p>This is version 5.0.10-prerelease of TiddlyWiki, a major reboot designed <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Future%2520of%2520TiddlyWiki.html'>for the next 25 years</a>. It is currently in beta (see the detailed <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/ReleaseHistory.html'>ReleaseHistory</a>). There is a <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/RoadMap.html'>RoadMap</a> for moving to the full release. It is a great time to <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Community.html'>get involved</a> and support the future development of TiddlyWiki.</p><p>Version 5.0.8-beta will require some changes to content created for earlier betas – see: <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Notes%2520for%2520upgrading%2520to%25205.0.8-beta.html'>Notes for upgrading to 5.0.8-beta</a> and <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/ReleaseHistory.html'>ReleaseHistory</a></p><p><em>TiddlyWiki is a free, open source project that depends on <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/HelpingTiddlyWiki.html'>your love and support</a> for its survival</em>.</p><div class='tw-message-box'><p><a class='tw-message-icon' href='http://tiddlywiki.com/' target='_blank'><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+4ia8lm8hr5kOwmv9D
</p></div><h1 class=''>Getting started with <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> under Node.js</h1><p>Running <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> on <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Node.js.html'>Node.js</a> brings several important benefits over and above the single file version:</p><ul><li>You can edit your content on any suitably compatible HTML5 browser, including smartphones and tablets</li><li>Individual tiddlers are stored in separate files, which you can organise as you wish</li><li>The ability to build multiple wikis that blend different combinations of shared and unique content</li></ul><h1 class=''>Installation</h1><ol><li>Install <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Node.js.html'>Node.js</a> from <a class='tw-tiddlylink-external' href='http://nodejs.org' target='_blank'>http://nodejs.org</a></li><li>Open a command line terminal and type:<blockquote><p><code>npm install -g tiddlywiki</code></p><p>If it fails with an error you may need to re-run the command as an administrator:</p><p><code>npm install -g tiddlywiki</code> (Windows)</p><p><code>sudo npm install -g tiddlywiki</code> (Mac/Linux)</p></blockquote></li><li>Check <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> is installed by typing:<blockquote><p><code>tiddlywiki --version</code></p></blockquote></li><li>In response, you should see <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> report its current version (eg <code>5.0.8-beta</code>; you may also see other debugging information reported)</li><li>Try it out:<ol><li><code>tiddlywiki mynewwiki --init server</code> to create a folder for a new wiki that includes server-related components</li><li><code>tiddlywiki mynewwiki --server</code> to start <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></li><li>Visit <a class='tw-tiddlylink-external' href='http://127.0.0.1:8080/' target='_blank'>http://127.0.0.1:8080/</a> in your browser</li><li>Try editing and creating tiddlers</li></ol></li></ol><p>The <code>-g</code> flag causes <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> to be installed globally. Without it, <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> will only be available in the directory where you installed it.</p><p>A slightly different method for installation is recommended if you plan on forking the source code in order to study it or contribute to it. See <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Working%2520with%2520the%2520TiddlyWiki5%2520repository.html'>Working with the TiddlyWiki5 repository</a>.
</p><h1 class=''>Usage</h1><p><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolders</a>, <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlerFiles.html'>TiddlerFiles</a> and <a class='tw-tiddlylink tw-tiddlylink-missing' href='http://tiddlywiki.com/static/TiddlyWikiFiles.html'>TiddlyWikiFiles</a>.</p><p>For example, the following command loads the tiddlers from a <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> HTML file and then saves one of them in static HTML:</p><pre><code>tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</code></pre><p>Running <code>tiddlywiki</code> from the command line boots the <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://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://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><code>tiddlywiki [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</code></pre><p>The available commands are:</p><p><ul><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/HelpCommand.html'>HelpCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/InitCommand.html'>InitCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/LoadCommand.html'>LoadCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/PasswordCommand.html'>PasswordCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/RenderTiddlerCommand.html'>RenderTiddlerCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/RenderTiddlersCommand.html'>RenderTiddlersCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/SaveTiddlerCommand.html'>SaveTiddlerCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/ServerCommand.html'>ServerCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/VerboseCommand.html'>VerboseCommand</a></li><li><a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/VersionCommand.html'>VersionCommand</a></li></ul>
</p><h1 class=''>Upgrading</h1><p>If you've installed <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html'>TiddlyWiki on Node.js</a> on the usual way, when a new version is released you can upgrade it with this command:</p><pre><code>npm update -g tiddlywiki</code></pre><p>On Mac or Linux you'll need to add <strong>sudo</strong> like this:</p><pre><code>sudo npm update -g tiddlywiki</code></pre><h1 class=''>Working with the <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> repository</h1><h1 class=''>Setting Up</h1><p>If you plan on working with the <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> source code then follow these steps:</p><ol><li>Fork the <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> <a class='tw-tiddlylink tw-tiddlylink-missing' href='http://tiddlywiki.com/static/GitHub.html'>GitHub</a> repository from <a class='tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5' target='_blank'>https://github.com/Jermolene/TiddlyWiki5</a></li><li>Clone a local copy of your fork</li><li>Open a command line terminal and change the current working directory to the root of the repo</li><li>Type <code>npm link</code> (Windows) or <code>sudo npm link</code> (Mac/Linux) to tell <a class='tw-tiddlylink tw-tiddlylink-missing' href='http://tiddlywiki.com/static/npm.html'>npm</a> to use this copy of the repo as the globally installed one</li></ol><p>After this procedure you can work with <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> via <a class='tw-tiddlylink tw-tiddlylink-missing' href='http://tiddlywiki.com/static/npm.html'>npm</a> as though it were installed in the usual way with <code>npm install -g tiddlywiki</code>.</p><p>See also <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/Scripts%2520for%2520TiddlyWiki%2520on%2520Node.js.html'>Scripts for TiddlyWiki on Node.js</a>.</p><p><em>This readme file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></em>
</p>