diff --git a/editions/clientserver/tiddlers/TiddlyWikiFolders.tid b/editions/clientserver/tiddlers/TiddlyWikiFolders.tid new file mode 100644 index 000000000..00c36e617 --- /dev/null +++ b/editions/clientserver/tiddlers/TiddlyWikiFolders.tid @@ -0,0 +1,43 @@ +modified: 201304161845 +tags: docs +title: TiddlyWikiFolders + +As well as traditional single file wikis, TiddlyWiki5 [[under node.js|TiddlyWiki5 Node Edition]] supports wikis that are stored as a folder of individual tiddler files. + +! Wiki folder files and folders + +Wiki folders can contain the following files and folders: + +* ''\tiddlers'' - folder containing tiddler files comprising the wiki +* ''\plugins'' - folder containing [[plugin folders|PluginMechanism]] to be included in the wiki +* ''tiddlywiki.info'' - JSON file containing metadata for the wiki. See below + +Only the ''tiddlywiki.info'' file is required, the ''tiddlers'' and ''plugins'' folders are optional. Any files and folders not listed above are ignored. + +! Content of `tiddlywiki.info` + +The `tiddlywiki.info` file in a wiki folder contains a JSON object comprising the following fields: + +* ''plugins'' - an array of CorePlugins to be included in the wiki +* ''doNotSave'' - an array of tiddler titles that should not be saved by the FileSystemAdaptorPlugin +* ''includeWikis'' - an array of relative paths to external wiki folders to be included in the wiki + +For example: + +``` +{ + "plugins": [ + "tiddlywiki/tiddlyweb", + "tiddlywiki/filesystem" + ], + "doNotSave": [ + "$:/StoryList", + "$:/HistoryList", + "$:/status/IsLoggedIn", + "$:/status/UserName" + ], + "includeWikis": [ + "../tw5.com" + ] +} +``` diff --git a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Node_Edition.tid b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Node_Edition.tid index 14d28c82e..ef4861358 100644 --- a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Node_Edition.tid +++ b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Node_Edition.tid @@ -1,22 +1,21 @@ -title: TiddlyWiki5 Node Edition -modifier: JeremyRuston tags: docs edition +modifier: JeremyRuston +title: TiddlyWiki5 Node Edition +modified: 201304161918 -TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML: +TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles. For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML: ``` node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html ``` -In order to use TiddlyWiki5 on the command line you must first install node.js: - -http://nodejs.org/ +In order to use TiddlyWiki5 on the command line you must first install node.js from http://nodejs.org/ !!Usage Running `tiddlywiki.js` 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 WikiDirectory to be loaded. If not present, then the current directory is used. +The first argument is the optional path to the [[TiddlyWikiFolder|TiddlyWikiFolders]] 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 `--`. diff --git a/readme.md b/readme.md index 176aa55bb..92cccf9a7 100644 --- a/readme.md +++ b/readme.md @@ -31,21 +31,21 @@ Getting started with

-TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, +TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, +TiddlyWikiFolders, TiddlerFiles and -TiddlyWikiFiles. For example, this loads the tiddlers from a +TiddlyWikiFiles. For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:

 node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html

In order to use -TiddlyWiki5 on the command line you must first install node.js:

- +TiddlyWiki5 on the command line you must first install node.js from http://nodejs.org/

Usage

Running tiddlywiki.js 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 -WikiDirectory to be loaded. If not present, then the current directory is used.

+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 --.

 node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]