From 5ce112d4317fb330f97edbaf5e81330d578d8636 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Tue, 26 Nov 2013 22:47:27 +0000 Subject: [PATCH] Docs updates --- editions/tw5.com/tiddlers/Community.tid | 15 +++++++++++++-- editions/tw5.com/tiddlers/HelloThere.tid | 19 +++++++++---------- .../tw5.com/tiddlers/HelpingTiddlyWiki.tid | 16 +++++----------- readme.md | 3 ++- 4 files changed, 29 insertions(+), 24 deletions(-) diff --git a/editions/tw5.com/tiddlers/Community.tid b/editions/tw5.com/tiddlers/Community.tid index bb8e5fd6c..9a9402acb 100644 --- a/editions/tw5.com/tiddlers/Community.tid +++ b/editions/tw5.com/tiddlers/Community.tid @@ -1,11 +1,22 @@ -created: 201309091516000 +created: 20130909151600000 creator: JeremyRuston -modified: 201311221855003 +modified: 20131126195933719 modifier: JeremyRuston tags: community title: Community type: text/vnd.tiddlywiki +TiddlyWiki is made much more useful by its vibrant community of users and OpenSource developers. + +! Community Forums + +The TiddlyWiki discussion groups are mailing lists for talking about TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. + +* The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki +* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev +* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news +* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] + ! Resources for TiddlyWiki5 * [[TW5 Mall|http://www.giffmex.org/tw5mall.htm]] -- DaveGifford's growing catalogue of hints and tips diff --git a/editions/tw5.com/tiddlers/HelloThere.tid b/editions/tw5.com/tiddlers/HelloThere.tid index 60c3b612f..c0a71da16 100644 --- a/editions/tw5.com/tiddlers/HelloThere.tid +++ b/editions/tw5.com/tiddlers/HelloThere.tid @@ -1,18 +1,17 @@ -created: 201308221702000 +created: 20130822170200000 creator: JeremyRuston -modified: 201311171740 -modifier: AdrianSampaleanu +modified: 20131126220042886 +modifier: JeremyRuston tags: introduction title: HelloThere type: text/vnd.tiddlywiki -Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful [[Node.js application|Node.js]]. +Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a [[single HTML file in the browser|How to use TiddlyWiki5 as a standalone HTML file]] or as a powerful [[Node.js application|Node.js]]. -This is TiddlyWiki5 version //<>//. It is drawing to the end of the alpha phase, meaning it is almost ready for everyday use. It is a great time to get involved and support its [[future development|RoadMap]]: +
+{{TiddlyWiki Classic.png}}The deep internal changes mean that TiddlyWiki5 is not fully compatible with previous versions with different plugins, themes and so on. Content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5. -* Explore its features online at http://five.tiddlywiki.com/ -* Join the discussions on [[the TiddlyWikiDev Google Group|http://groups.google.com/group/TiddlyWikiDev]] -* Get involved in the [[development on GitHub|https://github.com/Jermolene/TiddlyWiki5]] -* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news +The original TiddlyWiki Classic is still available at http://tiddlywiki.com/. +
-//TiddlyWiki is a free, open source project that depends on [[your love and support|HelpingTiddlyWiki]] for its survival// +This is TiddlyWiki5 version ''<>'' (see the detailed ReleaseHistory and the RoadMap for getting to the full release). It is a great time to get involved and support the future development of TiddlyWiki5. //TiddlyWiki is a free, open source project that depends on [[your love and support|HelpingTiddlyWiki]] for its survival//. diff --git a/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid b/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid index 2030932ea..ef1635423 100644 --- a/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/HelpingTiddlyWiki.tid @@ -1,27 +1,21 @@ -created: 201308251605 +created: 20130825160500000 creator: JeremyRuston -modified: 201308281850 +modified: 20131126195146799 modifier: JeremyRuston tags: community title: HelpingTiddlyWiki +type: text/vnd.tiddlywiki If you find TiddlyWiki useful, there are lots of ways you can help assure its future and make it better. -! 1. Teach and Tell +! Teach and Tell OpenSource projects like TiddlyWiki thrive on the feedback and engagement of users. TiddlyWiki becomes more useful to everyone as more and more people use it. So, if you find TiddlyWiki useful, spread the word. The best possible way to assure its future is for it to become a hundred times more popular than before. * [[Tweet about TiddlyWiki|https://twitter.com/intent/tweet?text=I+love+TiddlyWiki+because...&source=tiddlywiki5]] * [[Star the TiddlyWiki5 GitHub Repository|https://github.com/Jermolene/TiddlyWiki5/star]] -! 2. Join the discussion - -There's lively discussion about TiddlyWiki in the Google Groups: - -* The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki -* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev - -! 3. Improve the documentation and code +! Help improve the documentation and code The main TiddlyWiki documentation and code lives on GitHub, and welcomes [[contributions|Contributing]]: diff --git a/readme.md b/readme.md index 0778c10b1..78ea7fac2 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ -

Welcome to TiddlyWiki5

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

This is TiddlyWiki5 version 5.0.0-alpha.16-prerelease. It is drawing to the end of the alpha phase, meaning it is almost ready for everyday use. It is a great time to get involved and support its future development:

TiddlyWiki is a free, open source project that depends on your love and support for its survival +

Welcome to TiddlyWiki5

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

The deep internal changes mean that TiddlyWiki5 is not fully compatible with previous versions with different plugins, themes and so on. Content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5.

The original TiddlyWiki Classic is still available at http://tiddlywiki.com/. +

This is TiddlyWiki5 version 5.0.0-alpha.16-prerelease (see the detailed ReleaseHistory and the RoadMap for getting to the full release). It is a great time to get involved and support the future development of TiddlyWiki5. TiddlyWiki is a free, open source project that depends on your love and support for its survival.

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, 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:

node tiddlywiki.js --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html

In order to use TiddlyWiki5 on the command line you must first install node.js from http://nodejs.org/

Usage

Running tiddlywiki.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 first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.

The commands and their individual arguments follow, each command being identified by the prefix --.

node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]

Script Files

For trying TiddlyWiki5 out under Node.js, several scripts are provided (.sh for *nix and .cmd for Windows):

bld: builds tw5.com

This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.

By default, files are output to a folder called jermolene.github.com, sibling to the TiddlyWiki5 source directory. For example:

/TiddlyWork/ - Directory for working with TiddlyWiki5
 	/TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
 	/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 bld.

The files output by bld are:

  • readme.md main readme file, output to the TiddlyWiki5 directory
  • 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 also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

serve.sh <username> or serve.cmd <username>: serves tw5.com

This script starts TiddlyWiki5 running as an HTTP server with the content from the clientserver edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits.

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: builds TiddlyWiki5 for TiddlyWeb

This script builds and deploys the code for TiddlyWiki5 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).

Commands

The following commands are available:

LoadCommand

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

--load <filepath>

PasswordCommand

Set a password for subsequent crypto operations

--password <password>

PrintCommand

The print command outputs specified information.

print tiddlers

Output the titles of the tiddlers in the wiki store

--print tiddlers

print tiddler

Print the fields of an individual tiddler 

--print tiddler <title>

print system

Print the titles of the system tiddlers in the wiki store 

--print system

print config

Print the current core configuration 

--print config

RenderTiddlerCommand

Render an individual tiddler as a specified ContentType, defaults to text/html and save it to the specified filename 

--rendertiddler <title> <filename> [<type>]

RenderTiddlersCommand

Render a set of tiddlers matching a filter to separate files of a specified ContentType (defaults to text/html) and extension (defaults to .html).

--rendertiddlers <filter> <template> <pathname> [<type>] [<extension>]

For example:

--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain

ServerCommand

The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication.

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> <username>

The parameters are:

  • 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")
  • username - the default username for signing edits

For example:

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

VerboseCommand

Triggers verbose output, useful for debugging 

--verbose

VersionCommand

Displays the version number of TiddlyWiki.

--version

This readme file was automatically generated by TiddlyWiki5