From 8e47a200694eed495e96fb07184af01c3df9850c Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 14:59:16 +0000 Subject: [PATCH 1/8] Improvements to wording --- editions/tw5.com/tiddlers/howtos/Tagging.tid | 45 ++++++++++++-------- 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/editions/tw5.com/tiddlers/howtos/Tagging.tid b/editions/tw5.com/tiddlers/howtos/Tagging.tid index 139112035..32e3812ca 100644 --- a/editions/tw5.com/tiddlers/howtos/Tagging.tid +++ b/editions/tw5.com/tiddlers/howtos/Tagging.tid @@ -4,33 +4,42 @@ tags: [[Working with TiddlyWiki]] Concepts title: Tagging type: text/vnd.tiddlywiki -Tagging a tiddler assigns a tiddler to a category of your choosing (see [[Creating and editing tiddlers]] for instructions on how to tag). For example, tiddlers representing individuals might be tagged ''friend'', ''family'', ''colleague'' etc to indicate the relationship to the author. Multiple tags can be applied to the same tiddler. +Tagging is a way of organising tiddlers into categories. For example, if you had tiddlers representing various individuals, you could tag them as ''friend'', ''family'', ''colleague'' etc to indicate these people's relationships to you. -Tagging tiddlers gives you numerous additional ways to view, navigate and organise your information: +A tag is in fact just a tiddler (or a potential tiddler), and it can have tags of its own. You can add any number of tags to the same tiddler. -* The coloured tag pills on a tagged tiddler give you links to all the other tiddlers with the same tag, as well as to the tiddler representing the tag itself. -* The ''Tagging'' tab in the tiddler info panel (accessed by clicking the {{$:/core/images/info-button}} button) gives you links to all the tiddlers tagged with the title of the current tiddler. +See [[Creating and editing tiddlers]] for instructions on how to tag. -* You can use the tags tab in the ''More'' sidebar tab to view all your tags and access your tagged tiddlers. +By tagging your tiddlers, you can view, navigate and organise your information in numerous additional ways: -* You can use [[filters|Filters]] to create lists of tiddlers based on tags, then display whichever combination of tiddler fields you wish. For example, you can create a list that shows both the title and the text of all tiddlers tagged ''Glossary''. Such lists can be formatted however you wish: for example: bulleted, numbered, or comma-separated. +* The coloured tag pills on a tiddler give you quick access to all the other tiddlers with the same tag, as well as to the tiddler that represents the tag itself. -* System tags can be used to customise the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation]] for instructions. +* If a tiddler is serving as a tag, then the ''Tagging'' tab in its InfoPanel will show you which tiddlers are currently tagged with it. + +* The ''More'' tab of the sidebar has a ''Tags'' tab that presents an overview of all your tags and lets you access all your tagged tiddlers. + +* You can use [[filters|Filters]] to create lists of tiddlers based on their tags. You can then display any combination of the [[fields|TiddlerFields]] of those tiddlers. For example, you could build a glossary by listing the title and text of all tiddlers tagged ''Glossary''. Such lists can be formatted in any way you wish: e.g. bulleted, numbered or comma-separated. + +* There are a number of special ''system tags'' that control the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation]] for instructions. There are two more things you can do with tags: -! Assign colours and icons to a tag +! Set a tag's colour and icon -You can use the [[tag manager|$:/TagManager]], found in the ''Tags'' tab of the ''More'' sidebar tab, to assign background colours and/or icons to a tag. +You can use the [[tag manager|$:/TagManager]], found in the sidebar under ''More'' → ''Tags'', to change the colour of a tag's pill or add an icon to the pill. -* Colours can be assigned to a tag either by specifying the CSS colour value in the upper window in the colour column, or choosing a colour from the dropdown colour picker provided. -* Icons can be assigned to a tag by clicking the {{$:/core/images/down-arrow}} button in the icon column and choosing one of the icons listed. +* To change the colour, click the button in the ''Colour'' column to select from a colour picker. Alternatively, click the icon in the ''Info'' column, then type a [[CSS]] colour value in the ''Colour'' field +* To change the icon, click the {{$:/core/images/down-arrow}} button in the ''Icon'' column and choose from the list of available icons -! Use list fields to adjust the ordering of tag lists +! Change the order in which tags are listed -* If you want to create a list of tagged tiddlers with a [[filter|Filters]], but want the tiddlers to be listed in a special order rather than the default alphabetical order, you can create a field called ''list'' in the tag tiddler, and add the titles of the tiddlers to the field in the order you wish. ~TiddlyWiki will order lists of tagged tiddlers in the following order of priority: -** First, any tiddlers that are listed in the ListField of the tag tiddler are placed into a new list in the same order -** Second, any unplaced tiddlers that have the field ''list-before'' are placed before the tiddler specified in the field -*** (if the ''list-before'' field is empty then the unplaced tiddler is placed at the start of the list) -** Third, if any unplaced tiddlers have the field ''list-after'' then they are placed immediately after the tiddler specified in the field -** Finally, any remaining unplaced tiddlers are placed at the end of the list +By default, tagged tiddlers are listed in the order they were added to the wiki. The [[sort operator|Filter operator: sort]] can change the order to alphabetical. + +If you want any other order, add a [[field called ''list''|ListField]] to the tag tiddler, and set its value to be a [[TiddlerChain]] of the tiddlers in that order. + +The ''list'' field doesn't have to mention all of the tiddlers. Here are the precise rules ~TiddlyWiki uses to order tagged tiddlers: + +# Start with the tiddlers in the ''list'' field, in the sequence given there. +# In each remaining tiddler, look for a ''list-before'' field. If this has a tiddler title as its value, insert the tiddler into the sequence just before that one. As a special case, if the field's value is blank, add the tiddler at the very start of the sequence. +# In each remaining tiddler, look for a ''list-after'' field. If this has a tiddler title as its value, insert the tiddler into the sequence just after that one. +# If any tiddlers still remain, add them to the very end of the sequence. From 39c786b042e641d24940b00ec7ae727bb10503f4 Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 15:05:17 +0000 Subject: [PATCH 2/8] Link to the TiddlerChain tiddler --- .../tiddlers/workingwithtw/Creating journal tiddlers.tid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid b/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid index d0ebce43d..ce69f29c6 100644 --- a/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid +++ b/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid @@ -29,7 +29,7 @@ For example, you might be reviewing a tiddler called ''Oxford Street'' and reali To configure how new journal entries are created, visit the ''Basics'' tab under ''Info'' in the [[control panel|$:/ControlPanel]]: * "Title of new journal tiddlers" specifies how these tiddlers should be named, as a [[date format string|DateFormat]]. The default setting of `DDth MMM YYYY` causes new entries to have titles of the form "10th October 2014" -* "Tags for new journal tiddlers" specifies tags that will automatically appear on new journal entries. Type a space between each tag and the next. If any of the tags //contains// a space, place double square brackets around it. For example: `Journal [[Summer vacation]]` +* "Tags for new journal tiddlers" [specifies|TiddlerChain] tags that will automatically appear on new journal entries. For example: `Journal [[Summer vacation]]` Hint: if you want to create a separate journal tiddler whenever you click ''new journal'' (even if you do this several times in the same day), you can include the clock time in the title format. Specify something like `YYYY-0MM-0DD at 0hhh0mm'0ss''` as the date format. From 304848f2586f72c4e6021da0db3e0043988a356d Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 15:06:18 +0000 Subject: [PATCH 3/8] Add a TiddlerChain tiddler For the common but unnamed concept of a "string [[of tiddler]] titles" like that. --- editions/tw5.com/tiddlers/concepts/TiddlerChain.tid | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 editions/tw5.com/tiddlers/concepts/TiddlerChain.tid diff --git a/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid b/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid new file mode 100644 index 000000000..c9d46427f --- /dev/null +++ b/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid @@ -0,0 +1,12 @@ +tags: Concepts +title: TiddlerChain + +A tiddler chain is a line of text that presents one or more tiddler titles, strung together with a space between each one and the next. + +If a title //contains// a space, it needs double square brackets around it. + +Example: + +`GettingStarted [[Discover TiddlyWiki]] Upgrading` + +Tiddler chains are used in various places, including PermaLinks and the ListField. From 7ca37739aadb72906cfcd984b1969b5a7bc3fb6d Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 17:32:45 +0000 Subject: [PATCH 4/8] Simplify style of arrow in tab hierarchy This is something that --- editions/tw5.com/tiddlers/howtos/Tagging.tid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/howtos/Tagging.tid b/editions/tw5.com/tiddlers/howtos/Tagging.tid index 32e3812ca..8d9cdb44c 100644 --- a/editions/tw5.com/tiddlers/howtos/Tagging.tid +++ b/editions/tw5.com/tiddlers/howtos/Tagging.tid @@ -26,7 +26,7 @@ There are two more things you can do with tags: ! Set a tag's colour and icon -You can use the [[tag manager|$:/TagManager]], found in the sidebar under ''More'' → ''Tags'', to change the colour of a tag's pill or add an icon to the pill. +You can use the [[tag manager|$:/TagManager]], found in the sidebar under ''More'' > ''Tags'', to change the colour of a tag's pill or add an icon to the pill. * To change the colour, click the button in the ''Colour'' column to select from a colour picker. Alternatively, click the icon in the ''Info'' column, then type a [[CSS]] colour value in the ''Colour'' field * To change the icon, click the {{$:/core/images/down-arrow}} button in the ''Icon'' column and choose from the list of available icons From 25e447f69ed176017722aa151d8282343fc779b2 Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 21:46:20 +0000 Subject: [PATCH 5/8] Rephrase route through tabs Provisionally, rather than using any sort of arrow symbol. We need to standardise a notation for referring to hierarchical UI, but that will come with the documentation style guide. --- editions/tw5.com/tiddlers/howtos/Tagging.tid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/howtos/Tagging.tid b/editions/tw5.com/tiddlers/howtos/Tagging.tid index 8d9cdb44c..245fb9cc4 100644 --- a/editions/tw5.com/tiddlers/howtos/Tagging.tid +++ b/editions/tw5.com/tiddlers/howtos/Tagging.tid @@ -26,7 +26,7 @@ There are two more things you can do with tags: ! Set a tag's colour and icon -You can use the [[tag manager|$:/TagManager]], found in the sidebar under ''More'' > ''Tags'', to change the colour of a tag's pill or add an icon to the pill. +You can use the [[tag manager|$:/TagManager]], found on the ''Tags'' tab under ''More'' in the sidebar, to change the colour of a tag's pill or add an icon to the pill. * To change the colour, click the button in the ''Colour'' column to select from a colour picker. Alternatively, click the icon in the ''Info'' column, then type a [[CSS]] colour value in the ''Colour'' field * To change the icon, click the {{$:/core/images/down-arrow}} button in the ''Icon'' column and choose from the list of available icons From cc2688bf44746a4675227669aadbcab21e7cbda6 Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 21:55:04 +0000 Subject: [PATCH 6/8] Update and rename TiddlerChain.tid to TitleList.tid --- editions/tw5.com/tiddlers/concepts/TiddlerChain.tid | 12 ------------ editions/tw5.com/tiddlers/concepts/TitleList.tid | 12 ++++++++++++ 2 files changed, 12 insertions(+), 12 deletions(-) delete mode 100644 editions/tw5.com/tiddlers/concepts/TiddlerChain.tid create mode 100644 editions/tw5.com/tiddlers/concepts/TitleList.tid diff --git a/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid b/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid deleted file mode 100644 index c9d46427f..000000000 --- a/editions/tw5.com/tiddlers/concepts/TiddlerChain.tid +++ /dev/null @@ -1,12 +0,0 @@ -tags: Concepts -title: TiddlerChain - -A tiddler chain is a line of text that presents one or more tiddler titles, strung together with a space between each one and the next. - -If a title //contains// a space, it needs double square brackets around it. - -Example: - -`GettingStarted [[Discover TiddlyWiki]] Upgrading` - -Tiddler chains are used in various places, including PermaLinks and the ListField. diff --git a/editions/tw5.com/tiddlers/concepts/TitleList.tid b/editions/tw5.com/tiddlers/concepts/TitleList.tid new file mode 100644 index 000000000..72d06900d --- /dev/null +++ b/editions/tw5.com/tiddlers/concepts/TitleList.tid @@ -0,0 +1,12 @@ +tags: Concepts +title: TitleList + +A title list is a line of text that presents one or more tiddler titles, strung together with a space between each one and the next. + +If a title //contains// a space, it needs double square brackets around it. + +Example: + +`GettingStarted [[Discover TiddlyWiki]] Upgrading` + +Title lists are used in various places, including PermaLinks and the ListField. From 5f3de6ec17b0f1ab3f330ed3713febc815cce66c Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 21:56:00 +0000 Subject: [PATCH 7/8] Change TiddlerChain to TitleList --- .../tiddlers/workingwithtw/Creating journal tiddlers.tid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid b/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid index ce69f29c6..47f87b23d 100644 --- a/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid +++ b/editions/tw5.com/tiddlers/workingwithtw/Creating journal tiddlers.tid @@ -29,7 +29,7 @@ For example, you might be reviewing a tiddler called ''Oxford Street'' and reali To configure how new journal entries are created, visit the ''Basics'' tab under ''Info'' in the [[control panel|$:/ControlPanel]]: * "Title of new journal tiddlers" specifies how these tiddlers should be named, as a [[date format string|DateFormat]]. The default setting of `DDth MMM YYYY` causes new entries to have titles of the form "10th October 2014" -* "Tags for new journal tiddlers" [specifies|TiddlerChain] tags that will automatically appear on new journal entries. For example: `Journal [[Summer vacation]]` +* "Tags for new journal tiddlers" [specifies|TitleList] tags that will automatically appear on new journal entries. For example: `Journal [[Summer vacation]]` Hint: if you want to create a separate journal tiddler whenever you click ''new journal'' (even if you do this several times in the same day), you can include the clock time in the title format. Specify something like `YYYY-0MM-0DD at 0hhh0mm'0ss''` as the date format. From 19050934118888e3f8416476ac00f4d971505b7a Mon Sep 17 00:00:00 2001 From: Astrid Elocson Date: Tue, 23 Dec 2014 21:57:18 +0000 Subject: [PATCH 8/8] Change TiddlerChain to TitleList --- editions/tw5.com/tiddlers/howtos/Tagging.tid | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editions/tw5.com/tiddlers/howtos/Tagging.tid b/editions/tw5.com/tiddlers/howtos/Tagging.tid index 245fb9cc4..5b6cf411d 100644 --- a/editions/tw5.com/tiddlers/howtos/Tagging.tid +++ b/editions/tw5.com/tiddlers/howtos/Tagging.tid @@ -35,7 +35,7 @@ You can use the [[tag manager|$:/TagManager]], found on the ''Tags'' tab under ' By default, tagged tiddlers are listed in the order they were added to the wiki. The [[sort operator|Filter operator: sort]] can change the order to alphabetical. -If you want any other order, add a [[field called ''list''|ListField]] to the tag tiddler, and set its value to be a [[TiddlerChain]] of the tiddlers in that order. +If you want any other order, add a [[field called ''list''|ListField]] to the tag tiddler, and set its value to be a [[TitleList]] of the tiddlers in that order. The ''list'' field doesn't have to mention all of the tiddlers. Here are the precise rules ~TiddlyWiki uses to order tagged tiddlers: