TemplateDoc:Ref/Note: Difference between revisions

From Halopedia, the Halo wiki

(started doc page)
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Notice/TemplateDoc}}
{{Notice/TemplateDoc}}
==Description==
This template should be used to create a Note that on a page for whatever reason and indicate the group where the note should be placed. If you are looking to reuse notes see [[Template:Ref/NoteReuse]], if you are looking for how to list notes on a page see [[Template:Ref/Notes]]. If it is just a normal reference you need see [[Template:Ref]] for a full list of reference templates.


==Usage==
==Usage==
This template should be used to indicate the group where the citation should be placed. If it is just a normal reference, then no group should be specified. For more reference templates, see [[Template:Ref]].
===Example note===
 
<pre><nowiki>
<pre><nowiki>
{{Ref/Note
{{Ref/Note|Id=H5GVisors|To avoid unnecessary clutter caused by redundant citations, all subsequent entries are cited using the Halo 4 and Halo 5: Guardians Spartan Armor menus.}}</nowiki></pre>  
|Id=
|Text=
}}</nowiki></pre>  
   
   
===Fields===
===Fields===
{| width=100% class=wikitable  
{| width=100% class=wikitable  
!Field Name
!Field Name
!Aliases
!Optional or Required?
!Optional or Required?
!Description
!Description
Line 18: Line 18:
|-
|-
|'''Id'''
|'''Id'''
| -
|''Recommended''
|''Recommended''
|An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not '''Required''' it is recommended to give every source a unique <code>Id</code> for future use.
|An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not '''Required''' it is recommended to give every source a unique <code>Id</code> for future use.
Line 23: Line 24:
|-
|-
|'''1''' {{c|unnamed}}
|'''1''' {{c|unnamed}}
|Text
|'''Required'''
|'''Required'''
|Text, the name of the group.
|This is the main reason for this template. Put in whatever relevant note is required.
|<pre>Note</pre>
|<pre>To avoid unnecessary clutter caused by redundant citations, all subsequent entries are cited using the Halo 4 and Halo 5: Guardians Spartan Armor menus.</pre>
|}
|}


[[Category:Reference template documentation]]
[[Category:Reference template documentation]]

Latest revision as of 11:44, June 9, 2023

This is a template documentation page!
You cannot edit the associated template from here. To do so, please see Template:Ref/Note instead!

Description[edit]

This template should be used to create a Note that on a page for whatever reason and indicate the group where the note should be placed. If you are looking to reuse notes see Template:Ref/NoteReuse, if you are looking for how to list notes on a page see Template:Ref/Notes. If it is just a normal reference you need see Template:Ref for a full list of reference templates.

Usage[edit]

Example note[edit]

{{Ref/Note|Id=H5GVisors|To avoid unnecessary clutter caused by redundant citations, all subsequent entries are cited using the Halo 4 and Halo 5: Guardians Spartan Armor menus.}}

Fields[edit]

Field Name Aliases Optional or Required? Description Example
Id - Recommended An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not Required it is recommended to give every source a unique Id for future use. HW2OSG
1 (unnamed) Text Required This is the main reason for this template. Put in whatever relevant note is required.
To avoid unnecessary clutter caused by redundant citations, all subsequent entries are cited using the Halo 4 and Halo 5: Guardians Spartan Armor menus.