Template:Documentation/Doc: Difference between revisions

From My Wiki
Jump to navigation Jump to search
VisualWikitext
imported>Tlosk
(Created page with '{{Related|Wiki Templates}} == Syntax == <pre> <noinclude>{{Documentation}}</noinclude> </pre> == Usage == * This template is used to insert documentation on template pages. * P…')
 
(Created page with "{{Related|Wiki Templates|Page Templates}} == Syntax == <pre> {{Intro | Patch Introduced = | Related Quests = | Updated = }} </pre> <pre> {{Intro | Patch Introduced = [[<Patch>]] | Related Quests = [[<Quest>]], [[<Quest>]] | Updated = [[<Patch>]], [[<Patch>]] | Retired Versions = [[<Page>|1]], [[<Page>|2]] | Current Version = [[<Page>]] | Rare Number = <Number> }} </pre> == Usage == This is a component template that is used within...")
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Related|Wiki Templates}}
{{Related|Wiki Templates|Page Templates}}
== Syntax ==
== Syntax ==
<pre>
<pre>
<noinclude>{{Documentation}}</noinclude>
{{Intro
| Patch Introduced =
|  Related Quests =
|          Updated =
}}
</pre>
 
<pre>
{{Intro
| Patch Introduced = [[<Patch>]]
|  Related Quests = [[<Quest>]], [[<Quest>]]
|          Updated = [[<Patch>]], [[<Patch>]]
| Retired Versions = [[<Page>|1]], [[<Page>|2]]
|  Current Version = [[<Page>]]
|      Rare Number = <Number>
}}
</pre>
</pre>


== Usage ==
== Usage ==
* This template is used to insert documentation on template pages.
This is a component template that is used within many [[Page Templates]] and displays the patch introduced, related quests and patches when the item was updated. Leave blank any sections that do not apply. Items should be enclosed in link brackets <nowiki>( [[ ]] )</nowiki>.
* Place at the end of the template code.  
 
* Create a subpage called "Template Name/Doc" where the template's documentation will be stored.
 
If an item is a [[Rare]], setting <code>Rare Number = <??></code> will categorize the page as a rare and display a link in the upper right. For non-rares simply leave this value out all together.


Segregating documentation to a subpage means that updates to the documentation don't cause large numbers of pointless template updates across the wiki, and the template itself can be protected if necessary (without protecting the documentation). That is, each time a change is made to a template, all pages that use that template are updated, which can be significant for widely used templates. Similarly, when changes are needed to a widely used template, experiment first on {{tl:Sandbox}} so only a single change will be needed to the template itself.


You can display prominent links to retired versions on the page for the current version, and vice versa, by adding the appropriate parameter shown above (you can delete parameters that don't apply).


<includeonly><noinclude>[[Category:Template Documentation]]</noinclude>
<noinclude>
[[Category:Template Documentation]]
</noinclude>

Latest revision as of 23:24, 16 January 2024

Related topics: Wiki Templates, Page Templates

Syntax

{{Intro
 | Patch Introduced = 
 |   Related Quests = 
 |          Updated = 
}}

{{Intro
 | Patch Introduced = [[<Patch>]]
 |   Related Quests = [[<Quest>]], [[<Quest>]]
 |          Updated = [[<Patch>]], [[<Patch>]]
 | Retired Versions = [[<Page>|1]], [[<Page>|2]]
 |  Current Version = [[<Page>]]
 |      Rare Number = <Number>
}}

Usage

This is a component template that is used within many Page Templates and displays the patch introduced, related quests and patches when the item was updated. Leave blank any sections that do not apply. Items should be enclosed in link brackets ( [[ ]] ).


If an item is a Rare, setting Rare Number = <??> will categorize the page as a rare and display a link in the upper right. For non-rares simply leave this value out all together.


You can display prominent links to retired versions on the page for the current version, and vice versa, by adding the appropriate parameter shown above (you can delete parameters that don't apply).

Retrieved from "https://loresraat.org/index.php?title=Template:Documentation/Doc&oldid=262537"