From 2e2d30bae9e46b4ae453ecb1ca8c0987df00e152 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Tue, 17 Jun 2014 22:26:27 +0100 Subject: [PATCH] Docs for environment variable support Fixes #531 --- .../tw5.com/tiddlers/commands/InitCommand.tid | 6 +++++- .../dev/Environment Variables on Node.js.tid | 21 +++++++++++++++++++ .../dev/Using TiddlyWiki on Node.js.tid | 6 +++++- 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 editions/tw5.com/tiddlers/dev/Environment Variables on Node.js.tid diff --git a/editions/tw5.com/tiddlers/commands/InitCommand.tid b/editions/tw5.com/tiddlers/commands/InitCommand.tid index 56919407e..8a3f8bbdb 100644 --- a/editions/tw5.com/tiddlers/commands/InitCommand.tid +++ b/editions/tw5.com/tiddlers/commands/InitCommand.tid @@ -1,7 +1,11 @@ created: 20140223195548209 -modified: 20140223195738745 +modified: 20140617212529392 tags: command title: InitCommand type: text/vnd.tiddlywiki {{$:/language/Help/init}} + +See also: + +* [[Environment Variables on Node.js]] diff --git a/editions/tw5.com/tiddlers/dev/Environment Variables on Node.js.tid b/editions/tw5.com/tiddlers/dev/Environment Variables on Node.js.tid new file mode 100644 index 000000000..0c3b2347d --- /dev/null +++ b/editions/tw5.com/tiddlers/dev/Environment Variables on Node.js.tid @@ -0,0 +1,21 @@ +created: 20140617211749290 +modified: 20140617212340133 +title: Environment Variables on Node.js +type: text/vnd.tiddlywiki + +[[TiddlyWiki on Node.js]] supports the following OS environment variables for specifying a colon-delimited list of paths to search for plugins and editions: + +* `TIDDLYWIKI_PLUGIN_PATH` - Search path for ordinary plugins +* `TIDDLYWIKI_THEME_PATH` - Search path for themes +* `TIDDLYWIKI_LANGUAGE_PATH` - Search path for languages +* `TIDDLYWIKI_EDITION_PATH` - Search path for editions (used by the InitCommand) + +The additional paths should each point to folders structured like the equivalent directories in the TiddlyWiki5 GitHub repository: the plugin, theme and language directories contain `publisher/pluginname/` while the edition directories contain `editionname/` + +For example: + +``` +TIDDLYWIKI_PLUGIN_PATH=~/MyPluginStore +tiddlywiki mywiki --build index +``` + diff --git a/editions/tw5.com/tiddlers/dev/Using TiddlyWiki on Node.js.tid b/editions/tw5.com/tiddlers/dev/Using TiddlyWiki on Node.js.tid index f117feefe..8810b1cd3 100644 --- a/editions/tw5.com/tiddlers/dev/Using TiddlyWiki on Node.js.tid +++ b/editions/tw5.com/tiddlers/dev/Using TiddlyWiki on Node.js.tid @@ -1,5 +1,5 @@ created: 20131219100520659 -modified: 20131219163807594 +modified: 20140617212408196 tags: howto title: Using TiddlyWiki on Node.js type: text/vnd.tiddlywiki @@ -25,3 +25,7 @@ tiddlywiki [] [-- [[,]]] The available commands are:
    <$list filter="[tag[command]]">
  • <$link to={{!!title}}><$view field="title"/>
+ +See also: + +* [[Environment Variables on Node.js]]