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 2012-06-19 08:56:45 +01:00
parent 381d0715e9
commit ab808b3272
4 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tw5.com/tiddlers/TextReference.tid Normal file
View File

@ -0,0 +1,12 @@
title: TextReference
tags: docs concepts
A TextReference identifies a chunk of text from a tiddler that can be retrieved or modified depending on the context.
TextReferences are made up of several parts, most of which can be optional:
* `<tiddler title>!!<metadata field>` - a tiddler metadata field (eg, `modified`, `modifier`, `type` etc)
* `<tiddler title>##<data field>` - a data field within a tiddler
* `!!<metadata field>` - a metadata field of the current tiddler
* `##<data field>` - a datafield of the current tiddler

4
tw5.com/tiddlers/concepts/ContextTiddler.tid Normal file
View File

@ -0,0 +1,4 @@
title: ContextTiddler
tags: docs concepts
The ContextTiddler is the current tiddler during WikiText processing. It allows you to write a macro like `<<view title link>>` without explicitly specifying the tiddler that it applies to.

3
tw5.com/tiddlers/concepts/TiddlerFilters.tid
View File

@ -41,7 +41,8 @@ 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:
* ''tiddler'': selects all ordinary (non-shadow) tiddlers * ''shadow'': selects all shadow tiddlers
* ''current'': selects the current ContextTiddler
Operators are combined into logically ANDed expressions by bashing them together and merging the square brackets: Operators are combined into logically ANDed expressions by bashing them together and merging the square brackets:

6
tw5.com/tiddlers/concepts/WikiText.tid
View File

@ -2,9 +2,11 @@ title: WikiText
type: text/x-tiddlywiki type: text/x-tiddlywiki
tags: docs concepts tags: docs concepts
WikiText is a concise, expressive way of typing a wide range of text formatting and hypertext features. Operations like linking become part of the punctuation of your writing. WikiText is a concise, expressive way of typing a wide range of text formatting and hypertext features. It allows you to focus on writing without a complex user interface getting in the way.
The key feature of wikitext is the ability to include one tiddler within another (usually referred to as //transclusion//). For example, one could have a tiddler called //Disclaimer// that contains the boilerplate of a legal disclaimer, and then include it within lots of different tiddlers with the macro call `<<tiddler Disclaimer>>`. For example, you can create a link to a tiddler by wrapping its title in double square brackets -- `[[My Tiddler]]` -- or, if the tiddler title conforms to the CamcelCase rules, it is automatically linked without needing the brackets. In this way, linking become part of the punctuation of your writing.
Another key feature of wikitext is the ability to include one tiddler within another (referred to as //transclusion//). For example, one could have a tiddler called //Disclaimer// that contains the boilerplate of a legal disclaimer, and then include it within lots of different tiddlers with the macro call `<<tiddler Disclaimer>>`.
! This is a heading ! This is a heading