tiddlywiki 5.2.0 → 5.2.1

package/editions/tw5.com/tiddlers/concepts/Story Tiddler Template Cascade.tid

@@ -0,0 +1,16 @@
+created: 20211206132047986
+modified: 20211206155818924
+tags: Cascades
+title: Story Tiddler Template Cascade
+type: text/vnd.tiddlywiki
+
+The story tiddler template cascade is a [[cascade|Cascades]] used to choose which [[Story Tiddler Template]] should be used for a particular tiddler.
+
+The default story tiddler template cascade consists of:
+
+# If the tiddler is a draft tiddler, use the template title given in the tiddler $:/config/ui/EditTemplate
+# Otherwise, use the template title given in the tiddler $:/config/ui/ViewTemplate
+
+You can see the current settings for the story tiddler template cascade in $:/ControlPanel under the ''Info'' -> ''Advanced'' -> ''Cascades''  -> ''Story Tiddler'' tab.
+
+<<list-links "[tag[Story Tiddler Template Cascade]]">>

package/editions/tw5.com/tiddlers/concepts/Story Tiddler Template.tid

@@ -0,0 +1,13 @@
+created: 20211204122044198
+modified: 20211206133756716
+tags: Concepts
+title: Story Tiddler Template
+type: text/vnd.tiddlywiki
+
+"Story tiddler template" refers to the template used to display a tiddler within the story river.
+
+The [[Story Tiddler Template Cascade]] is used to choose the template to be used for a particular tiddler. By default, the edit template is used for tiddlers in draft mode, and the view template used otherwise.
+
+See also:
+
+<<list-links "[tag[Story Tiddler Template]]">>

package/editions/tw5.com/tiddlers/concepts/TagTiddlers.tid

@@ -1,5 +1,5 @@
 created: 20141228094500000
-modified: 20150917193731240
+modified: 20211127135914596
 tags: Tagging
 title: TagTiddlers
 type: text/vnd.tiddlywiki

package/editions/tw5.com/tiddlers/concepts/Tiddler Colour Cascade.tid

@@ -0,0 +1,16 @@
+created: 20211206160300525
+modified: 20211206165301231
+tags: Cascades
+title: Tiddler Colour Cascade
+type: text/vnd.tiddlywiki
+
+The tiddler colour cascade is a [[cascade|Cascades]] used to choose which colour should be used for a particular tiddler.
+
+The default tiddler colour cascade consists of:
+
+# If the tiddler has a ''color'' field, use the value as the colour
+# If the tiddler $:/config/DefaultTiddlerColour exists, use the value as the colour
+
+You can see the current settings for the tiddler colour cascade in $:/ControlPanel under the ''Info'' -> ''Advanced'' -> ''Cascades''  -> ''Tiddler Colour'' tab.
+
+<<list-links "[tag[Tiddler Colour Cascade]]">>

package/editions/tw5.com/tiddlers/concepts/Tiddler Icon Cascade.tid

@@ -0,0 +1,16 @@
+created: 20211206154017669
+modified: 20211206160003647
+tags: Cascades
+title: Tiddler Icon Cascade
+type: text/vnd.tiddlywiki
+
+The tiddler icon cascade is a [[cascade|Cascades]] used to choose which icon should be used for a particular tiddler.
+
+The default tiddler icon cascade consists of:
+
+# If the tiddler has an ''icon'' field, use the value as the title of the icon tiddler
+# If the tiddler $:/config/DefaultTiddlerIcon exists, use the value as the title of the icon tiddler 
+
+You can see the current settings for the tiddler icon cascade in $:/ControlPanel under the ''Info'' -> ''Advanced'' -> ''Cascades''  -> ''Tiddler Icon'' tab.
+
+<<list-links "[tag[Tiddler Icon Cascade]]">>

package/editions/tw5.com/tiddlers/concepts/View Template Body Cascade.tid

@@ -0,0 +1,19 @@
+created: 20211206161124327
+modified: 20211206161613268
+tags: Cascades
+title: View Template Body Cascade
+type: text/vnd.tiddlywiki
+
+The view template body cascade is a [[cascade|Cascades]] used by the default view template to choose the template for displaying the tiddler body.
+
+The default view template body cascade consists of:
+
+# If the tiddler title starts with any of a list of known system tiddler prefixes, use the template $:/core/ui/ViewTemplate/body/code to display the body as preformatted code
+# If the tiddler has the field ''plugin-type'' set to ''import'' then use the template $:/core/ui/ViewTemplate/body/import which displays the custom import user interface
+# If the tiddler has the field ''plugin-type'' then use the template $:/core/ui/ViewTemplate/body/plugin to display the plugin information badge
+# If the tiddler has the field ''hide-body'' set to ''yes'' then use the template $:/core/ui/ViewTemplate/body/blank to hide the body
+# Otherwise, use the default template $:/core/ui/ViewTemplate/body/default
+
+You can see the current settings for the view template body cascade in $:/ControlPanel under the ''Info'' -> ''Advanced'' -> ''Cascades''  -> ''View Template Body'' tab.
+
+<<list-links "[tag[View Template Body Cascade]]">>

package/editions/tw5.com/tiddlers/concepts/View Template Title Cascade.tid

@@ -0,0 +1,16 @@
+created: 20211206160703815
+modified: 20211206161115837
+tags: Cascades
+title: View Template Title Cascade
+type: text/vnd.tiddlywiki
+
+The view template title cascade is a [[cascade|Cascades]] used by the default view template to choose the template for displaying the tiddler title.
+
+The default view template title cascade consists of:
+
+#  If the tiddler title starts with `$:/` then use the template $:/core/ui/ViewTemplate/title/system which causes the `$:/` prefix to be displayed in pale text
+# Otherwise, use the template $:/core/ui/ViewTemplate/title/default which displays the title in plain text
+
+You can see the current settings for the view template title cascade in $:/ControlPanel under the ''Info'' -> ''Advanced'' -> ''Cascades''  -> ''View Template Title'' tab.
+
+<<list-links "[tag[View Template Title Cascade]]">>

package/editions/tw5.com/tiddlers/customising/Alternative page layouts.tid

@@ -1,5 +1,5 @@
 created: 20201123172925848
-modified: 20201123192845498
+modified: 20211126120310891
 tags: [[Customise TiddlyWiki]]
 title: Alternative page layouts
 type: text/vnd.tiddlywiki

package/editions/tw5.com/tiddlers/customising/Creating new toolbar buttons.tid

@@ -0,0 +1,35 @@
+created: 20211124205415217
+modified: 20211126162937536
+tags: [[Customise TiddlyWiki]]
+title: Creating new toolbar buttons
+type: text/vnd.tiddlywiki
+
+Let's say you have a skeleton tiddler called 'Recipe template', and you want to have a button available in the tiddler ViewToolbar to create new recipe tiddlers on demand. This will require the following steps:
+
+# You will want an image for your button. If none of the core images (shadow tiddlers with the prefix $:/core/images/) work for you, then you will need to create or acquire an SVG image (for example, one of the images at http://flaticon.com), drag it into your file so that it becomes a tiddler, edit the tiddler and adjust the height and width to 22px
+# You will want to create the tiddler that contains your tiddler. Create it, title it, and add the button code (see the code at the bottom of this tiddler for an example, with hints where you will need to adapt it). Tag it [[$:/tags/ViewToolbar]]
+# You will need to create a tiddler that tells TiddlyWiki whether your button should be visible in the toolbar or hidden. Let's title it [[$:/config/ViewToolbarButtons/Visibility/Recipe]]. Type `show` into the text area, and save. If you want to hide it, type `hide` into the text area and save. The button will also be accessable from the ''ControlPanel : Appearance : Toolbars : ViewToolbar'' tab
+# You will want to position the button properly. Open the tiddler $:/tags/ViewToolbar and insert your button tiddler's title in the appropriate place in the list field.
+
+```
+\define newHereButtonTags()
+[[$(currentTiddler)$]]
+\end
+\define newHereButton()
+<$button class=<<tv-config-toolbar-class>>>
+<$action-sendmessage
+  $message="tm-new-tiddler"
+$param="TITLE OF YOUR SKELETON BUTTON"
+title="New tiddler"
+  tags=<<newHereButtonTags>> />
+<$list filter="[<tv-config-toolbar-icons>match[yes]]">
+{{TITLE OF YOUR SVG IMAGE TIDDLER}}
+</$list>
+<$list filter="[<tv-config-toolbar-text>match[yes]]">
+<span class="tc-btn-text"><$text text="CAPTION FOR YOUR BUTTON"/></span>
+</$list>
+</$button>
+\end
+
+<<newHereButton>>
+```

package/editions/tw5.com/tiddlers/customising/Customise TiddlyWiki.tid

@@ -1,10 +1,10 @@
 created: 20140904101600000
-list: [[Adding a table of contents to the sidebar]] [[Configuring startup tiddlers]] [[Configuring the default TiddlerInfo tab]] [[Creating a custom export format]] [[Creating a splash screen]] [[Customising search results]] [[Hidden Settings]] [[How to add a new tab to the sidebar]] [[How to apply custom styles]] [[How to create keyboard shortcuts]] [[How to turn off camel case linking]] [[How to widen tiddlers (aka storyriver)]] [[Making a custom journal button]] [[Page and tiddler layout customisation]] [[Alternative page layouts]] [[Preserving open tiddlers at startup]] [[Setting a favicon]] [[Setting a page background image]] [[Using Stylesheets]]
-modified: 20201123173044437
+list: [[Adding a table of contents to the sidebar]] [[Alternative page layouts]] [[Configuring startup tiddlers]] [[Configuring the default TiddlerInfo tab]] [[Creating a custom export format]] [[Creating a splash screen]] [[Creating new toolbar buttons]] [[Customising search results]] [[Customising TiddlyWiki's user interface]] [[Hidden Settings]] [[How to add a new tab to the sidebar]] [[How to apply custom styles]] [[How to create a custom story tiddler template]] [[How to create a custom tiddler icon rule]] [[How to create a custom tiddler colour rule]] [[How to create keyboard shortcuts]] [[How to turn off camel case linking]] [[How to widen tiddlers (aka storyriver)]] [[Making a custom journal button]] [[Preserving open tiddlers at startup]] [[Setting a favicon]] [[Setting a page background image]] [[Using Stylesheets]]
+modified: 20211206162235300
 tags: TableOfContents
 title: Customise TiddlyWiki
 type: text/vnd.tiddlywiki
 
-Information about customising TiddlyWiki
+Information about customising TiddlyWiki. See [[Customising TiddlyWiki's user interface]] for an overview of the mechanisms employed.
 
 <<list-links "[tag[Customise TiddlyWiki]]">>

package/editions/tw5.com/tiddlers/customising/Customising TiddlyWiki's user interface.tid

@@ -0,0 +1,75 @@
+created: 20211127084727217
+modified: 20211204120054422
+tags: [[Customise TiddlyWiki]]
+title: Customising TiddlyWiki's user interface
+type: text/vnd.tiddlywiki
+
+TiddlyWiki’s user interface is designed to be highly extensible. Every element can be augmented, removed, or rearranged.
+
+Several different mechanisms are used to achieve this:
+
+* special fields
+* special titles
+* special tags
+* cascades
+
+Here we provide an overview of those mechanisms and how they relate together.
+
+!! Special Fields
+
+Special fields are used to assign an appearance or behaviour to individual tiddlers. They can be thought of as flags or values that directly control the tiddler to which they are applied.
+
+For example:
+
+* Set the `icon` field to the title of an image tiddler to be used as the icon for this tiddler
+* Set the `color` field to a CSS colour that is then used for icons and tag pills associated with this tiddler
+* Set the `hide-body` field to `yes` to hide the view template body for this tiddler
+
+See TiddlerFields for details of all the special fields.
+
+!! Special Titles
+
+Certain special titles identify configuration tiddlers that customise TiddlyWiki's appearance or behaviour. They can be thought of as global settings that affect an entire wiki. 
+
+For example:
+
+* $:/DefaultTiddlers is a filter yielding the titles of the tiddlers that should be displayed at startup
+* $:/SiteTitle specifies the text of the wiki title
+* $:/config/Tags/MinLength controls the minimum number of characters to trigger tag autocompletion
+
+Many of TiddlyWiki's configuration tiddlers are presented as options in [[$:/ControlPanel]]. Less commonly used configuration tiddlers do not have a user interface, but are documented in [[Hidden Settings]].
+
+!! Special Tags
+
+Special tags assign special behaviour or appearance to all of the tiddlers to which they are applied. They can be thought of as establishing ordered lists of tiddlers that are processed or displayed in a particular way.
+
+For example:
+
+* $:/tags/Macro causes the macros defined in a tiddler to be available globally
+* $:/tags/Stylesheet causes the tiddler to be interpreted as a CSS stylesheet
+* $:/tags/SideBar causes the tiddler to be displayed as a sidebar tab
+
+See SystemTags for details of all the special tags.
+
+The  entire TiddlyWiki user interface is constructed from lists formed from special system tags.
+
+The ordering of these lists is determined by the [[order of tagged tiddlers|Order of Tagged Tiddlers]] rules. Users can re-order tags using drag and drop within a tag dropdown.
+
+!! Cascades
+
+Cascades provide a means to select one of multiple values based on flexible, extensible criteria. They can be thought of as a list of conditions that are evaluated in turn until one of them matches.
+
+For example, the core uses the template $:/core/ui/ViewTemplate to display tiddlers in view mode, and $:/core/ui/EditTemplate to display tiddlers in edit mode. A cascade is used to choose which template to use for a particular tiddler:
+
+# If the tiddler is a draft, then use $:/core/ui/EditTemplate
+# Otherwise, use $:/core/ui/EditTemplate
+
+The list of conditions is defined via a special tag, making it possible to insert additional conditions anywhere in the list.
+
+For example, a plugin might add a special template $:/plugins/example/map-template for tiddlers that have the tag [[$:/tags/Map]] by inserting an additional rule:
+
+# If the tiddler is a draft, then use $:/core/ui/EditTemplate
+# @@background: yellow; If the tiddler is tagged $:/tags/Map, then use $:/plugins/example/map-template@@
+# Otherwise, use $:/core/ui/EditTemplate
+
+See [[Cascades]] for more details.

package/editions/tw5.com/tiddlers/definitions/BT.tid

@@ -1,5 +1,6 @@
-created: 201311010911
-modified: 201311010911
+created: 20131101091100000
+modified: 20211117195517318
+tags: Definitions
 title: BT
 
 BT (née British Telecom) is the UK's largest telecommunications company. In 2007, [[Osmosoft]] was acquired by BT. JeremyRuston subsequently left BT in 2011.

package/editions/tw5.com/tiddlers/definitions/MathML.tid

@@ -1,6 +1,6 @@
 created: 20130901213100000
-modified: 20140919161635814
-tags: Definitions Features
+modified: 20211124215351987
+tags: Definitions
 title: MathML
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/definitions/Osmosoft.tid

@@ -1,5 +1,6 @@
-created: 201311010913
-modified: 201311010924
+created: 20131101091300000
+modified: 20211119004632506
+tags: Definitions
 title: Osmosoft
 
 Founded in 2004 by JeremyRuston, Osmosoft was originally a consultancy for software services around TiddlyWiki. Notable engagements included working with Socialtext on [[Socialtext Unplugged|https://www.socialtext.net/open/socialtext_unplugged]].

package/editions/tw5.com/tiddlers/definitions/node-webkit.tid

@@ -1,5 +1,6 @@
 created: 20140101164042231
-modified: 20150310165059118
+modified: 20211120221754270
+tags: Definitions
 title: node-webkit
 type: text/vnd.tiddlywiki