Template:Usage
From YPPedia
Usage
These usage notes will not be included in articles bearing this template.
{{{1}}}
Usage
These usage notes will not be included in articles bearing this template.
This template is used to provide usage directions on templates, boilerplates, message boxes, and the like. Remember to wrap it (and any line breaks) in <noinclude> tags! If you forget to use nowiki tags on vertical pipes ( | ), the template will still work, but font following the first error will appear in bright red, indicating a faulty template. This template can accommodate up to 5 such errors, before cutting off and no longer including any more text.
Good usage notes include things like:
- Links to similar templates (See template:stub and template:sword-type for examples of good linking)
- Instructions on how to use it properly, especially how to use a "piped" template (See template:cobalt for an example)
- DO and DON'T instructions. (These are just as much about telling people when to use them, as it is about telling people when other templates might be more appropriate.)
- Explains why the template is necessary. Justify its existence... explain to a brand new user why they should use template:ice instead of just linking to the island manually and directly.
