1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 03:57:21 +00:00

Docs update

Stuff had got quite out of date. Why is it so much easier to write code
than docs?
This commit is contained in:
Jeremy Ruston 2013-04-29 14:07:16 +01:00
parent 152fb798eb
commit 0d1598eaa1

View File

@ -1,7 +1,7 @@
tags: docs edition
modifier: JeremyRuston
modified: 201304291301
title: TiddlyWiki5 Node Edition
modified: 201304161918
modifier: JeremyRuston
tags: docs edition
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:
@ -47,14 +47,19 @@ The files output by `bld.sh` are:
* `index.html` TiddlyWiki5 standalone HTML file with content from the `tw5.com` edition
* `empty.html` TiddlyWiki5 standalone HTML file with no content
* `encrypted.html` TiddlyWiki5 standalone HTML file encrypted with the password `password`
* `test.html` TiddlyWiki5 browser-based test suite (see TestingMechanism)
* `static.html` static HTML version of the DefaultTiddlers of the `tw5.com` edition
* `static/*.html` and `static/static.css` static HTML versions of individual tiddlers
`bld.sh` also runs the TiddlyWiki5 node.js-based test suite (see TestingMechanism)
!!! `serve.sh` serves tw5.com
This batch file starts TiddlyWiki5 running as an HTTP server with the content from the `clientserver` edition. By default, the script serves on port 8080.
To experiment with this configuration, run the script and then visit `http://0.0.0.0:8080` in a browser. Currently changes do get synced to the server but the server doesn't yet save the changes back to the file system. Thus the best way to experiment with this edition is by visiting it in two different browsers, exploring how the changes made in one browser propogate to the other.
To experiment with this configuration, run the script and then visit `http://0.0.0.0: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).
!!! `wbld.sh` builds TiddlyWiki5 for TiddlyWeb