Template:Term/Documentation: Difference between revisions

Jump to navigation Jump to search

Template:Term/Documentation (view source)

Revision as of 17:40, 1 December 2022

8,517 bytes added ,  1 December 2022
no edit summary
(Created page with "==Purpose== Returns the proper term for any given topic in {{TLoZ|Series}}. Terms are stored using Template:Terminology/Store. ==Usage== {{NoWikiTemp|Normal|<topic>|<gam...")
 
No edit summary
 
(37 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Purpose==
==Purpose==
Returns the proper term for any given topic in {{TLoZ|Series}}. Terms are stored using [[:Template:Terminology/Store]].
Returns the proper singular form of a term for any given topic in {{TLoZ|Series}}. Terms are stored using [[:Template:Term/Store]].
 
'''Note:'''
To return the plural form of a term, see [[:Template:Plural]].


==Usage==
==Usage==
{{NoWikiTemp|Normal|<topic>|<game>|link}}
{{NoWikiTemp|Normal|<game>|<topic>|link|display{{=}}}}
 
{{Parameter|<game>     |The game from which to fetch the term of the given topic. Defaults to <code>Series</code>.|Required}}
{{Parameter|<topic>    |The name of the page of said topic. (ex: <code>Boss Key</code> for <code>Nightmare Key</code> and <code>Big Key</code>)|Required}}
{{Parameter|link        |Entering anything in this field will output the result as a link. (Enter <code>link</code> for standardization)|Optional}}
{{Parameter|display{{=}}|Alternative display return value. See below.|Optional}}
 
===Examples===
{{Examples
|<nowiki>{{Term|Series|Big Key}}</nowiki>
|<nowiki>{{Term|Series|Big Key|link}}</nowiki>
|<nowiki>{{Term|ALttP|Big Key}}</nowiki>
|<nowiki>{{Term|ALttP|Big Key|link}}</nowiki>
|<nowiki>{{Term|LA|Big Key}}</nowiki>
|<nowiki>{{Term|LA|Big Key|link}}</nowiki>
|<nowiki>{{Term|LADX|Big Key}}</nowiki>
|<nowiki>{{Term|LADX|Big Key|link}}</nowiki>
|<nowiki>{{Term|TP|Big Key}}</nowiki>
|<nowiki>{{Term|TP|Big Key|link}}</nowiki>
|<nowiki>{{Term|TPHD|Big Key|display= Key}}</nowiki>
|<nowiki>{{Term|TPHD|Big Key|link|display= Key}}</nowiki>
|<nowiki>{{Term|BotW|Kara Kara Bazaar|link|display=General Store|section=Shaillu's General Store}}</nowiki>
|<nowiki>{{Term|TMC|Swordsman Newsletter #1}}</nowiki>
}}
 
====Error Handling====
{{Examples
|<nowiki>{{Term|Series|A Link to the Past}}</nowiki>
|<nowiki>{{Term|fakeGame|Big Key}}</nowiki>
|<nowiki>{{Term|OoT|fakeTerm}}</nowiki>
|<nowiki>{{Term|fakeGame|fakeTerm}}</nowiki>
|<nowiki>{{Term|Series|miniblin}}</nowiki>
|- Detection of redundant <code>display</code> arguments
|<nowiki>{{Term|TMC|Treasure Chest|display= Chest}}</nowiki>
|<nowiki>{{Plural|TMC|Treasure Chest|display= Chests}}</nowiki>
}}
 
====Contextual Examples====
Let's assume that you are writing an article about a {{Term|ALBW|Dungeon}} in {{ALBW}}. In that section about {{ALBW|-}}, you would use <code>ALBW</code> as the <code>game</code> parameter to fetch the latest canon terms for that game. Here's an example of that happening:
<pre>
In {{ALBW}}, the {{Term|ALBW|House of Gales|link}} is the third {{Term|ALBW|Dungeon|link}} in {{Term|ALBW|Hyrule|link}}. The {{Term|ALBW|Big Key|link}} is needed to access the {{Term|ALBW|Boss|link}}.
</pre>
 
'''Result:''' In {{ALBW}}, the {{Term|ALBW|House of Gales|link}} is the third {{Term|ALBW|Dungeon|link}} in {{Term|ALBW|Hyrule|link}}. The {{Term|ALBW|Big Key|link}} is needed to access the {{Term|ALBW|Boss|link}}.
 
For games with remakes such as {{LA|-}} and {{OoT|-}}, unless you are specifically referring to the original version of the game, you should use the latest iteration of the remakes (<code>LANS</code> for {{LA|-}} and <code>OoT3D</code> for {{OoT|-}} and so on) to make sure to account for terms that might have been changed in said remakes.
<pre>
In {{LA}}, the {{Term|LANS|Tail Cave|link}} is the first {{Term|LANS|Dungeon|link}} on {{Term|LANS|Koholint Island|link}}. The {{Term|LANS|Big Key|link}} is needed to access the {{Term|LANS|Boss|link}}.
</pre>
 
'''Result:''' In {{LA}}, the {{Term|LANS|Tail Cave|link}} is the first {{Term|LANS|Dungeon|link}} on {{Term|LANS|Koholint Island|link}}. The {{Term|LANS|Big Key|link}} is needed to access the {{Term|LANS|Boss|link}}.
 
===Keyboard Shortcuts===
The [[MediaWiki:Gadget-Hotkeys.js|Hotkeys gadget]], which is enabled by default, adds keyboard shortcuts for inserting terms.
{{#lst:MediaWiki:Gadget-Hotkeys|shortcuts}}
 
<gallery widths="800px" heights="400px">
File:Hotkeys.mov|Using Hotkeys to insert terms
File:Hotkeys Term Links.mov|Using Hotkeys to replace ordinary links
</gallery>
 
==Guidelines==
The Term template was created to accurately reflect the ever-changing nature of terminology in {{TLoZ|Series}}. Maintaining our use of terminology across the series is important for preserving the canon of each game.
 
The Term template itself is broken down into four fields of specification. The first two fields are required, while the latter two give you some control over what the template displays.
 
:<code><nowiki>{{Term|</nowiki></code>GAME<code>|</code>NAME<code>|</code>LINK<code>|</code>DISPLAY<code><nowiki>}}</nowiki></code>
 
We will use {{Term|OoT3D|Link}} from {{OoT3D|-}} as an example. To refer to {{Term|OoT3D|Link}} from this game, all we have to enter is:
 
:<code><nowiki>{{Term|OoT3D|Link}}</nowiki></code>


{{Parameter|<topic>|The name of the page of said topic. (ex: <code>Boss Key</code> for <code>Nightmare Key</code> and <code>Big Key</code>)|Required}}
But if we want to turn this into a link to {{Term|OoT3D|Link}}'s page, we would just append <code>|link</code> at the end just before the closing brackets, like so:
{{Parameter|<game> |The game from which to fetch the term of the given topic.|Required}}
 
{{Parameter|link  |Entering anything in this field will output the result as a link. (Enter <code>link</code> for standardization)|Optional}}
:<code><nowiki>{{Term|OoT3D|Link|link}}</nowiki></code>
 
And if we wanted to refer to {{Term|OoT3D|Link}} from {{OoT3D|-}} by his most famous title, we can use the fourth field to change what text is shown:
 
:<code><nowiki>{{Term|OoT3D|Link|link|display=Hero of Time}}</nowiki></code>
 
It's also optional to include the third field when using the fourth display field.
 
:<code><nowiki>{{Term|OoT3D|Link|display=Hero of Time}}</nowiki></code>
 
:''Note: the display field is handy, but it should be used sparingly. The point of the Term template is to keep consistent names in a given section. Also be sure to not use the display field to display plural forms of names. The [[Template:Plural|Plural template]] exists for that purpose.''
 
What about other examples? {{Term|OoT3D|Link}}'s name doesn't change, but there are many cases where names do change between games. A good example for this is {{Term|Series|Dynalfos}}. In the main series [[Guidelines:Canon|Canon]], {{Plural|Series|Dynalfos}} have two operative names between three games and even more official (but non-canon) names.
 
<gallery>
File:OoT Dinolfos Model.png|{{Big|{{Term|OoT3D|Dinolfos}}}}<br/>{{Small|{{OoT|-}}}}
File:MM Dinolfos Model.png|{{Big|{{Term|MM3D|Dinolfos}}}}<br/>{{Small|{{MM|-}}}}
File:TP Dynalfos Model.png|{{Big|{{Term|TPHD|Dynalfos}}}}<br/>{{Small|{{TP|-}}}}
</gallery>
 
To make the situation more complicated, the {{Term|MM|Dinolfos}} in {{MM|-}} were originally known as ''{{Term|MM|Dinolfos|display=Dinofols}}''. We should never use "{{Term|MM|Dinolfos|display=Dinofols}}" to refer to them because this was corrected later on. Despite this, it still remains an official name and there is still support for if someone were to try to use this non-canon name for {{Term|Series|Dinolfos}} with the Term template.
 
So how does one know which name is appropriate to use for each instance? That is dependent on how the terms are stored. Term storage is explained in greater detail on the [[Template:Term/Store#Guidelines|Term/Store template page]], but this guideline assumes that the term you want to use has already been stored.
 
Ultimately all that is necessary for using the Term template with a page is that the proper name is used in the second field (after the game has been listed). It's important to keep in mind that the Term template isn't magical. It '''doesn't create names''', but rather checks for names on the page you specify in the second field. For names of articles that have parentheses, you have to include the full name of the page ''with'' the parentheses in the second field. This tells it to look at that page and return with whatever works best with the game listed in the first field. If no name for that given game is specified on that page, it will try to use whatever is listed as the "Series" name.
 
So let's look at some examples for {{Plural|Series|Dynalfos}} with each of the names mentioned above.


===Example===
{| class="wikitable"
{| class="wikitable"
! Input
! Output
|-
|-
| <code><nowiki>{{Terminology|ALttP|Big Key}}</nowiki></code>
!style="width:50%"| Input
| {{Terminology|ALttP|Big Key}}
!style="width:50%"| Output
|-
|-
| <code><nowiki>{{Terminology|LA|Big Key}}</nowiki></code>
| <nowiki>{{Term|OoT3D|Dynalfos}}</nowiki><br/><nowiki>{{Term|OoT3D|Dinolfos}}</nowiki><br/><nowiki>{{Term|OoT3D|Dinofols}}</nowiki>
| {{Terminology|LA|Big Key}}
| {{Term|OoT3D|Dynalfos}}<br/>{{Term|OoT3D|Dinolfos}}<br/>{{Term|OoT3D|Dinofols}}
|-
|-
| <code><nowiki>{{Terminology|TP|Big Key}}</nowiki></code>
| <nowiki>{{Term|MM3D|Dynalfos}}</nowiki><br/><nowiki>{{Term|MM3D|Dinolfos}}</nowiki><br/><nowiki>{{Term|MM3D|Dinofols}}</nowiki>
| {{Terminology|TP|Big Key}}
| {{Term|MM3D|Dynalfos}}<br/>{{Term|MM3D|Dinolfos}}<br/>{{Term|MM3D|Dinofols}}
|-
| <nowiki>{{Term|TPHD|Dynalfos}}</nowiki><br/><nowiki>{{Term|TPHD|Dinolfos}}</nowiki><br/><nowiki>{{Term|TPHD|Dinofols}}</nowiki>
| {{Term|TPHD|Dynalfos}}<br/>{{Term|TPHD|Dinolfos}}<br/>{{Term|TPHD|Dinofols}}
|}
|}
:''Note: without the [[Template:Synonym|Synonym template]] being used on redirect pages for <code>Dinolfos</code> and <code>Dinofols</code>, neither would work properly for these names. The Synonym template borrows whatever is stored on the page that is being redirected to, so it's important that the names are all properly stored before using the Synonym template on redirects. For more details, refer to the documentation for the [[Template:Term/Store|Term/Store template]] and the [[Template:Synonym|Synonym template]].''
What would happen if you were to try using a term that has not been stored? The Term template would display whatever is entered as a name and link to it while displaying a message stating that the term is invalid or missing when a mouse is moved over the link. Because of this, you should ''never'' use a name that you do not know to be an actual term. To determine what constitutes terminology, check out the [[Guidelines:Terminology|terminology guidelines]].
{{Guidelines Nav}}


{{Documentation Footer}}
{{Documentation Footer}}
Retrieved from "https://zeldawiki.wiki/wiki/Special:MobileDiff/699873...978912"

Navigation menu