From ab808b3272b9254b71ef5b2a9aace5252e326b84 Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Tue, 19 Jun 2012 08:56:45 +0100 Subject: [PATCH] Docs update --- tw5.com/tiddlers/TextReference.tid | 12 ++++++++++++ tw5.com/tiddlers/concepts/ContextTiddler.tid | 4 ++++ tw5.com/tiddlers/concepts/TiddlerFilters.tid | 3 ++- tw5.com/tiddlers/concepts/WikiText.tid | 6 ++++-- 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 tw5.com/tiddlers/TextReference.tid create mode 100644 tw5.com/tiddlers/concepts/ContextTiddler.tid diff --git a/tw5.com/tiddlers/TextReference.tid b/tw5.com/tiddlers/TextReference.tid new file mode 100644 index 000000000..357b63640 --- /dev/null +++ b/tw5.com/tiddlers/TextReference.tid @@ -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: + +* `!!` - a tiddler metadata field (eg, `modified`, `modifier`, `type` etc) +* `##` - a data field within a tiddler +* `!!` - a metadata field of the current tiddler +* `##` - a datafield of the current tiddler + diff --git a/tw5.com/tiddlers/concepts/ContextTiddler.tid b/tw5.com/tiddlers/concepts/ContextTiddler.tid new file mode 100644 index 000000000..bdd3bea3b --- /dev/null +++ b/tw5.com/tiddlers/concepts/ContextTiddler.tid @@ -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 `<>` without explicitly specifying the tiddler that it applies to. diff --git a/tw5.com/tiddlers/concepts/TiddlerFilters.tid b/tw5.com/tiddlers/concepts/TiddlerFilters.tid index 4a4ef8e5e..d75088a91 100644 --- a/tw5.com/tiddlers/concepts/TiddlerFilters.tid +++ b/tw5.com/tiddlers/concepts/TiddlerFilters.tid @@ -41,7 +41,8 @@ The operator defaults to `title` if omitted, so `[[HelloThere]]` is equivalent t 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: diff --git a/tw5.com/tiddlers/concepts/WikiText.tid b/tw5.com/tiddlers/concepts/WikiText.tid index ec522005f..a22feadb6 100644 --- a/tw5.com/tiddlers/concepts/WikiText.tid +++ b/tw5.com/tiddlers/concepts/WikiText.tid @@ -2,9 +2,11 @@ title: WikiText type: text/x-tiddlywiki 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 `<>`. +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 `<>`. ! This is a heading