TiddlyWiki5/readme.md

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

This is version 5.0.6-prerelease of TiddlyWiki, a major reboot designed for the next 25 years. It is currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.

TiddlyWiki is a free, open source project that depends on your love and support for its survival.

TiddlyWikiClassic - http://classic.tiddlywiki.com

On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and "TiddlyWikiClassic" is used to identify the older version.

The deep internal improvements mean that the new version of TiddlyWiki is not fully compatible with TiddlyWikiClassic. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as the new version matures.

Getting started with TiddlyWiki under Node.js

Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:

• You can edit your content on any suitably compatible HTML5 browser, including smartphones and tablets
• Individual tiddlers are stored in separate files, which you can organise as you wish
• The ability to build multiple wikis that blend different combinations of shared and unique content

Installation

1. Install Node.js from http://npmjs.org
2. Open a command line terminal and type:

   npm -g install tiddlywiki

   If it fails with an error you may need to re-run the command as an administrator:

   sudo npm -g install tiddlywiki

3. Check TiddlyWiki is installed by typing:

   tiddlywiki --version

4. In response, you should see TiddlyWiki report its current version (eg 5.0.4-beta; you may also see other debugging information reported)
5. Try it out:
   1. mkdir mywiki to create a folder for a new wiki
   2. cd mywiki to move into the new folder
   3. tiddlywiki --server to start TiddlyWiki
   4. Visit http://0.0.0.0:8080/ in your browser
   5. Try editing and creating tiddlers

The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.

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 Working with the TiddlyWiki5 repository.

Usage

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.

For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:

tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html

Running tiddlywiki from the command line boots the TiddlyWiki 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.

The first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.

The commands and their individual arguments follow, each command being identified by the prefix --.

tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]

The available commands are:

• LoadCommand
• PasswordCommand
• PrintCommand
• RenderTiddlerCommand
• RenderTiddlersCommand
• SaveTiddlerCommand
• ServerCommand
• VerboseCommand
• VersionCommand

Upgrading

If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:

sudo npm -g update tiddlywiki

Commands

The following commands are available:

• LoadCommand
• PasswordCommand
• PrintCommand
• RenderTiddlerCommand
• RenderTiddlersCommand
• SaveTiddlerCommand
• ServerCommand
• VerboseCommand
• VersionCommand

Working with the TiddlyWiki5 repository

Setting Up

If you plan on working with the TiddlyWiki5 source code then follow these steps:

1. Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5
2. Clone a local copy of your fork
3. Open a command line terminal and change the current working directory to the root of the repo
4. Type sudo npm link to tell npm to use this copy of the repo as the globally installed one

After this procedure you can work with TiddlyWiki5 via npm as though it were installed in the usual way with npm -g install tiddlywiki.

See also Scripts for TiddlyWiki on Node.js.

This readme file was automatically generated by TiddlyWiki