Docs: Add a new overview of customisation techniques

This commit is contained in:
jeremy@jermolene.com 2021-11-29 09:21:50 +00:00
parent 5dfa6b2bb4
commit 8b6733d792
4 changed files with 62 additions and 7 deletions

View File

@ -0,0 +1,55 @@
created: 20211127084727217
modified: 20211128200929866
tags: [[Customise TiddlyWiki]]
title: Customising TiddlyWiki's user interface
type: text/vnd.tiddlywiki
TiddlyWikis 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
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.

View File

@ -1,6 +1,6 @@
created: 20150124125646000
modified: 20211119191622651
tags: Tagging Concepts
modified: 20211127140005352
tags: Tagging
title: Order of Tagged Tiddlers
type: text/vnd.tiddlywiki

View File

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

View File

@ -1,10 +1,10 @@
created: 20140904101600000
list: [[Adding custom-made tiddlers to the user interface]] [[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 buttons for the ViewToolbar and page controls]] [[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]] [[Preserving open tiddlers at startup]] [[Removing shadow tiddlers from the user interface]] [[Setting a favicon]] [[Setting a page background image]] [[Using Stylesheets]]
modified: 20211126121202155
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 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: 20211127140430506
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]]">>