TiddlyWiki5/editions/tw5.com/tiddlers/nodejs/Naming of System Tiddlers.tid

created: 20140112190154121
modified: 20140912142655205
tags: SystemTiddlers
title: Naming of System Tiddlers
type: text/vnd.tiddlywiki

The system tiddlers provided as part of the core are named according to the following rules:

|!Namespace |!Format |!Description |
|`$:/*` |~CamelCase |Root user interface tiddlers (eg control panel, advanced search) |
|`$:/config/*` |~CamelCase |User-oriented configuration setting |
|`$:/core/images/*` |hyphen-case |Core images |
|`$:/core/modules/*` |lowercase |JavaScript module tiddlers |
|`$:/core/save/*` |lowercase |Saving templates for creating TiddlyWiki documents |
|`$:/core/templates/*` |//inconsistent// |Templates needed for TiddlyWiki to operate. Currently uses a mix of dashes and periods to separate words |
|`$:/core/ui/*` |//inconsistent// |Tiddlers comprising the default user interface of TiddlyWiki. Currently uses a mix of ~CamelCase and lowercase naming conventions |
|`$:/core/wiki/*` |lowercase |Metadata about the entire wiki |
|`$:/docs/*` |lowercase |Documentation tiddlers |
|`$:/messages/*` |~CamelCase |System messages |
|`$:/plugins/*` |lowercase |Plugin tiddlers, and plugin content |
|`$:/snippets/*` |//inconsistent// |Reusable snippets (will be replaced by macros) |
|`$:/state/*` |lowercase |User interface state tiddlers |
|`$:/tags/*` |~CamelCase |User interface configuration tags |
|`$:/temp/*` |lowercase |Temporary tiddlers that shouldn't be saved |
|`$:/themes/*` |lowercase |Theme plugins |

In the format column:

* ''hyphen-case'' refers to joining multiple lowercase words with hyphens
* ''~CamelCase'' refers to directly joining multiple lowercase words with initial uppercase letters
* ''lowercase'' refers to directly joining multiple lowercase words
* ''inconsistent'' marks namespaces that are currently titled inconsistently
Added some docs about naming conventions for system tiddlers 2014-01-12 19:02:15 +00:00			`created: 20140112190154121`
Lots more docs updates 2014-09-12 15:05:37 +00:00			`modified: 20140912142655205`
			`tags: SystemTiddlers`
Added some docs about naming conventions for system tiddlers 2014-01-12 19:02:15 +00:00			`title: Naming of System Tiddlers`
			`type: text/vnd.tiddlywiki`

			`The system tiddlers provided as part of the core are named according to the following rules:`

			`\|!Namespace \|!Format \|!Description \|`
			\|`$:/*` \|~CamelCase \|Root user interface tiddlers (eg control panel, advanced search) \|
			\|`$:/config/*` \|~CamelCase \|User-oriented configuration setting \|
			\|`$:/core/images/*` \|hyphen-case \|Core images \|
			\|`$:/core/modules/*` \|lowercase \|JavaScript module tiddlers \|
			\|`$:/core/save/*` \|lowercase \|Saving templates for creating TiddlyWiki documents \|
			\|`$:/core/templates/*` \|//inconsistent// \|Templates needed for TiddlyWiki to operate. Currently uses a mix of dashes and periods to separate words \|
			\|`$:/core/ui/*` \|//inconsistent// \|Tiddlers comprising the default user interface of TiddlyWiki. Currently uses a mix of ~CamelCase and lowercase naming conventions \|
			\|`$:/core/wiki/*` \|lowercase \|Metadata about the entire wiki \|
			\|`$:/docs/*` \|lowercase \|Documentation tiddlers \|
			\|`$:/messages/*` \|~CamelCase \|System messages \|
			\|`$:/plugins/*` \|lowercase \|Plugin tiddlers, and plugin content \|
			\|`$:/snippets/*` \|//inconsistent// \|Reusable snippets (will be replaced by macros) \|
			\|`$:/state/*` \|lowercase \|User interface state tiddlers \|
Deprecate `$:/tags/stylesheet` in favour of `$:/tags/Stylesheet` A warning message appears at the top of the story river if any `$:/tags/stylesheet` tags are found. Fixing the first half of #824 2014-09-10 08:13:21 +00:00			\|`$:/tags/*` \|~CamelCase \|User interface configuration tags \|
Added some docs about naming conventions for system tiddlers 2014-01-12 19:02:15 +00:00			\|`$:/temp/*` \|lowercase \|Temporary tiddlers that shouldn't be saved \|
			\|`$:/themes/*` \|lowercase \|Theme plugins \|

			`In the format column:`

			`* ''hyphen-case'' refers to joining multiple lowercase words with hyphens`
Docs: Fix typo 2017-02-21 08:47:00 +00:00			`* ''~CamelCase'' refers to directly joining multiple lowercase words with initial uppercase letters`
Added some docs about naming conventions for system tiddlers 2014-01-12 19:02:15 +00:00			`* ''lowercase'' refers to directly joining multiple lowercase words`
			`* ''inconsistent'' marks namespaces that are currently titled inconsistently`