mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Jeremy Ruston 2013-06-02 23:18:07 +01:00
parent f743e09e7a
commit 1ea2af65b8
2 changed files with 38 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
editions/tw5.com/tiddlers/concepts/TiddlerFields.tid Normal file
View File

@ -0,0 +1,32 @@
modified: 201306011656
title: TiddlerFields
TiddlerFields are name:value pairs that make up a [[tiddler|Tiddlers]]. The standard fields are:
* `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
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)`)
* `description` - The description of a plugin
* `draft.of` - For draft tiddlers, contains the title of the tiddler of which this is a draft
* `draft.title` - For draft tiddlers, contains the proposed new title of the tiddler
* `footer` - The footer for a modal dialogue (interpreted as WikiText)
* `library` - Set to `yes` if the tiddler should be loaded in the browser as a `<script>` tag
* `name` - Human-readable name of a plugin
* `plugin` - Set to `yes` if the tiddler is a plugin
* `plugin-priority` - An integer giving the priority for loading plugin tiddlers
* `plugin-type` - The type of a plugin (currently can be `plugin` or `theme`)
* `source` - The original URL associated with a tiddler
* `subtitle` - The subtitle for a modal dialogue (interpreted as WikiText)
The TiddlyWebAdaptor uses a few more fields:
* `bag` - The name of the bag from which a tiddler came
* `revision` - The revision of the tiddler held at the server

8
editions/tw5.com/tiddlers/concepts/Tiddlers.tid
View File

@ -1,9 +1,10 @@
title: Tiddlers
tags: docs concepts
title: Tiddlers
modified: 201306010741
Tiddlers are the smallest unit of information in TiddlyWiki.
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. The behaviour and type of each field is determined by special TiddlerFieldModules.
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:
* `title` - The unique title of the tiddler
* `modified` - The date of the last modification to the tiddler
@ -12,3 +13,6 @@ Internally, tiddlers are an immutable dictionary of name:value pairs called fiel
* `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.