mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-27 03:57:21 +00:00
Docs updates
This commit is contained in:
Jeremy Ruston
parent
ffece485fe
commit
91f5579c3c
43
editions/clientserver/tiddlers/TiddlyWikiFolders.tid
Normal file
43
editions/clientserver/tiddlers/TiddlyWikiFolders.tid
Normal file
@ -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"
|
||||
]
|
||||
}
|
||||
```
|
||||
@ -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 `--`.
|
||||
|
||||
|
||||
12
readme.md
12
readme.md
@ -31,21 +31,21 @@ Getting started with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylin
|
||||
TiddlyWiki</a> under node.js</h1><div class='tw-transclude'>
|
||||
<p>
|
||||
<a class='tw-tiddlylink tw-tiddlylink-internal 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-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlerFiles.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-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWikiFolders.html'>
|
||||
TiddlyWikiFolders</a>, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlerFiles.html'>
|
||||
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, this loads the tiddlers from a <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.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>
|
||||
node tiddlywiki.js --verbose --load mywiki.html --savetiddler 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'>
|
||||
TiddlyWiki5</a> on the command line you must first install node.js:</p><p>
|
||||
<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-external' href='http://nodejs.org/'>
|
||||
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-internal 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-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/WikiDirectory.html'>
|
||||
WikiDirectory</a> to be loaded. If not present, then the current directory is used.</p><p>
|
||||
The first argument is the optional path to the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' 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 [<wikipath>] [--<command> [<arg>[,<arg>]]]</pre><h2 class=''>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user