1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00

More docs updating

This commit is contained in:
Jeremy Ruston 2012-06-10 17:48:23 +01:00
parent cd824a350a
commit c677b4bddf
44 changed files with 142 additions and 40 deletions

File diff suppressed because one or more lines are too long

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

View File

@ -1,4 +0,0 @@
title: Command Line Sketch.jpg
modifier: JeremyRuston
type: image/jpeg
tags: picture

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

View File

@ -1,4 +0,0 @@
title: Main Screen Sketch.jpg
modifier: JeremyRuston
type: image/jpeg
tags: picture

View File

@ -1,4 +0,0 @@
title: SiteSubtitle
modifier: JeremyRuston
a reusable non-linear personal web notebook

View File

@ -1,4 +0,0 @@
title: SiteTitle
modifier: JeremyRuston
TiddlyWiki5

View File

@ -4,7 +4,7 @@ tags: docs internals
!! Overview
The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated MIME type, the engine can produce a rendering of the tiddler in a new MIME type. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
The most important transformations are from `text/x-tiddlywiki` wikitext into `text/html` or `text/plain` but the engine is used throughout the system for other transformations, such as converting images for display in HTML, sanitising fragments of JavaScript, and processing CSS.

View File

@ -1,7 +0,0 @@
title: TryingOutTiddlyWiki
tags: introduction
For trying TiddlyWiki5 out under node.js, two batch files are provided:
* `run.sh` runs the wikitests
* `bld.sh` builds the new TiddlyWiki 5 HTML file (placed in the `tmp/tw5/` directory by default)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

View File

@ -1,4 +0,0 @@
title: View Switcher Sketch.jpg
modifier: JeremyRuston
type: image/jpeg
tags: picture

View File

@ -0,0 +1,34 @@
title: DumpCommand
tags: docs command
!!! 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
}}}

View File

@ -0,0 +1,8 @@
title: LoadCommand
tags: docs command
Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files
{{{
--load <filepath>
}}}

View File

@ -0,0 +1,8 @@
title: SaveTiddlerCommand
tags: docs command
Save an individual tiddler as a specified ContentType, defaults to `text/html`
{{{
--savetiddler <title> <filename> [<type>]
}}}

View File

@ -0,0 +1,25 @@
title: ServerCommand
tags: docs command
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")

View File

@ -0,0 +1,8 @@
title: VerboseCommand
tags: docs command
Triggers verbose output, useful for debugging
{{{
--verbose
}}}

View File

@ -0,0 +1,8 @@
title: VersionCommand
tags: docs command
Displays the version number of TiddlyWiki.
{{{
--version
}}}

View File

@ -0,0 +1,10 @@
title: WikiTestCommand
tags: docs command
Run wikification tests against the tiddlers in the given directory. Include the `save` flag to save the test result files as the new targets.
{{{
--wikitest <dir> [save]
}}}
`--wikitest` looks for `*.tid` files in the specified folder. It then wikifies the tiddlers to both "text/plain" and "text/html" format and checks the results against the content of the `*.html` and `*.txt` files in the same directory.

View File

@ -9,4 +9,4 @@ The only field that is required is the {{{title}}} field, but useful tiddlers al
Hardcoded in the system is the knowledge that the `tags` field is a string array, and that the `modified` and `created` fields are JavaScript `Date` objects. All other fields are strings.
The {{{type}}} field identifies the representation of the tiddler text with a MIME type.
The {{{type}}} field identifies the representation of the tiddler text with a ContentType.

View File

@ -20,7 +20,7 @@ modifier: Jeremy
This is the text of my tiddler.
}}}
//The MIME type `application/x-tiddler` is used internally for these files//
//The ContentType `application/x-tiddler` is used internally for these files//
!! TiddlyWiki `<DIV>` .tiddler files
@ -42,16 +42,16 @@ Older `*.tiddler` files more closely matched the store format used by TiddlyWiki
<div tiddler="AnotherExampleStyleSheet" modifier="JeremyRuston" modified="200508181432" created="200508181432" tags="examples">This is an old-school .tiddler file, without an embedded &lt;pre&gt; tag.\nNote how the body is &quot;HTML encoded&quot; and new lines are escaped to \\n</div>
}}}
//The MIME type `application/x-tiddler-html-div` is used internally for these files//
//The ContentType `application/x-tiddler-html-div` is used internally for these files//
!! ~TiddlyWeb-style JSON files
These files are a straightforward array of hashmaps of name:value fields. Currently only these known fields are processed: `title`, `text`, `created`, `creator`, `modified`, `modifier`, `type` and `tags`.
//The MIME type `application/json` is used internally for these files//
//The ContentType `application/json` is used internally for these files//
!! TiddlyWiki HTML files
TiddlyWiki HTML files contain a collection of tiddlers encoded in `<DIV>` format.
//The MIME type `application/x-tiddlywiki` is used internally for these files//
//The ContentType `application/x-tiddlywiki` is used internally for these files//

View File

@ -0,0 +1,28 @@
title: Getting started with TiddlyWiki under node.js
modifier: JeremyRuston
tags: guide
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:
{{{
node core/boot.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html
}}}
!!Usage
Running `boot.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 commands are identified by the prefix `--`.
{{{
node core/boot.js [--<option> [<arg>[,<arg>]]]
}}}
!! Batch Files
For trying TiddlyWiki5 out under node.js, two batch files are provided:
* `run.sh` runs the wikitests
* `bld.sh` builds the new TiddlyWiki 5 HTML file (placed in the `tmp/tw5/` directory by default)
!!Commands
The following commands are available:

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

View File

@ -1,7 +1,7 @@
title: TypedBlockTests
tags: demo
title: TypedBlockWikiText
tags: docs wikitextrule
WikiText can include blocks of text that are rendered with an explicit MIME type like this:
WikiText can include blocks of text that are rendered with an explicit ContentType like this:
{{{
$$$application/javascript
@ -17,7 +17,7 @@ $$$application/javascript
var thing = 2 + "one";
$$$
It is also possible to abbreviate the MIME type to a file extension. For example:
It is also possible to abbreviate the ContentType to a file extension. For example:
{{{
$$$.svg

View File

@ -1,4 +1,4 @@
title: SiteSubtitle
type: text/x-tiddlywiki
modifier: JeremyRuston
a reusable non-linear personal web notebook

View File

@ -1,4 +1,4 @@
title: SiteTitle
type: text/x-tiddlywiki
modifier: JeremyRuston
TiddlyWiki5