Template:Appearance/doc

''' This template is not fully tested, and it is not all that ready to be used in mainspace at this time. '''

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 and Category:Characters appearing in pre-stream.

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 ep.

Syntax
Type  somewhere.


 * 1: The first parameter is the item. This is usually the stream episode in CxEE format. Do not use the 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.
 * 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"
 * "vision" outputs "in a vision" and adds the relevant appeared category
 * "scrying" outputs "via Scrying" and adds the relevant appeared category
 * 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 bullet).
 * 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



 * ...produces...



Note that the following pairs, and ones of similar syntax, are functionally identical and produce the same categorization. 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:
 * Identical:


 * Not identical: