From 7ed7aba8d066c307bb3bde5af361d319f7fe52e6 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Fri, 19 Sep 2014 15:02:40 +0100 Subject: [PATCH] Docs updates --- bin/readme.md | 2 +- .../What happened to the original TiddlyWiki.tid | 4 ++-- .../tiddlers/mechanisms/UpgradeMechanism.tid | 15 --------------- .../nodejs/Scripts for TiddlyWiki on Node.js.tid | 3 +-- 4 files changed, 4 insertions(+), 20 deletions(-) diff --git a/bin/readme.md b/bin/readme.md index 2479de649..5b1443f95 100644 --- a/bin/readme.md +++ b/bin/readme.md @@ -4,4 +4,4 @@ | +-- /jermolene.github.com/ - Directory for output files

You can override the build output directory by defining the environment variable TW5_BUILD_OUTPUT. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes fullbld.

fullbld also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

serve: serves tw5.com

./bin/serve.sh -h
 ./bin/serve.sh [edition dir] [username] [password] [host] [port]

Or:

./bin/serve.cmd -h
-./bin/serve.cmd [edition dir] [username] [password] [host] [port]

This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the tw5.com-server edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits. If the password is provided then HTTP basic authentication is used.

To experiment with this configuration, run the script and then visit http://127.0.0.1:8080 in a browser.

Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).

test: build and run tests

This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.

lazy: serves tw5.com with lazily loaded images

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.

wbld: builds TiddlyWiki for TiddlyWeb

This script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.

2bld: builds TiddlyWiki 2.6.5

This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff is used for *nix, fc for Windows).

deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version number

These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.

\ No newline at end of file +./bin/serve.cmd [edition dir] [username] [password] [host] [port]

This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the tw5.com-server edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits. If the password is provided then HTTP basic authentication is used. Run the script with the -h parameter to see online help.

To experiment with this configuration, run the script and then visit http://127.0.0.1:8080 in a browser.

Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).

test: build and run tests

This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.

lazy: serves tw5.com with lazily loaded images

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.

wbld: builds TiddlyWiki for TiddlyWeb

This script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.

2bld: builds TiddlyWiki 2.6.5

This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff is used for *nix, fc for Windows).

deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version number

These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.

\ No newline at end of file diff --git a/editions/tw5.com/tiddlers/hellothere/What happened to the original TiddlyWiki.tid b/editions/tw5.com/tiddlers/hellothere/What happened to the original TiddlyWiki.tid index 144c5820d..abc2223f2 100644 --- a/editions/tw5.com/tiddlers/hellothere/What happened to the original TiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/hellothere/What happened to the original TiddlyWiki.tid @@ -9,6 +9,6 @@ The original [[Classic|TiddlyWikiClassic]] version of TiddlyWiki is still availa http://classic.tiddlywiki.com. -Note that the [[current version|TiddlyWiki5]] of TiddlyWiki is not fully backwards compatible with TiddlyWikiClassic. Content can be imported but will need massaging to adapt to the new WikiText format. A ''tw2parser'' plugin is under development that will allow faithful display of most content created for TiddlyWikiClassic. +Note that the [[current version|TiddlyWiki5]] of TiddlyWiki is not fully backwards compatible with TiddlyWikiClassic. Content can be imported but will need massaging to adapt to the new WikiText format. A ''tw2parser'' plugin is under development that will allow faithful display of most content created for TiddlyWikiClassic: - +http://tiddlywiki.com/plugins/tiddlywiki/tw2parser/ diff --git a/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid index 63b5bca84..f7354359e 100644 --- a/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid +++ b/editions/tw5.com/tiddlers/mechanisms/UpgradeMechanism.tid @@ -21,18 +21,3 @@ tags: Mechanisms # Clicking "done" unpacks the selected tiddlers from the pending import tiddler # The pending import tiddler and the upgrade library tiddler are excluded from the subsequent save operation -! ToDo - -* Incoming tiddler preview -* ~~Better display text for plugins~~ -* ~~Better handling of encrypted upgrades~~ -* Docs -* ~~Add upgrade plugin containing instructions and one-shot UI~~ -* ~~Suppressing $:/UpgradeLibrary and upgrade plugin from save~~ -* ~~Checkboxes~~ -* ~~Visual difference for suppressed tiddlers~~ -* Translation of upgrade wizard - -! NoToDo - -* Grouping plugins - not possible without extending the core diff --git a/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid b/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid index bbb067085..e0b33bd25 100644 --- a/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid +++ b/editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid @@ -42,7 +42,7 @@ Or: ./bin/serve.cmd [edition dir] [username] [password] [host] [port] ``` -This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the `tw5.com-server` edition. By default, the Node.js serves on port 8080. If the optional `username` parameter is provided, it is used for signing edits. If the `password` is provided then HTTP basic authentication is used. +This script starts TiddlyWiki5 running as an HTTP server, defaulting to the content from the `tw5.com-server` edition. By default, the Node.js serves on port 8080. If the optional `username` parameter is provided, it is used for signing edits. If the `password` is provided then HTTP basic authentication is used. Run the script with the `-h` parameter to see online help. To experiment with this configuration, run the script and then visit `http://127.0.0.1:8080` in a browser. @@ -78,4 +78,3 @@ This script builds TiddlyWiki 2.6.5 from the original source and then displays t These scripts are concerned with releasing a new version of TiddlyWiki. See [[Releasing a new version of TiddlyWiki5]]. -