diff --git a/core/language/en-GB/ControlPanel.multids b/core/language/en-GB/ControlPanel.multids index 6df4fb76d..c58e34f12 100644 --- a/core/language/en-GB/ControlPanel.multids +++ b/core/language/en-GB/ControlPanel.multids @@ -64,9 +64,6 @@ Basics/Title/Prompt: Title of this ~TiddlyWiki: Basics/Username/Prompt: Username for signing edits: Basics/Version/Prompt: ~TiddlyWiki version: Plugins/Caption: Plugins -Plugins/Fields/Description: Description -Plugins/Fields/Title: Title -Plugins/Fields/Version: Version Plugins/Language/Prompt: Languages Plugins/Plugin/Prompt: Plugins Plugins/Theme/Prompt: Themes diff --git a/languages/de-DE/ControlPanel.multids b/languages/de-DE/ControlPanel.multids index 5364ed775..77d7e80c8 100644 --- a/languages/de-DE/ControlPanel.multids +++ b/languages/de-DE/ControlPanel.multids @@ -64,9 +64,6 @@ Basics/Title/Prompt: Titel dieses ~TiddlyWikis: Basics/Username/Prompt: Benutzer Signatur zum editieren: Basics/Version/Prompt: ~TiddlyWiki Version: Plugins/Caption: Plugins -Plugins/Fields/Description: Beschreibung -Plugins/Fields/Title: Titel -Plugins/Fields/Version: Version Plugins/Language/Prompt: Sprachen Plugins/Plugin/Prompt: Plugins Plugins/Theme/Prompt: Themen diff --git a/languages/fr-FR/ControlPanel.multids b/languages/fr-FR/ControlPanel.multids index dbf9c20e2..270af2c16 100644 --- a/languages/fr-FR/ControlPanel.multids +++ b/languages/fr-FR/ControlPanel.multids @@ -64,9 +64,6 @@ Basics/Title/Prompt: Titre de ce ~TiddlyWiki Basics/Username/Prompt: Signer les modifications avec ce nom d'utilisateur Basics/Version/Prompt: Numéro de version : Plugins/Caption: Plugins -Plugins/Fields/Description: Description -Plugins/Fields/Title: Titre -Plugins/Fields/Version: Version Plugins/Language/Prompt: Langues Plugins/Plugin/Prompt: Plugins Plugins/Theme/Prompt: Thèmes diff --git a/languages/it-IT/ControlPanel.multids b/languages/it-IT/ControlPanel.multids index d31ab1331..b6e4869de 100644 --- a/languages/it-IT/ControlPanel.multids +++ b/languages/it-IT/ControlPanel.multids @@ -37,9 +37,6 @@ Basics/Title/Prompt: Il titolo di questo ~TiddlyWiki: Basics/Username/Prompt: Digita il nome con cui firmare le modifiche: Basics/Version/Prompt: Versione di ~TiddlyWiki: Plugins/Caption: Plugins -Plugins/Fields/Description: Descrizione -Plugins/Fields/Title: Titolo -Plugins/Fields/Version: Versione Plugins/Language/Prompt: Linguaggi Plugins/Plugin/Prompt: Plugins Plugins/Theme/Prompt: Temi diff --git a/languages/ja-JP/ControlPanel.multids b/languages/ja-JP/ControlPanel.multids index 960bc31af..4bc9f1e8f 100644 --- a/languages/ja-JP/ControlPanel.multids +++ b/languages/ja-JP/ControlPanel.multids @@ -37,9 +37,6 @@ Basics/Title/Prompt: この ~TiddlyWiki のタイトル: Basics/Username/Prompt: 編集者として表示するユーザ名: Basics/Version/Prompt: ~TiddlyWiki バージョン: Plugins/Caption: プラグイン -Plugins/Fields/Description: 説明 -Plugins/Fields/Title: タイトル -Plugins/Fields/Version: バージョン Plugins/Language/Prompt: 言語 Plugins/Plugin/Prompt: プラグイン Plugins/Theme/Prompt: テーマ diff --git a/languages/zh-Hans/ControlPanel.multids b/languages/zh-Hans/ControlPanel.multids index 5877c14bc..022f17aad 100644 --- a/languages/zh-Hans/ControlPanel.multids +++ b/languages/zh-Hans/ControlPanel.multids @@ -64,9 +64,6 @@ Basics/Title/Prompt: 标题： Basics/Username/Prompt: 编辑者署名： Basics/Version/Prompt: ~TiddlyWiki 版本： Plugins/Caption: 插件 -Plugins/Fields/Description: 说明 -Plugins/Fields/Title: 标题 -Plugins/Fields/Version: 版本 Plugins/Language/Prompt: 语言 Plugins/Plugin/Prompt: 插件 Plugins/Theme/Prompt: 布景主题 diff --git a/languages/zh-Hant/ControlPanel.multids b/languages/zh-Hant/ControlPanel.multids index 6b2e42799..9febb47c8 100644 --- a/languages/zh-Hant/ControlPanel.multids +++ b/languages/zh-Hant/ControlPanel.multids @@ -64,9 +64,6 @@ Basics/Title/Prompt: 標題： Basics/Username/Prompt: 編輯者署名： Basics/Version/Prompt: ~TiddlyWiki 版本： Plugins/Caption: 插件 -Plugins/Fields/Description: 說明 -Plugins/Fields/Title: 標題 -Plugins/Fields/Version: 版本 Plugins/Language/Prompt: 語言 Plugins/Plugin/Prompt: 插件 Plugins/Theme/Prompt: 佈景主題 diff --git a/readme.md b/readme.md index 36724a392..6cba062fc 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

This is version 5.0.14-prerelease of TiddlyWiki, a major reboot designed for the next 25 years. It is currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.

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

TiddlyWikiClassic - http://classic.tiddlywiki.com

On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and "TiddlyWikiClassic" is used to identify the older version.

The deep internal improvements mean that the new version of TiddlyWiki is not fully compatible with TiddlyWikiClassic. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as the new version matures. +

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

This is version of TiddlyWiki, a major reboot designed for the next 25 years. It is currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.

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

TiddlyWikiClassic

The original "Classic" version of TiddlyWiki is still available at http://classic.tiddlywiki.com. Note that it is not fully backwards compatible: existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as the new version matures.

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

Setting Up

If you plan on working with the TiddlyWiki5 source code then follow these steps:

  1. Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5
  2. Clone a local copy of your fork
  3. Open a command line terminal and change the current working directory to the root of the repo
  4. Type npm link (Windows) or sudo npm link (Mac/Linux) to tell npm to use this copy of the repo as the globally installed one

After this procedure you can work with TiddlyWiki5 via npm as though it were installed in the usual way with npm install -g tiddlywiki.

See also Scripts for TiddlyWiki on Node.js.

This readme file was automatically generated by TiddlyWiki

\ No newline at end of file