Editing Template:Coa/doc

This template is part of a group of templates that link image files to specific houses, persons, and organizations.

== Usage ==
=== Templates ===
* {{tl|coa}} shows the symbol only and links to the shown entity. {{tl|coa|Targaryen}} → {{coa|Targaryen}}
* {{tl|coa-link}} shows the symbol and text, and it links to the shown entity. {{tl|coa-link|Targaryen}} → {{coa-link|Targaryen}}
* {{tl|coa-file}} shows the file name of the image only. {{tl|coa-file|Targaryen}} → {{coa-file|Targaryen}}

===Symbol (Parameter 1)===
The first parameter is the entity whose symbol should be shown.

A good amount of flexibility is afforded the user. For example, <code>Targaryen</code>, <code>House Targaryen</code>, <code>targaryen</code>, <code>House Targaryen.svg</code>, <code>housetargaryen</code>, and more all lead to the same result.

{| class="wikitable"
|-
! Code !! Result
|-
| {{tl|coa-link|Targaryen}} || {{coa-link|Targaryen}}
|-
| {{tl|coa-link|Wyl}} || {{coa-link|Wyl}}
|-
| {{tl|coa-link|Longwaters}} || {{coa-link|Longwaters}}
|-
| {{tl|coa-link|Brook}} || {{coa-link|Brook}}
|-
| {{tl|coa|Targaryen}} || {{coa|Targaryen}}
|-
| {{tl|coa|Wyl}} || {{coa|Wyl}}
|-
| {{tl|coa|Brook}} || {{coa|Brook}}
|-
| {{tl|coa|Longwaters}} || {{coa|Longwaters}}
|-
| {{tl|coa-file|Targaryen}} || {{coa-file|Targaryen}}
|-
| {{tl|coa-file|Wyl}} || {{coa-file|Wyl}}
|-
| {{tl|coa-file|Longwaters}} || {{coa-file|Longwaters}}
|-
| {{tl|coa-file|Brook}} || {{coa-file|Brook}}
|}

=== Size (Parameter 2) ===
The second parameter represents the size. The following values are accepted:
* For use in text: {{tl|coa|Targaryen|xs}} → {{coa|Targaryen|xs}}
* For minor elements in lists: {{tl|coa|Targaryen|s}} → {{coa|Targaryen|s}}
* For major elements in lists: {{tl|coa|Targaryen|m}} → {{coa|Targaryen|m}}
* {{tl|coa|Targaryen|l}} → {{coa|Targaryen|l}}
* {{tl|coa|Targaryen|xl}} → {{coa|Targaryen|xl}}

=== Other parameters (not recommended) ===
There are other parameters for use cases that are not included above. It is recommended NOT to use these parameters.

* <code>link</code>: Article that should be linked to. {{tl|coa-link|Targaryen|link=House Lannister}} → {{coa-link|Targaryen|link=House Lannister}}
* <code>text</code>: Text to be displayed. {{tl|coa-link|Targaryen|text=House Lannister}} → {{coa-link|Targaryen|text=House Lannister}}

== Updating the COAs ==
In order to update the image for an entity, or to add a new entity, one must edit [[:Module:Coa/data]].

Every entry in the module consists of the following:
* Main key
** Must only contain lowercase letters and optionally numbers
** Must not contain whitespace characters
** Must not start with "House"
** Must not contain the words "of" and "the"
** Must represent the house/person/entity uniquely
* <code>file</code>: The image file
** When missing, defaults to <code>None.svg</code>
* <code>page</code>: The article name. Mandatory
* <code>name</code>: The name to be displayed. Only necessary if different from <code>article</code>

== List of keys ==
For a list of all accepted keys, see [[:Template:Coa/list]].

For a list of all keys pointing to PNG images, see [[:Template:Coa/pnglist]].
<includeonly>[[Category:Coat of arms templates]]</includeonly>