TiddlyWiki5/editions/tw5.com/tiddlers/howtos/Adopt a Titles Policy.tid

created: 20130825103300000
modified: 20140912150136251
tags: Learning
title: Adopt a Titles Policy
type: text/vnd.tiddlywiki

As the structures within your TiddlyWiki documents get more complex it can be hard to keep the titles of tiddlers consistent. For example, should terms be defined in the plural or the singular? Camel case or separate words?

Recording a formal titling policy can help to reduce confusion. For example, the titling policies for this wiki are recorded in the [[Documentation Style Guide]].

! SystemTiddler Titles

A useful convention is to use the prefix `$:/_` for any system tiddlers that you create to ensure that they are near the top of the system tiddler listing in the sidebar
Lotsa docs updates 2013-11-29 12:26:48 +00:00			`created: 20130825103300000`
Lots more docs updates 2014-09-12 15:05:37 +00:00			`modified: 20140912150136251`
			`tags: Learning`
Adjust some content directories 2014-09-10 18:36:54 +00:00			`title: Adopt a Titles Policy`
Lotsa docs updates 2013-11-29 12:26:48 +00:00			`type: text/vnd.tiddlywiki`
Docs update Tearing up the recent changes tab... 2013-08-25 20:22:11 +00:00
			`As the structures within your TiddlyWiki documents get more complex it can be hard to keep the titles of tiddlers consistent. For example, should terms be defined in the plural or the singular? Camel case or separate words?`

Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			`Recording a formal titling policy can help to reduce confusion. For example, the titling policies for this wiki are recorded in the [[Documentation Style Guide]].`
Docs update Tearing up the recent changes tab... 2013-08-25 20:22:11 +00:00
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			`! SystemTiddler Titles`
Add note about system tiddler naming conventions 2014-01-23 08:23:49 +00:00
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			A useful convention is to use the prefix `$:/_` for any system tiddlers that you create to ensure that they are near the top of the system tiddler listing in the sidebar