Template

Difference between revisions of "Thingamabob/doc"

From Joomla! Documentation

< Template:Thingamabob
m
 
m (New page: {{documentation subpage}} Returns a generalized term for a page's [http://www.wordreference.com/definition/thingamabob thingamabob] … err … Wotsitcalled? Right … Names...)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
Returns a normalized term for a page's [http://www.wordreference.com/definition/thingamabob thingamabob] ... err ... wotsitcalled? ah: namespace!
+
Returns a generalized term for a page's [http://www.wordreference.com/definition/thingamabob thingamabob] &hellip; err &hellip; Wotsitcalled? Right &hellip; Namespace!
  
The "return value" is used in several templates to create different phrases and categories.
+
The "return value" is used in [{{fullurl:Special:Whatlinkshere/Template:Thingamabob|namespace=10}} several templates] to create different phrases and categories or as a condition where {{tl|main talk file other}} is too generic.
  
 
== Usage ==
 
== Usage ==
Line 19: Line 19:
 
|class="opt"|optional
 
|class="opt"|optional
 
|}
 
|}
 +
 +
== Known issues ==
 +
An attempt to create a plural of the resulting string via <nowiki>{{thingamabob}}</nowiki>'''s''' may look odd or become grammatically wrong. Localisation can be tough and should probably defer the strings to system messages.
 +
 +
The default behaviour is to return <nowiki>{{lc:{{NAMESPACE}}}}</nowiki>, hence if new namespaces are added to the wiki, <nowiki>{{thingamabob}}</nowiki> may require an update to reflect or "rename" the ''content type'' of those namespaces.
  
 
== See also ==
 
== See also ==
* {{tl|main talk file other}}
+
* {{tl|main talk file other}} for a more generic version but an option to return individual labels per namespace group.
  
<!-- REMOVE BLANKS in includeonly-tags and edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE  
+
<!-- edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE  
 
   noteworthy: [[Category:Wiki templates using Extensions]]
 
   noteworthy: [[Category:Wiki templates using Extensions]]
 
-->
 
-->
<includeonly>
+
<includeonly>[[Category:Wiki templates using Extensions|{{PAGENAME}}]]
[[Category:Wiki Macros|{{PAGENAME}}]]
+
[[Category:Template namespace templates|{{PAGENAME}}]]
 
</includeonly>
 
</includeonly>

Revision as of 12:36, 9 May 2008

This is a documentation subpage for Template:Thingamabob.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Thingamabob.

Returns a generalized term for a page's thingamabob … err … Wotsitcalled? Right … Namespace!

The "return value" is used in several templates to create different phrases and categories or as a condition where {{main talk file other}} is too generic.

Usage[edit]

Parameters[edit]

Parameter Parameter description req./opt.
{{{1}}} a supplemental noun such as section or paragraph added to thingamabob optional

Known issues[edit]

An attempt to create a plural of the resulting string via {{thingamabob}}s may look odd or become grammatically wrong. Localisation can be tough and should probably defer the strings to system messages.

The default behaviour is to return {{lc:{{NAMESPACE}}}}, hence if new namespaces are added to the wiki, {{thingamabob}} may require an update to reflect or "rename" the content type of those namespaces.

See also[edit]

  • {{main talk file other}} for a more generic version but an option to return individual labels per namespace group.