From 81bcb1548f3123a189c7f3489548a8115f516d94 Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Fri, 1 Mar 2013 16:29:11 +0000 Subject: [PATCH] Docs updates --- editions/tw5.com/tiddlers/ReadMe.tid | 2 +- ..._started_with_TiddlyWiki_under_node.js.tid | 5 +- readme.md | 79 +++++++++++++++++-- 3 files changed, 77 insertions(+), 9 deletions(-) diff --git a/editions/tw5.com/tiddlers/ReadMe.tid b/editions/tw5.com/tiddlers/ReadMe.tid index 80721f802..33b86b4dd 100644 --- a/editions/tw5.com/tiddlers/ReadMe.tid +++ b/editions/tw5.com/tiddlers/ReadMe.tid @@ -5,7 +5,7 @@ tags: introduction {{HelloThere}} -! Usage +! Getting started with TiddlyWiki under node.js {{Getting started with TiddlyWiki under node.js}} diff --git a/editions/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid b/editions/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid index 71ca7a93c..3b5b85389 100644 --- a/editions/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid +++ b/editions/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid @@ -30,4 +30,7 @@ For trying TiddlyWiki5 out under node.js, several batch files are provided: The following commands are available: -{{{ [tag[command]sort[title]] }}} +<$list filter="[tag[command]sort[title]]"> + !!! <$view field="title" format="link"/> + <$view field="text" format="wikified"/> + diff --git a/readme.md b/readme.md index c0495cc1d..462c85de5 100644 --- a/readme.md +++ b/readme.md @@ -24,7 +24,8 @@ Join the discussions on @TiddlyWiki on Twitter for the latest news

-Usage

+Getting started with +TiddlyWiki under node.js

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, @@ -54,29 +55,93 @@ Commands

The following commands are available:

+

-DumpCommand

+DumpCommand
+
+

+dump tiddlers

+Dump the titles of the tiddlers in the wiki store 

+--dump tiddlers

+dump tiddler

+Dump the fields of an individual tiddler 

+--dump tiddler <title>

+dump shadows

+Dump the titles of the shadow tiddlers in the wiki store 

+--dump shadows

+dump config

+Dump the current core configuration 

+--dump config
+

-LoadCommand

+LoadCommand
+
+

+Load tiddlers from 2.x.x +TiddlyWiki files ( +.html), +.tiddler, +.tid, +.json or other files 

+--load <filepath>
+

-SaveTiddlerCommand

+SaveTiddlerCommand
+
+

+Save an individual tiddler as a specified +ContentType, defaults to +text/html 

+--savetiddler <title> <filename> [<type>]
+

-ServerCommand

+ServerCommand
+
+

+The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for +GET, +PUT and +DELETE.

+--server <port> <roottiddler> <rendertype> <servetype>

+For example:

+--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html

+The parameters are:

+--server <port> <roottiddler> <rendertype> <servetype>
    +
  • + +port - port number to serve from (defaults to "8080")
  • + +roottiddler - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html")
  • + +rendertype - the content type to which the root tiddler should be rendered (defaults to "text/plain")
  • + +servetype - the content type with which the root tiddler should be served (defaults to "text/html")
+

-VerboseCommand

+VerboseCommand
+
+

+Triggers verbose output, useful for debugging 

+--verbose
+

-VersionCommand

+VersionCommand

+
+

+Displays the version number of +TiddlyWiki.

+--version

This readme file was automatically generated by