1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 09:00:27 +00:00

Lots of docs updates

This commit is contained in:
Jeremy Ruston 2013-08-30 20:06:23 +01:00
parent 2c9ea3ebf4
commit c4d7401f02
17 changed files with 152 additions and 60 deletions

3
core/docs/fields/bag.tid Normal file
View File

@ -0,0 +1,3 @@
title: $:/docs/fields/bag
The name of the bag from which a tiddler came

View File

@ -0,0 +1,3 @@
title: $:/docs/fields/created
The date a tiddler was created

View File

@ -0,0 +1,3 @@
title: $:/docs/fields/creator
The name of the person who created a tiddler

View File

@ -0,0 +1,3 @@
title: $:/docs/fields/draft.of
For draft tiddlers, contains the title of the tiddler of which this is a draft

View File

@ -0,0 +1,3 @@
title: $:/docs/fields/draft.title
For draft tiddlers, contains the proposed new title of the tiddler

View File

@ -0,0 +1,3 @@
title: $:/docs/fields/revision
The revision of the tiddler held at the server

View File

@ -1,5 +1,7 @@
title: $:/core/ui/ToolsPanel title: $:/core/ui/ToolsPanel
[[Wiki Info|$:/WikiInfo]]
--- ---
{{$:/snippets/viewswitcher}} {{$:/snippets/viewswitcher}}

6
core/wiki/WikiInfo.tid Normal file
View File

@ -0,0 +1,6 @@
title: $:/WikiInfo
* Tiddlers: <$count filter="[!is[system]]"/>
* System tiddlers: <$count filter="[is[system]]"/>
* Shadow tiddlers: <$count filter="[is[shadow]]"/>
** Over-ridden shadow tiddlers: <$count filter="[!is[system]is[shadow]]"/>

View File

@ -1,38 +1,41 @@
created: 201308252133 created: 201308252133
creator: JeremyRuston creator: JeremyRuston
modified: 201308252133 modified: 201308300902
modifier: JeremyRuston modifier: JeremyRuston
tags: concepts tags: concepts
title: TiddlerFields title: TiddlerFields
TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The standard fields are: TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The standard fields are:
* `title` - The unique title of the tiddler |!Field Name |!Reference |!Description |
* `modified` - The date of the last modification to the tiddler |`title` |TitleField |{{$:/docs/fields/title}} |
* `modifier` - The name of the last person to modify the tiddler |`modified` |ModifiedField |{{$:/docs/fields/modified}} |
* `created` - The date the tiddler was created |`modifier` |ModifierField |{{$:/docs/fields/modifier}} |
* `creator` - The name of the person who created the tiddler |`created` |CreatedField |{{$:/docs/fields/created}} |
* `tags` - A list of tags applied to the tiddler |`creator` |CreatorField |{{$:/docs/fields/creator}} |
* `type` - The ContentType that should used to interpret the content of the tiddler |`tags` |TagsField |{{$:/docs/fields/tags}} |
* `list` - A list of tiddler titles |`type` |TypeField |{{$:/docs/fields/type}} |
|`list` |ListField |{{$:/docs/fields/list}} |
Other fields used by the core are: Other fields used by the core are:
* `color` - The colour associated with a tiddler (expressed as a valid CSS value like `#fea` or `rgb(100,100,100)`) |!Field Name |!Reference |!Description |
* `description` - The description of a plugin |`color` |ColorField |{{$:/docs/fields/color}} |
* `draft.of` - For draft tiddlers, contains the title of the tiddler of which this is a draft |`description` |DescriptionField |{{$:/docs/fields/description}} |
* `draft.title` - For draft tiddlers, contains the proposed new title of the tiddler |`draft.of` |DraftOfField |{{$:/docs/fields/draft.of}} |
* `footer` - The footer for a modal dialogue (interpreted as WikiText) |`draft.title` |DraftTitleField |{{$:/docs/fields/draft.title}} |
* `library` - Set to `yes` if the tiddler should be loaded in the browser as a `<script>` tag |`footer` |FooterField |{{$:/docs/fields/footer}} |
* `name` - Human-readable name of a plugin |`library` |LibraryField |{{$:/docs/fields/library}} |
* `plugin-priority` - An integer giving the priority for loading plugin tiddlers |`name` |NameField |{{$:/docs/fields/name}} |
* `plugin-type` - The type of a plugin (currently can be `plugin` or `theme`) |`plugin-priority` |PluginPriorityField |{{$:/docs/fields/plugin-priority}} |
* `source` - The original URL associated with a tiddler |`plugin-type` |PluginTypeField |{{$:/docs/fields/plugin-type}} |
* `subtitle` - The subtitle for a modal dialogue (interpreted as WikiText) |`source` |SourceField |{{$:/docs/fields/source}} |
|`subtitle` |SubtitleField |{{$:/docs/fields/subtitle}} |
The TiddlyWebAdaptor uses a few more fields: The TiddlyWebAdaptor uses a few more fields:
* `bag` - The name of the bag from which a tiddler came |!Field Name |!Reference |!Description |
* `revision` - The revision of the tiddler held at the server |`bag` |BagField |{{$:/docs/fields/bag}} |
|`revision` |RevisionField |{{$:/docs/fields/revision}} |
See [[$:/ConfigInfo]] for details of the fields used in this wiki. See [[$:/ConfigInfo]] for details of the fields used in this wiki.

View File

@ -1,6 +1,6 @@
created: 201308270800 created: 201308270800
creator: JeremyRuston creator: JeremyRuston
modified: 201308270800 modified: 201308300906
modifier: JeremyRuston modifier: JeremyRuston
tags: concepts tags: concepts
title: TiddlerFilters title: TiddlerFilters
@ -60,10 +60,11 @@ The operator defaults to `title` if omitted, so `[[HelloThere]]` is equivalent t
The operands available with the `is` operator are: The operands available with the `is` operator are:
* ''system'': selects all system tiddlers * ''system'': selects all SystemTiddlers
* ''shadow'': selects all ShadowTiddlers
* ''current'': selects the current ContextTiddler * ''current'': selects the current ContextTiddler
* ''missing'': selects all missing tiddlers * ''missing'': selects all MissingTiddlers
* ''orphan'': selects all orphan tiddlers * ''orphan'': selects all OrphanTiddlers
! Indirect Operands ! Indirect Operands

View File

@ -1,21 +1,10 @@
created: 201308252135 created: 201308252135
creator: JeremyRuston creator: JeremyRuston
modified: 201308252135 modified: 201308300907
modifier: JeremyRuston modifier: JeremyRuston
tags: concepts tags: concepts
title: Tiddlers title: Tiddlers
Tiddlers are the smallest unit of information in TiddlyWiki. They can be structured with [[links|TiddlerLinks]] and tags. Tiddlers are the smallest unit of information in TiddlyWiki. They can be structured with [[links|TiddlerLinks]] and tags.
Internally, tiddlers are an immutable dictionary of name:value pairs called fields. The only field that is required is the `title` field, but useful tiddlers also have a `text` field, and some or all of the standard fields listed below: Internally, tiddlers are an immutable dictionary of name:value pairs called fields. The only field that is required is the `title` field, but useful tiddlers also have a `text` field, and some or all of the standard fields listed in TiddlerFields.
* `title` - The unique title of the tiddler
* `modified` - The date of the last modification to the tiddler
* `modifier` - The name of the last person to modify the tiddler
* `created` - The date the tiddler was created
* `creator` - The name of the person who created the tiddler
* `tags` - A list of tags applied to the tiddler
* `type` - The ContentType that should used to interpret the content of the tiddler
See TiddlerFields for a complete list of fields used in TiddlyWiki5.

View File

@ -1,6 +1,6 @@
created: 201308252142 created: 201308252142
creator: JeremyRuston creator: JeremyRuston
modified: 201308281907 modified: 201308300920
modifier: JeremyRuston modifier: JeremyRuston
tags: dev tags: dev
title: TiddlyWikiFolders title: TiddlyWikiFolders
@ -11,13 +11,13 @@ As well as traditional single file wikis, TiddlyWiki5 [[under node.js|TiddlyWiki
Wiki folders can contain the following files and folders: Wiki folders can contain the following files and folders:
* ''tiddlywiki.info'' - JSON file containing metadata for the wiki
* ''\tiddlers'' - folder containing tiddler files comprising the wiki * ''\tiddlers'' - folder containing tiddler files comprising the wiki
* ''\plugins'' - folder containing [[plugin folders|PluginMechanism]] to be included in the wiki * ''\plugins'' - folder containing [[plugin folders|PluginMechanism]] to be included in the wiki
* ''tiddlywiki.info'' - JSON file containing metadata for the wiki. See below
Only the ''tiddlywiki.info'' file is required, the ''tiddlers'' and ''plugins'' folders are optional. Any files and folders not listed above are ignored. Only the ''tiddlywiki.info'' file is required, the ''tiddlers'' and ''plugins'' folders are optional. Any files and folders not listed above are ignored.
! Content of `tiddlywiki.info` !! Content of `tiddlywiki.info` file
The `tiddlywiki.info` file in a wiki folder contains a JSON object comprising the following fields: The `tiddlywiki.info` file in a wiki folder contains a JSON object comprising the following fields:
@ -44,3 +44,40 @@ For example:
] ]
} }
``` ```
!! Content of `tiddlers` folder
All the TiddlerFiles in the `tiddlers` folder are read into the wiki at startup. Sub-folders are scanned recursively for TiddlerFiles.
Sub-folders within the `tiddlers` folder can also be given a `tiddlywiki.files` JSON file that overrides the default processing for that folder. The file format is illustrated with this example from the D3 plugin:
```
{
"tiddlers": [
{
"file": "d3.min.js",
"fields": {
"type": "application/javascript",
"title": "$:/plugins/tiddlywiki/d3/d3.js",
"module-type": "library"
},
"prefix": "var d3;if($tw.browser){\n",
"suffix": "}\nexports.d3 = d3;\n"
},
{
"file": "cloud/d3.layout.cloud.js",
"fields": {
"type": "application/javascript",
"title": "$:/plugins/tiddlywiki/d3/d3.layout.cloud.js",
"module-type": "library"
}
}
]
}
```
The JSON data consists of an object with a `tiddlers` property that contains an array of information about each tiddler to be loaded into the wiki. That information consists of:
* `file`: the relative or absolute path to the file to include
* `fields`: an object containing fields that override any provided in the tiddler file
* `prefix` & `suffix`: (optional) specify strings to be prefixed and suffixed to the tiddler file text content

View File

@ -0,0 +1,12 @@
created: 201308300925
creator: JeremyRuston
modified: 201308300927
modifier: JeremyRuston
tags: fields
title: ListField
The `list` [[field of a tiddler|TiddlerFields]] is an optional feature that can be used to help structure your content. It is defined as an ordered sequence of tiddler titles, and it can be used in several ways:
* The `list` [[filter|TiddlerFilters]] selects the entries from a list
* The `listed` [[filter|TiddlerFilters]] selects the tiddlers that list the selected tiddler(s)
* The NavigatorWidget manipulates a StoryList tiddler containing a `list` field of the tiddlers that are displayed in the main story column

View File

@ -0,0 +1,10 @@
created: 201308300842
creator: JeremyRuston
modified: 201308300842
modifier: JeremyRuston
tags: definitions
title: TiddlySpace
TiddlySpace is an environment for discourse on the web, built from TiddlyWeb.
TiddlySpace was originally sponsored by [[Osmosoft]] at [[BT]].

View File

@ -0,0 +1,14 @@
created: 201308300841
creator: JeremyRuston
modified: 201308300843
modifier: JeremyRuston
tags: definitions
title: TiddlyWeb
TiddlyWeb is a server application that puts [[Tiddlers]] on the web:
http://tiddlyweb.com/
TiddlyWeb can be used to host TiddlyWiki and TiddlyWiki5 wikis, making the individual tiddlers available over a flexible HTTP API.
TiddlyWeb was originally sponsored by [[Osmosoft]] at [[BT]] (along with TiddlySpace).

View File

@ -1,6 +1,6 @@
created: 201308241419 created: 201308241419
creator: JeremyRuston creator: JeremyRuston
modified: 201308241419 modified: 201308300837
modifier: JeremyRuston modifier: JeremyRuston
tags: widget tags: widget
title: ListWidget title: ListWidget
@ -10,7 +10,7 @@ This is the tiddler called [[Blah-$title$]]
\end \end
! Introduction ! Introduction
The list widget displays a sequence of tiddlers that match a TiddlerFilter. It can be used for many purposes: The list widget displays a sequence of tiddlers that match a [[tiddler filter|TiddlerFilters]]. It can be used for many purposes:
* Displaying custom lists of links, like in TiddlyWiki5's sidebar * Displaying custom lists of links, like in TiddlyWiki5's sidebar
* Custom lists, such as "all tiddlers tagged 'task' that are not tagged 'done'" * Custom lists, such as "all tiddlers tagged 'task' that are not tagged 'done'"

View File

@ -109,11 +109,11 @@ http://0.0.0.0:8080</code> in a browser.</p><p>
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).</p><h3 class=''> 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).</p><h3 class=''>
<code> <code>
wbld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> wbld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'> TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>
TiddlyWeb</a></h3><p> TiddlyWeb</a></h3><p>
This batch file builds and deploys the code for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5%20in%20the%20Sky%20for%20TiddlyWeb.html'> This batch file builds and deploys the code for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5%20in%20the%20Sky%20for%20TiddlyWeb.html'>
TiddlyWiki5 in the Sky for TiddlyWeb</a>. If you want to experiment with your own builds of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> TiddlyWiki5 in the Sky for TiddlyWeb</a>. If you want to experiment with your own builds of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'> TiddlyWiki5</a> for <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>
TiddlyWeb</a> you could use this batch file as a base.</p><h3 class=''> TiddlyWeb</a> you could use this batch file as a base.</p><h3 class=''>
<code> <code>
2bld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'> 2bld.sh</code> builds <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki.html'>
@ -201,7 +201,7 @@ ServerCommand</a></span></h3><div>
<div class='tw-transclude'> <div class='tw-transclude'>
<p> <p>
The server built in to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> The server built in to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> is very simple. Although compatible with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'> TiddlyWiki5</a> is very simple. Although compatible with <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWeb.html'>
TiddlyWeb</a> it doesn't support many of the features needed for robust Internet-facing usage - in particular, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'> TiddlyWeb</a> it doesn't support many of the features needed for robust Internet-facing usage - in particular, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='http://five.tiddlywiki.com/static/TiddlyWiki5.html'>
TiddlyWiki5</a> is an old-school wiki in the sense that it offers no authentication.</p><p> TiddlyWiki5</a> is an old-school wiki in the sense that it offers no authentication.</p><p>
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 <code> 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 <code>