1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-25 23:03:15 +00:00

Lotsa docs updates

This commit is contained in:
Jermolene 2013-11-29 17:20:10 +00:00
parent fe19909034
commit 3da17c8e04
21 changed files with 53 additions and 236 deletions

View File

@ -1,6 +1,6 @@
created: 20130822172800000
creator: JeremyRuston
modified: 20131129101043765
modified: 20131129163630584
modifier: JeremyRuston
tags: introduction
title: Features
@ -9,7 +9,7 @@ type: text/vnd.tiddlywiki
* The ability to save changes on almost any desktop HTML5 compatible-browser, with custom apps to enable [[Saving on iPad/iPhone]] and [[Android|How to use TiddlyWiki5 as a standalone HTML file with AndTidWiki]], and a cross-platform [[Firefox extension|Saving with TiddlyFox]] that even runs on Android
* [[Bitmap images|Motovun Jack.jpg]] and [[SVG images|UsingSVG]] are first-class citizens alongside text
* Concise and expressive WikiText that generates semantic HTML
* Integrated [[AES encryption|How to use TiddlyWiki5 as a standalone HTML file with encryption]]
* Integrated [[AES encryption|Saving with Encryption]]
* TiddlyWiki isn't just a wiki - you can build custom applications with it like this TaskManagementExample
* Familiar user interface elements like <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">wizards</$button> and <$button message="tw-notify" param="SampleNotification" class="btn btn-inverse">notifications</$button>
* Easily [[import|ImportTiddlers]] content via drag and drop, copy and paste, or browsing for local files

View File

@ -1,11 +1,11 @@
created: 20131129090249275
creator: JeremyRuston
modified: 20131129101018342
modified: 20131129171927975
modifier: JeremyRuston
title: GettingStarted
type: text/vnd.tiddlywiki
TiddlyWiki is highly flexible, and there are many different ways to use it. Here we're focussing on using it as a standalone file in the browser, which is a good choice for most users as it doesn't require any special knowledge or tools. For more options you can also run [[TiddlyWiki5 on Node.js]].
TiddlyWiki is highly flexible, and there are many different ways to use it. Here we're focusing on using it as a standalone file in the browser, which is a good choice for most users as it doesn't require any special knowledge or tools. For more options you can also run [[TiddlyWiki5 on Node.js]].
! The 'works anywhere' method
@ -13,7 +13,7 @@ TiddlyWiki is highly flexible, and there are many different ways to use it. Here
! The convenient and fast method
Saving changes as described above is quite a high friction process, and so this method is recommended for everyone who is able to use Mozilla's [[Firefox]] browser (including [[Firefox for Android]]).
Saving changes as described above is quite inconvenient because of the degree of manual intervention that browsers require. The following alternative method is recommended for everyone who is able to use Mozilla's [[Firefox]] browser (including [[Firefox for Android]]).
{{Saving with TiddlyFox}}

View File

@ -1,12 +1,12 @@
created: 20130822170200000
creator: JeremyRuston
modified: 20131128180705677
modified: 20131129163748286
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|How to use TiddlyWiki5 as a standalone HTML file]] 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|SingleFileApplication]] or as a powerful [[Node.js application|Node.js]].
<div class="tw-message-box">
<a class="tw-message-icon" href="http://tiddlywiki.com/" target="_blank">{{TiddlyWiki Classic.png}}</a>

View File

@ -1,21 +0,0 @@
created: 20130825145700000
creator: JeremyRuston
modified: 20131128181325694
modifier: JeremyRuston
tags: introduction
title: TiddlyWiki5 Editions
type: text/vnd.tiddlywiki
The core TiddlyWiki5 code is packaged into several distinct editions designed for different situations:
* [[TiddlyWiki5 Standalone Edition]] for working purely within the browser
** [[Using TiddlyFox|How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox]]
** [[Encrypting TiddlyWiki5|How to use TiddlyWiki5 as a standalone HTML file with encryption]]
** [[Using TWEdit on iPad and iPhone|How to use TiddlyWiki5 as a standalone HTML file with TWEdit]]
** [[Using TiddlyWiki5 with TiddlySpot|TiddlySpot]]
* [[TiddlyWiki5 Node Edition]] for advanced command line work
** Including [[TiddlyWiki5 Static Site Generation]]
** Including [[Building classic TiddlyWiki with TiddlyWiki5]]
* [[TiddlyWiki5 in the Sky for TiddlyWeb]] (and TiddlySpace)
* [[TiddlyWiki5 in the Sky for Dropbox]]

View File

@ -1,7 +1,11 @@
title: ModuleType
created: 20131129162847412
creator: JeremyRuston
modified: 20131129162908445
modifier: JeremyRuston
tags: concepts
modified: 201308091623
title: ModuleType
type: text/vnd.tiddlywiki
The `module-type` field of a [[JavaScript module|Modules]] is a string that identifies the type of the module.
See [[$:/ConfigInfo]] for a list of the module types used in this wiki.
See the ''Internals'' tab of the [[control panel|$:/ControlPanel]] for a list of the module types used in this wiki.

View File

@ -1,7 +1,11 @@
title: Modules
created: 20131129162919588
creator: JeremyRuston
modified: 20131129162935396
modifier: JeremyRuston
tags: concepts
modified: 201308091623
title: Modules
type: text/vnd.tiddlywiki
A //module// in TiddlyWiki5 is a tiddler containing executable JavaScript, of the type `application/javascript` and with the field `module-type` set to the ModuleType of the module.
See [[$:/ConfigInfo]] for details of the currently loaded modules.
See the ''Internals'' tab of the [[control panel|$:/ControlPanel]] for lists of the currently loaded modules.

View File

@ -1,14 +1,23 @@
created: 201308220806
created: 20130822080600000
creator: JeremyRuston
modified: 201308252130
modified: 20131129163429930
modifier: JeremyRuston
tags: concepts
title: SystemTags
type: text/vnd.tiddlywiki
System tags are used to give special behaviour to tiddlers:
* [[$:/tags/stylesheet]]: indicates that a tiddler should be applied as a CSS stylesheet
* [[$:/tags/ViewTemplate]]: indicates that a tiddler is a template that should be included in the ViewTemplate
* [[$:/tags/stylesheet]] to indicate that a tiddler should be applied as a CSS stylesheet
* [[$:/tags/TiddlerInfo]] for tiddler info panel tabs
* [[$:/tags/ControlPanel]] for control panel tabs
* [[$:/tags/SideBar]] for sidebar tabs
* [[$:/tags/MoreSideBar]] for tabs in the "more" sidebar
* [[$:/tags/ViewToolbar]] for the view mode tiddler toolbar
* [[$:/tags/EditTemplate]] for the edit template
* [[$:/tags/EditToolbar]] for the edit mode tiddler toolbar
* [[$:/tags/PageControls]] for the page control tools in the sidebar
* [[$:/tags/PageTemplate]] for the main page elements
! System tags in use

View File

@ -1,6 +1,6 @@
created: 20130825213300000
creator: JeremyRuston
modified: 20131128094009627
modified: 20131129162830410
modifier: JeremyRuston
tags: concepts
title: TiddlerFields
@ -41,4 +41,4 @@ The TiddlyWebAdaptor uses a few more fields:
|`bag` |BagField |{{$:/docs/fields/bag}} |
|`revision` |RevisionField |{{$:/docs/fields/revision}} |
See [[$:/ConfigInfo]] for details of the fields used in this wiki.
See the ''Internals'' tab of the [[control panel|$:/ControlPanel]] for details of the fields used in this wiki.

View File

@ -1,6 +1,6 @@
created: 20130822170700000
creator: JeremyRuston
modified: 20131128180936737
modified: 20131129163834730
modifier: JeremyRuston
tags: concepts
title: TiddlyWiki
@ -8,6 +8,6 @@ type: text/vnd.tiddlywiki
TiddlyWiki is a rich, interactive tool for manipulating complex data with structure that doesn't easily fit into conventional tools like spreadsheets or wordprocessors.
TiddlyWiki is designed to fit around your brain, helping you deal with the things that won't fit. The [[fundamental idea|Philosophy of TiddlyWiki]] is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be [[structured|Structuring TiddlyWiki]] with [[links|TiddlerLinks]], [[tags|Tags]], [[lists|ListField]] and [[macros|Macros]]. Tiddlers use a WikiText notation that concisely represents a wide range of text formatting and hypertext features. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
TiddlyWiki is designed to fit around your brain, helping you deal with the things that won't fit. The [[fundamental idea|Philosophy of Tiddlers]] is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be [[structured|Structuring TiddlyWiki]] with [[links|TiddlerLinks]], [[tags|Tags]], [[lists|ListField]] and [[macros|Macros]]. Tiddlers use a WikiText notation that concisely represents a wide range of text formatting and hypertext features. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.
People [[love using|Raves]] TiddlyWiki. Because it can be used without any complicated server infrastructure, and because it is [[open source|OpenSource]], 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|OpenSource]] project with a busy [[Community]] of independent developers.

View File

@ -1,81 +0,0 @@
created: 201308252145
creator: JeremyRuston
modified: 201311171740
modifier: AdrianSampaleanu
tags: edition
title: TiddlyWiki5 Node 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:
```
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|TiddlyWikiFolders]] 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:
<$list filter="[tag[command]sort[title]]">
!!! <$view field="title" format="link"/>
<$transclude />
</$list>

View File

@ -1,15 +0,0 @@
title: TiddlyWiki5 Standalone Edition
tags: edition
The standalone edition of TiddlyWiki5 is a single HTML file that contains both your content and the JavaScript code needed to provide a user interface for viewing and editting it. Your changes are preserved by generating an updated HTML file which can be saved in various ways, depending on your browser and configuration:
* Using the TiddlySpot upload service (or compatible)
* Using the Firefox extension TiddlyFox changes can be saved directly to the file system, so that your TiddlyWiki documents are updated in place
* Using the HTML `<a>` element letting the user manually save the modified file
** Recent browsers supporting the `download` attribute can automatically force the download at the cost of losing control of the location of the downloaded file
See these guides for different ways of using the standalone edition of TiddlyWiki5:
* [[How to use TiddlyWiki5 as a standalone HTML file]]
* [[How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox]]
* [[How to use TiddlyWiki5 as a standalone HTML file with encryption]]

View File

@ -1,20 +0,0 @@
title: How to use TiddlyWiki5 as a standalone HTML file with TWEdit
tags: howto
modified: 201305141919
The iPad/iPhone app ''TWEdit'' makes it possible to edit and save changes to TiddlyWiki5, including working offline without a network connection. [[Download it here|https://itunes.apple.com/gb/app/twedit/id409607956?mt=8]].
Instructions for use:
# Open TWEdit
# Touch the title in the centre of the toolbar in order
#* A text box should appear allowing you to enter a URL
# Enter the URL `http://five.tiddlywiki.com/empty.html`
# When the empty TiddlyWiki5 has loaded, touch the ''save'' icon (it's the second icon from the right on the top toolbar)
#* An alert box should appear allowing you to enter a local filename
# Enter the filename you wish to use for the document (ending with `.html`)
# Edit your TiddlyWiki as normal
# To save changes, click the ''save'' button in the sidebar
#* A confirmation message should appear at the upper right
//Note that TWEdit is published independently of TiddlyWiki//

View File

@ -1,20 +0,0 @@
created: 201308220803
creator: JeremyRuston
modified: 201310092150
modifier: JeremyRuston
tags: howto
title: How to use TiddlyWiki5 as a standalone HTML file
! On desktop browsers
# Right-click on this link to an empty TiddlyWiki5 file and select "Save Link" to save it to your hard drive:
#* http://five.tiddlywiki.com/empty.html
# Open the file in your browser
# Make some changes to it. For example:
#* Create new tiddlers by clicking the new tiddler "+" icon in the sidebar
#* Edit existing tiddlers by clicking the edit tiddler "pencil" icon at their upper right
# Save your changes by clicking the "download" icon in the sidebar. What happens next depends on your browser:
## Newer browsers will ask for confirmation and then begin downloading your newly modified TiddlyWiki file, placing it in the default `Downloads` directory.
##* See GoogleChromeTips for some suggestions to streamline this process
## For older browsers, TiddlyWiki displays a dialogue including a link that you need to right-click and save

View File

@ -1,21 +0,0 @@
created: 201310092150
creator: JeremyRuston
modified: 201310092150
modifier: JeremyRuston
tags: howto
title: How to use TiddlyWiki5 as a standalone HTML file with TiddlyFox
TiddlyFox is an extension for Mozilla Firefox that allows TiddlyWiki5 to save changes directly to the file system. It can be downloaded from:
https://addons.mozilla.org/en-US/firefox/addon/tiddlyfox/
# Right-click on this link to an empty TiddlyWiki5 file and select "Save Link" to save it to your hard drive:
#* http://five.tiddlywiki.com/empty.html
# Open the file in Firefox. If this is the first time you've used a file with this name and location you will see a confirmation dialogue from TiddlyFox
# Make some changes to it. For example:
#* Create new tiddlers by clicking the plus button in the sidebar
#* Edit existing tiddlers by clicking the edit button at their upper right
# Save your changes by clicking the `Save` button in the sidebar in the 'tools' tab
#* You should see a confirmation message appear at the upper right of the browser window
With TiddlyFox, your changes are directly applied to the original file that you opened in your browser.

View File

@ -1,15 +0,0 @@
created: 201308251609
creator: JeremyRuston
modified: 201308251609
modifier: JeremyRuston
tags: howto
title: How to use TiddlyWiki5 as a standalone HTML file with encryption
[[TiddlyWiki5 Standalone Edition]] allows content to be encrypted using the [[Stanford JavaScript Crypto Library]].
# Switch to the ''Tools'' tab in the sidebar and look for the words //This wiki is not encrypted// and a button labelled ''Set password''
# Click ''Set password''
# Type a password and click the ''Set'' button (or use the enter key)
# The control panel should now say //This wiki is encrypted// with buttons for changing and clearing the password
# Save the wiki using the button in the sidebar
# Optionally, open the saved file in a text editor and verify that your data is encrypted

View File

@ -1,13 +1,14 @@
created: 201308251542
created: 20130825154200000
creator: JeremyRuston
modified: 201311010906
modified: 20131129163653069
modifier: JeremyRuston
tags: mechanism
title: EncryptionMechanism
type: text/vnd.tiddlywiki
TiddlyWiki5 allows the entire content of a TiddlyWiki HTML file to be encrypted with the Stanford JavaScript Crypto Library. Opening an encrypted TiddlyWiki in the browser prompts for a password before decrypting and displaying the content.
For instructions on how to use TiddlyWiki5's encryption features, see [[How to use TiddlyWiki5 as a standalone HTML file with encryption]].
For instructions on how to use TiddlyWiki5's encryption features, see [[Saving with Encryption]].
The EncryptionMechanism is implemented with the following elements:

View File

@ -1,3 +0,0 @@
title: ClientServer Edition
This is the client server edition of TiddlyWiki5.

View File

@ -1,6 +1,6 @@
created: 20131129092753119
creator: JeremyRuston
modified: 20131129093227679
modified: 20131129170056537
modifier: JeremyRuston
tags: howto
title: Saving with TiddlyFox
@ -17,7 +17,7 @@ type: text/vnd.tiddlywiki
## You may rename it, but be sure to keep the `.html` extension
# Open the file in [[Firefox]]
# Click ''OK'' in response to the prompt from TiddlyFox that asks whether to enable saving for this file
# Try creating a new tiddler using the ''plus'' button in the sidebar. Type some content for the tiddler, and click the ''tick'' button
# Save your changes by clicking the ''download'' button in the sidebar
# Try creating a new tiddler using the ''plus'' {{$:/core/images/new-button}} button in the sidebar. Type some content for the tiddler, and click the {{$:/core/images/done-button}} ''tick'' button
# Save your changes by clicking the {{$:/core/images/save-button}} ''download'' button in the sidebar
#* Look for the yellow notification ''Saved wiki'' at the top right of the window
# Refresh the browser window to verify that your changes have been saved correctly

View File

@ -1,6 +1,6 @@
created: 20131129092604900
creator: JeremyRuston
modified: 20131129093507691
modified: 20131129170043809
modifier: JeremyRuston
tags: howto
title: Saving with the HTML5 fallback saver
@ -14,10 +14,10 @@ This method of saving changes is clunky but has the advantage of working on almo
# Locate the file you just downloaded
## You may rename it, but be sure to keep the `.html` extension
# Open the file in your browser
# Try creating a new tiddler using the ''plus'' button in the sidebar. Type some content for the tiddler, and click the ''tick'' button
# Save your changes by clicking the ''download'' button in the sidebar
# Try creating a new tiddler using the ''plus'' {{$:/core/images/new-button}} button in the sidebar. Type some content for the tiddler, and click the {{$:/core/images/done-button}} ''tick'' button
# Save your changes by clicking the {{$:/core/images/save-button}} ''download'' button in the sidebar
# Your browser will download a new copy of the wiki incorporating your changes
# Locate the newly downloaded file and open it in your browser
# Refresh the browser window to verify that your changes have been saved correctly
# Verify that your changes have been saved correctly
''Tip'': most browsers have an option to prompt each time for the download location. This allows you to select the existing version of the file and replace it.

View File

@ -1,4 +0,0 @@
color: royalblue
modified: 201306131058
title: edition

File diff suppressed because one or more lines are too long