View source for Template:Appearance/doc


If you encounter any notable strangeness, need any help, have any suggestions, or want to request any features, please leave a note on [[Template talk:Appearance|this template's talk page]] so that it can be addressed or contemplated. It is currently updated through the third arc of Campaign Three.

== '''Description''' ==
This template is used to create a list of appearances and mentions on a character article that will auto-categorize them into the correct appearances (both at the campaign and arc level) and into the mentioned categories by campaign, such as [[:Category:Characters mentioned in Campaign Two]], [[:Category:Characters in the pre-stream]], and [[:Category:Characters in the Swords and Angels arc]].

=== '''Limitations''' ===
* Not very effective for the articles of main player characters, which will likely take the form of "Appeared in all episodes of Campaign Two, except for...". Categorization for main player characters may need to be done manually instead of using this template.

=== '''Dependencies''' ===
* Uses {{tl|ep}}.

== '''Syntax''' ==
Type <code>{{t|appearance| episode (CxEE) or name of work | type of appearance or mention | optional notes }}</code> somewhere.

* '''1''': The first parameter is the item. This is usually the stream episode in CxEE format. Do not use the {{tl|ep}} template as the template automatically uses this. Use "pre-stream" (with the hyphen) if the appearance or mention is the pre-stream. Otherwise, you can insert anything applicable into this parameter, including the formatted name of a comic or novel, such as <code><nowiki>''[[Kith & Kin]]''</nowiki></code> or <code><nowiki>''[[The Tales of Exandria: The Bright Queen]]''</nowiki></code> or <code><nowiki>''[[Call of the Netherdeep]]''</nowiki></code>.
* '''2''': The second parameter is the type of appearance or mention. The following are valid values and what they output:
** "appear" adds the relevant appeared category
** "mention" outputs "mentioned only" and adds the relevant mentioned category
** "indirect" outputs "indirectly mentioned only". Note, an indirect mention is ''not'' the same as an unnamed mention such as "my brother" or "the marquis".
** "vision" outputs "in a vision" and adds the relevant appeared category
** "scrying" outputs "via ''Scrying''"  and adds the relevant appeared category
** "sending" outputs "via ''Sending''"  and adds the relevant appeared category
** Leaving this blank or not including this at all functions identically to as if you put "appear". If you wish to use the third parameter (see next), you must put "appear". This functionality only works if you do ''not'' intend to insert appearance notes.
** Anything ''other'' than the above will display what you inserted into the parameter and be treated as a ''mention''. To add a type of appearance not covered here ''and'' add the relevant appeared category, use "appear" in the second parameter and put what you wanted into the third parameter (see next). 
{| class="wikitable floatright"
|-
| {{tl|1st}} || {{1st}}
|-
| {{tl|1stID}} || {{1stID}}
|-
| {{tl|1stm}} || {{1stm}}
|-
| {{tl|as}} || {{as}}
|-
| {{tl|DM}} || {{DM}}
|-
| {{tl|jaeger}} || {{jaeger|{{{1}}}}}
|-
| {{tl|flash}} || {{flash}}
|-
| {{tl|imo}} || {{imo}}
|-
| {{tl|mo}} || {{mo}}
|-
| {{tl|po}} || {{po}}
|-
| {{tl|vision}} || {{vision}}
|}
* '''3''': The third parameter is optional notes. Whatever is added to this parameter will be added to the end. It can be formatted. You may consider using one of the following templates in the table at right, though it is not strictly necessary.
* '''nocat''': This is used to prevent the template from adding the relevant mention category. This is intended to be used only for characters who are mentioned in the campaign before they appear because characters who appear in the campaign are discluded from the paired mentioned category. You can enable this by putting anything into this parameter, such as "true", "1", or "yes".
* '''nocomma''': If you do not wish to have a comma between the type of appearance or mention and the optional notes (the third parameter), such as in the case of wanting "mentioned only as the Ruby of the Sea". You can enable this by putting anything into this parameter, such as "true", "1", or "yes". If you use one of the templates in the table at right or manually input a note beginning with a left parenthesis, the template will detect this and automatically remove the comma, so in those cases, it is not necessary to manually set this.

=== '''Examples''' ===
:<code><nowiki>{{appearance|2x98|appear}}</nowiki></code>
:{{appearance|2x98|appear}}

:<code><nowiki>{{appearance|2x72|scrying}}</nowiki></code>
:{{appearance|2x72|scrying}}

:<code><nowiki>{{appearance|pre-stream|vision|as the Traveler|nocomma=true}}</nowiki></code>
:{{appearance|pre-stream|vision|as the Traveler|nocomma=true}}

:<code><nowiki>{{appearance|2x113|mention}}</nowiki></code>
:{{appearance|2x113|mention}}

:<code><nowiki>{{appearance|2x01|appear|first named as the Traveler}}</nowiki></code>
:{{appearance|2x01|appear|first named as the Traveler}}

:<code><nowiki>{{appearance|''[[Explorer's Guide to Wildemount]]''|appear|Figures of Interest entry}}</nowiki></code>
:{{appearance|''[[Explorer's Guide to Wildemount]]''|appear|Figures of Interest entry}}

:<code><nowiki>{{appearance|''[[Kith & Kin]]''|appear|first named as Lyre}}</nowiki></code>
:{{appearance|''[[Kith & Kin]]''|appear|first named as Lyre}}

:<code><nowiki>{{appearance|2x22|appear|{{1st}}}}</nowiki></code>
:{{appearance|2x22|appear|{{1st}}}}

:<code><nowiki>{{appearance|3x04|mention|{{1stm}}}}</nowiki></code>
:{{appearance|3x04|mention|{{1stm}}}}

Note that the following pairs, and ones of similar syntax, are functionally identical and produce the same categorization. 
{| class="wikitable" style="text-align:center"
|-
|<code><nowiki>{{appearance|2x76|Scrying}}</nowiki></code><br/>{{appearance|2x76|Scrying}}
|<code><nowiki>{{appearance|2x76|appear|via ''Scrying''}}</nowiki></code><br/>{{appearance|2x76|appear|via ''Scrying''}}
|-
|<code><nowiki>{{appearance|3x04|vision}}</nowiki></code><br/>{{appearance|3x04|vision}}
|<code><nowiki>{{appearance|3x04|appear|{{vision}}}}</nowiki></code><br/>{{appearance|3x04|appear|{{vision}}}}
|-
|<code><nowiki>{{appearance|2x141|mention}}</nowiki></code><br/>{{appearance|2x141|mention}}
|<code><nowiki>{{appearance|2x141|{{mo}}}}</nowiki></code><br/>{{appearance|2x141|{{mo}}}}
|-
|<code><nowiki>{{appearance|2x80|mention|seen in a painting}}</nowiki></code><br/>{{appearance|2x80|mention|seen in a painting}}
|<code><nowiki>{{appearance|2x80|in a painting}}</nowiki></code><br/>{{appearance|2x80|in a painting}}
|-
|<code><nowiki>{{appearance|2x22|appear}}</nowiki></code><br/>{{appearance|2x22|appear}}
|<code><nowiki>{{appearance|2x22}}</nowiki></code><br/>{{appearance|2x22}}
|}
Again, inserting anything into the second parameter that is not among the canonical uses listed in the section above defaults to a mention, not an appearance. Thus, the output being the same does ''not'' necessarily mean it is identical:
: <span style="color:green">'''Identical:'''</span>
: <code><nowiki>{{appearance|2x76|Scrying}}</nowiki></code> — {{appearance|2x76|Scrying}}
: <code><nowiki>{{appearance|2x76|appear|via ''Scrying''}}</nowiki></code> — {{appearance|2x76|appear|via ''Scrying''}}

: <span style="color:red">'''Not identical:'''</span>
: <code><nowiki>{{appearance|2x99|via ''Speak with Dead''}}</nowiki></code> — {{appearance|2x99|via ''Speak with Dead''}}
: <code><nowiki>{{appearance|2x99|appear|via ''Speak with Dead''}}</nowiki></code> — {{appearance|2x99|appear|via ''Speak with Dead''}}

: <span style="color:red">'''Not identical:'''</span>
: <code><nowiki>{{appearance|2x36|appear|{{1st}}}}</nowiki></code> — {{appearance|2x36|appear|{{1st}}}}
: <code><nowiki>{{appearance|2x36|{{1st}}}}</nowiki></code> — {{appearance|2x36|{{1st}}}}

<includeonly><!-- Categories for the template: -->[[Category:General wiki templates]]</includeonly><noinclude><!-- Categories for this documentation: -->[[Category:Template documentation]]</noinclude>