Template:Polarity/doc
This is a documentation subpage for Template:Polarity. It may contain usage information, categories and other content that is not part of the original template page. |
This template generates a polarity symbol, indicating that a device requires a direct current power supply with either a positive- () or negative-center () coaxial power connector (barrel plug). Alternatively, the template can be used to generate a fullwidth tilde (~), a symbol which indicates alternating current, which some devices require from their barrel-plug power supply.
This template is especially useful for infoboxes such as {{Infobox computing device}}, which have a "power" parameter for giving power consumption specifications. A reliable source backing up the polarity information is required.
Note: Please check to see if the image generated corresponds to the symbol on the device the article is about!
Usage
[edit]This template can used either with named parameters, as in...:
- {{polarity|polarity=positive|size=40}}
...or without:
- {{polarity|positive|40}}
TemplateData
[edit]TemplateData for Polarity
A template for adding a electrical polarity symbol, indicating that a device requires a power supply with either a DC positive-center, DC negative-center, or alternating current (AC) ''barrel plug'' connector.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Polarity | polarity 1 | The polarity of the coaxial power connector/''barrel plug'' connector that the device requires.
| String | required |
Size | size 2 | The size in height of the positive- or negative-center symbol to be displayed, in px. Defaults to 14 (px). Any other measurement (e.g. mm, em, in) is ignored.
| String | optional |