Template:Mosnav/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
No edit summary
No edit summary
Tags: Mobile edit Mobile web edit
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''{{tlx|mosnav}}''' is a template that puts a navigation strip, much like the one used for forum threads, at the top of a page.  It should be used only on pages of the manual of style; hence: '''mos'''nav.   
'''{{tlx|mosnav}}''' is a template that puts a navigation strip at the top of a page.  It should be used only on policy pages, which belong to the [[tardis:manual of style|manual of style]]; hence: '''mos'''nav.   


==Usage==
== Usage ==
To use, follow this simple pattern:
To use, follow this simple pattern:
*{{tlx|mosnav|1|2|3|c}}
<pre>{{mosnav|p=parent chapter name|c=category name}}</pre>
where 1, 2, and 3 are any pages related to — or, ''in the same chapter as'' — the current page.  All are optional, and if you type {{tlx|mosnav}} alone, it sill simply put the current page in the nav bar like so:
{{mosnav}}
This, however, is not very helpful, because it allows you to navigate only back to the page [[Tardis:Manual of style]].


The variable ''c'' can and should be set to a name for the chapter, so that all pages in that chapter can be organised under a single category.  The resulting category would then go into [[:Category:Manual of style]].
Often, but not always, ''p'' and ''c'' have the same value, as can be seen at [[T:COMMA]].  Both ''p'' and ''c'' must be defined for the template to work properly.
 
The template will produce a navigation scheme which automatically includes all pages in the category specified.
 
(Policies and support pages marked outdated are excluded from the output.)
 
== Optional feature ==
Sometimes, certain pages in the manual of style will have relevance to other parent chapters.  In this case you can add the variable {{tt|you may{{=}}}} to suggest links to other chapters.  A good example of this usage can be found at [[Tardis:Naming conventions]].  Note that this {{{you may}}} is a little different from ''the template'' {{tlx|you may}} in that it is entirely free-form.  Since the cases where you'd need to employ the variable {{tt|you may}} are relatively rare, it was important to give maximum flexibility.  The downside is that you have to remember to add linking brackets, like this:
 
<pre>{{mosnav|p=parent|c=category|you may=[[this page]] or [[that page]]}}</pre>
 
== Historical note ==
This template was entirely redesigned and automated at 01:47, February 18, 2013 (UTC).  Prior to this date, it was necessary to add each and every page to the template by hand.  Thus, you will still find a number of pages that contain a number of superfluous parameters. '''These do not work''', but it is not imperative to remove them, since they are harmless.  The ''only'' things this template requires are values for ''p'' and ''c''.


A more full-bodied example of this template is:
:{{tt|<nowikI>{{mosnav|Redlinks|Wikify wisely|c=wikification}}</nowiki>}}
which produces:
{{mosnav|Redlinks|Wikify wisely|}}
Note that the namespace '''Tardis:''' is already assumed.  All you need is the page name, not the ''full'' page name.  Also, see how the current page name, '''Mosnav''', is put into the navigation bar by default.  Obviously, if you were to put this particular example on [[Tardis:Don't over-wikify]], it would make a little more sense.
== Thanks ==
== Thanks ==
This template owes some debt to [[memoryalpha:template:mos nav]] — though not quite so much as the name suggests.  This is basically just an adaptation of the basic {{tlx|forumheader}} template which is a default part of the Wikia MediaWiki installation.
This template's name and earliest function owed a debt to [[memoryalpha:template:mos nav]].  However, its code barely resembles that MemAlpha template much anymore.  
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 02:50, 28 February 2024

{{mosnav}} is a template that puts a navigation strip at the top of a page. It should be used only on policy pages, which belong to the manual of style; hence: mosnav.

Usage

To use, follow this simple pattern: 

{{mosnav|p=parent chapter name|c=category name}}

Often, but not always, p and c have the same value, as can be seen at T:COMMA. Both p and c must be defined for the template to work properly.

The template will produce a navigation scheme which automatically includes all pages in the category specified.

(Policies and support pages marked outdated are excluded from the output.)

Optional feature

Sometimes, certain pages in the manual of style will have relevance to other parent chapters. In this case you can add the variable you may= to suggest links to other chapters. A good example of this usage can be found at Tardis:Naming conventions. Note that this {{{you may}}} is a little different from the template {{you may}} in that it is entirely free-form. Since the cases where you'd need to employ the variable you may are relatively rare, it was important to give maximum flexibility. The downside is that you have to remember to add linking brackets, like this: 

{{mosnav|p=parent|c=category|you may=[[this page]] or [[that page]]}}

Historical note

This template was entirely redesigned and automated at 01:47, February 18, 2013 (UTC). Prior to this date, it was necessary to add each and every page to the template by hand. Thus, you will still find a number of pages that contain a number of superfluous parameters. These do not work, but it is not imperative to remove them, since they are harmless. The only things this template requires are values for p and c.

Thanks

This template's name and earliest function owed a debt to memoryalpha:template:mos nav. However, its code barely resembles that MemAlpha template much anymore.

Retrieved from "https://tardis.wiki/w/index.php?title=Template:Mosnav/doc&oldid=3722654"