From 070d919aa04d303b2ee47532da931da9130731ef Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Sat, 19 May 2012 11:28:44 +0100 Subject: [PATCH] Docs update --- readme.md | 2 +- tw5.com/tiddlers/HelloThere.tid | 2 ++ tw5.com/tiddlers/Introduction.tid | 1 + tw5.com/tiddlers/TiddlyWiki.tid | 8 ++++++-- 4 files changed, 10 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 0b816253bf..4112896568 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -

Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful node.js application.

TiddlyWiki5 is currently at version 5.0.0.a2 and is under active development, which is to say that it is useful but incomplete. You can try out the prototype at http://tiddlywiki.com/tiddlywiki5, get involved in the development on GitHub or the discussions on the TiddlyWikiDev Google Group.

Usage

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on RecipeFiles, TiddlerFiles and TiddlyWikiFiles.

Usage

+

Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful node.js application.

TiddlyWiki5 is currently at version 5.0.0.a2 and is under active development, which is to say that it is useful but incomplete. You can try out the prototype at http://tiddlywiki.com/tiddlywiki5, get involved in the development on GitHub or the discussions on the TiddlyWikiDev Google Group.

Introduction

Usage

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on RecipeFiles, TiddlerFiles and TiddlyWikiFiles.

Usage

node core/boot.js <options>
This boots the TiddlyWiki kernel and loads the core plugins. The wiki store is initially empty.

The command line options are processed sequentially from left to right. Processing pauses during long operations and then resumes with the next command line option in sequence.

The following options are available:
--load <filepath>Load tiddlers from 2.x.x TiddlyWiki files (.html), .tiddler, .tid, .json or other files
--savetiddler <title> <filename> [<type>]Save an individual tiddler as a specified MIME type, defaults to text/html
--wikitest <dir> [save]Run wikification tests against the tiddlers in the given directory. Include the save flag to save the test result files as the new targets
--dump tiddlersDump the titles of the tiddlers in the wiki store
--dump tiddler <title>Dump the fields of an individual tiddler
--dump shadowsDump the titles of the shadow tiddlers in the wiki store
--dump configDump the current core configuration
--verboseTriggers verbose output, useful for debugging

Examples

This example loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:
node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html diff --git a/tw5.com/tiddlers/HelloThere.tid b/tw5.com/tiddlers/HelloThere.tid index 1728878559..9416a59192 100644 --- a/tw5.com/tiddlers/HelloThere.tid +++ b/tw5.com/tiddlers/HelloThere.tid @@ -5,3 +5,5 @@ tags: Introduction Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful [[node.js application|What is node.js?]]. TiddlyWiki5 is currently at version <> and is under active development, which is to say that it is useful but incomplete. You can try out the prototype at http://tiddlywiki.com/tiddlywiki5, get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] or the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]]. + +[[Introduction]] \ No newline at end of file diff --git a/tw5.com/tiddlers/Introduction.tid b/tw5.com/tiddlers/Introduction.tid index 1d058c2162..d884a50f9d 100644 --- a/tw5.com/tiddlers/Introduction.tid +++ b/tw5.com/tiddlers/Introduction.tid @@ -18,6 +18,7 @@ Learning more about TiddlyWiki5: * Some very rough UserInterfaceSketches showing where it is heading Some useful tiddlers for feature testing: +* HelloThere * ImageTests showing different ways of embedding images * SampleData showing how JSON tiddlers are handled * SampleJavaScript and SampleJavaScriptWithError showing how JavaScript code is displayed diff --git a/tw5.com/tiddlers/TiddlyWiki.tid b/tw5.com/tiddlers/TiddlyWiki.tid index 53b4f51f8f..583c3ad868 100644 --- a/tw5.com/tiddlers/TiddlyWiki.tid +++ b/tw5.com/tiddlers/TiddlyWiki.tid @@ -2,6 +2,10 @@ title: TiddlyWiki modifier: JeremyRuston modified: 20120211110622 -TiddlyWiki is based on the idea of making information more useful by modelling it in the smallest meaningful semantic units, referred to as "tiddlers". Structure comes from links, tags, and stories (sequences of tiddlers). Tiddlers use a wikitext notation that concisely represents a wide range of text formatting and hypertext features. +TiddlyWiki is a rich, interactive interface for manipulating complex data with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors. -TiddlyWiki has earned an enduring role as a tool that people [[love using|Raves]] for its rich, interactive interface to manipulate complex data with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors. Because people can use it without needing any complicated server infrastructure, and because it is [[open source|What is open source?]], it has bought unprecedented freedom to people to keep their precious information under their own control. TiddlyWiki was originally created by JeremyRuston and is now a thriving [[open source|What is open source?]] project with a busy [[Community]] of independent developers. +TiddlyWiki is based on the idea of making information more useful by modelling it in the smallest meaningful semantic units, referred to as [[Tiddlers]]. Structure comes from links, tags, and sequences of tiddlers called stories. Tiddlers use a WikiText notation that concisely represents a wide range of text formatting and hypertext features. + +People [[love using|Raves]] TiddlyWiki. Because it can be used without any complicated server infrastructure, and because it is [[open source|What is open source?]], it has bought unprecedented freedom to people to keep their precious information under their own control. TiddlyWiki was originally created by JeremyRuston and is now a thriving [[open source|What is open source?]] project with a busy [[Community]] of independent developers. + +See TiddlyWikiArchitecture and [[Introduction]].