From 9093f04ba3c0c8eecaae49c2e648d25d98c51403 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Fri, 12 Sep 2014 16:54:32 +0100 Subject: [PATCH] Docs updates --- bin/readme.md | 3 +-- editions/tw5.com/tiddlers/hellothere/HelloThere.tid | 2 ++ .../tiddlers/workingwithtw/Downloading and saving.tid | 9 ++++++--- .../tiddlers/workingwithtw/Formatting text in TW.tid | 9 ++++++--- readme.md | 3 +-- 5 files changed, 16 insertions(+), 10 deletions(-) diff --git a/bin/readme.md b/bin/readme.md index e2529d032..472670edf 100644 --- a/bin/readme.md +++ b/bin/readme.md @@ -2,5 +2,4 @@ | +--+-- /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:

bld also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

serve: serves tw5.com

./bin/serve.sh <username> [<password>]

Or:

./bin/serve.cmd <username> [<password>]

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

To experiment with this configuration, run the script and then visit http://127.0.0.1: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).

test: build and run tests

This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.

lazy: serves tw5.com with lazily loaded images

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.

wbld: builds TiddlyWiki for TiddlyWeb

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

deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version number

These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5. -

\ No newline at end of file + +-- /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:

bld also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)

serve: serves tw5.com

./bin/serve.sh <username> [<password>]

Or:

./bin/serve.cmd <username> [<password>]

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

To experiment with this configuration, run the script and then visit http://127.0.0.1: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).

test: build and run tests

This script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.

lazy: serves tw5.com with lazily loaded images

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.

wbld: builds TiddlyWiki for TiddlyWeb

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

deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version number

These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.

\ No newline at end of file diff --git a/editions/tw5.com/tiddlers/hellothere/HelloThere.tid b/editions/tw5.com/tiddlers/hellothere/HelloThere.tid index ed9b862a8..984edc155 100644 --- a/editions/tw5.com/tiddlers/hellothere/HelloThere.tid +++ b/editions/tw5.com/tiddlers/hellothere/HelloThere.tid @@ -9,6 +9,8 @@ Welcome to ~TiddlyWiki, a versatile note-taking web application you can download You can use ~TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful [[Node.js application|TiddlyWiki on Node.js]] that stores each of your notes as a separate file. +> //Note that TiddlyWiki is currently in beta, with the full release scheduled for Saturday, September 20th 2014// + How can you make ~TiddlyWiki work for you? We recommend you start with our introductory documentation listed below, and then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just [[follow our simple instructions|GettingStarted]] and try it out for yourself! * [[Discover TiddlyWiki]] diff --git a/editions/tw5.com/tiddlers/workingwithtw/Downloading and saving.tid b/editions/tw5.com/tiddlers/workingwithtw/Downloading and saving.tid index ff38133a4..46f5bc376 100644 --- a/editions/tw5.com/tiddlers/workingwithtw/Downloading and saving.tid +++ b/editions/tw5.com/tiddlers/workingwithtw/Downloading and saving.tid @@ -1,4 +1,7 @@ -title: Downloading and saving +created: 20140908131600000 +modified: 20140912154917920 tags: [[Working with TiddlyWiki]] -created: 201409081316 -modified: 201409081316 +title: Downloading and saving +type: text/vnd.tiddlywiki + +forthcoming... \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/workingwithtw/Formatting text in TW.tid b/editions/tw5.com/tiddlers/workingwithtw/Formatting text in TW.tid index f20a7ebff..81c23a3fd 100644 --- a/editions/tw5.com/tiddlers/workingwithtw/Formatting text in TW.tid +++ b/editions/tw5.com/tiddlers/workingwithtw/Formatting text in TW.tid @@ -1,4 +1,7 @@ -title: Formatting text in TiddlyWiki +created: 20140908131500000 +modified: 20140912154933058 tags: [[Working with TiddlyWiki]] -created: 201409081315 -modified: 201409081315 +title: Formatting text in TiddlyWiki +type: text/vnd.tiddlywiki + +forthcoming... \ No newline at end of file diff --git a/readme.md b/readme.md index 75312b038..64c46fc69 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,2 @@ -

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed in a "non-linear" way, using tags, hyperlinks, and many other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one pre-set organizational structure.

You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful Node.js application that treats each of your notes as a separate file and accesses them through a central hub.

How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation, listed below, then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just follow our simple instructions and try it out for yourself!

Getting started with TiddlyWiki under Node.js

Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:

Installation

  1. Install Node.js from http://nodejs.org
  2. Open a command line terminal and type:

    npm install -g tiddlywiki

    If it fails with an error you may need to re-run the command as an administrator:

    npm install -g tiddlywiki (Windows)

    sudo npm install -g tiddlywiki (Mac/Linux)

  3. Check TiddlyWiki is installed by typing:

    tiddlywiki --version

  4. In response, you should see TiddlyWiki report its current version (eg 5.0.8-beta; you may also see other debugging information reported)
  5. Try it out:
    1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
    2. tiddlywiki mynewwiki --server to start TiddlyWiki
    3. Visit http://127.0.0.1:8080/ in your browser
    4. Try editing and creating tiddlers

The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.

A slightly different method for installation is recommended if you plan on forking the source code in order to study it or contribute to it. See Working with the TiddlyWiki5 repository. -

Usage

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

For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:

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

Running tiddlywiki 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 --.

tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]

The available commands are:

See also:

Upgrading

If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:

npm update -g tiddlywiki

On Mac or Linux you'll need to add sudo like this:

sudo npm update -g tiddlywiki

Working with the TiddlyWiki5 repository

This readme file was automatically generated by TiddlyWiki +

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed to be non-linear, structuring content with stories, tags, hyperlinks, and other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one preset organizational structure.

You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful Node.js application that stores each of your notes as a separate file.

Note that TiddlyWiki is currently in beta, with the full release scheduled for Saturday, September 20th 2014

How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation listed below, and then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just follow our simple instructions and try it out for yourself!

Getting started with TiddlyWiki under Node.js

Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:

For more information see:

Working with the TiddlyWiki5 repository

This readme file was automatically generated by TiddlyWiki

\ No newline at end of file