Template:Gov/doc: Difference between revisions
Jump to navigation
Jump to search
(create) |
(add desc param) |
||
| Line 11: | Line 11: | ||
*second unnamed parameter: the position to look up. Do not use a plural form. | *second unnamed parameter: the position to look up. Do not use a plural form. | ||
*'''bull''' (optional): you can use this to force the list of officeholders to be bulleted or not. By default, single-incumbent offices are not bulleted and multi-incumbent ones are. This must be either "yes" or "no". | *'''bull''' (optional): you can use this to force the list of officeholders to be bulleted or not. By default, single-incumbent offices are not bulleted and multi-incumbent ones are. This must be either "yes" or "no". | ||
*'''desc''' (optional): use this to show a description of any special duties for the given officeholder, if any, as described in the list module. If not specified, the description will not be shown even if it is present. This parameter only needs to be any non-empty text to work, such as "x" or "yes". | |||
==Examples== | ==Examples== | ||
| Line 16: | Line 17: | ||
*<code><nowiki>{{gov|NationStates|Emperor}}</nowiki></code> produces: {{gov|Cyber Nations|Emperor}} | *<code><nowiki>{{gov|NationStates|Emperor}}</nowiki></code> produces: {{gov|Cyber Nations|Emperor}} | ||
*<code><nowiki>{{gov|Cyber Nations|Imperial Officer|bull=no}}</nowiki></code> produces: {{gov|Cyber Nations|Imperial Officer|bull=no}} | *<code><nowiki>{{gov|Cyber Nations|Imperial Officer|bull=no}}</nowiki></code> produces: {{gov|Cyber Nations|Imperial Officer|bull=no}} | ||
*<code><nowiki>{{gov|Cyber Nations|Imperial Officer|bull=no|desc=yes}}</nowiki></code> produces: {{gov|Cyber Nations|Imperial Officer|bull=no|desc=yes}} | |||
<includeonly></includeonly> | <includeonly></includeonly> | ||
Revision as of 02:05, 5 July 2021
This page contains the documentation for Template:Gov. It includes information about the template, such as usage and categories, and is not displayed when using the template itself.
This template is used to retrieve the current officeholders of government positions, in order to make pages easier to maintain.
This template makes use of Lua code at Module:Government. Please use the template rather than invoking the module directly.
To update current government, see Module:Government/list. To update shortcut position names, see Module:Government.
Parameters
- first unnamed parameter: the game or category to look up. It must be capitalized and spelled/spaced correctly for links to work.
- second unnamed parameter: the position to look up. Do not use a plural form.
- bull (optional): you can use this to force the list of officeholders to be bulleted or not. By default, single-incumbent offices are not bulleted and multi-incumbent ones are. This must be either "yes" or "no".
- desc (optional): use this to show a description of any special duties for the given officeholder, if any, as described in the list module. If not specified, the description will not be shown even if it is present. This parameter only needs to be any non-empty text to work, such as "x" or "yes".
Examples
{{gov|Community|Administrator}}produces:- Lord of Darkness
- Frawley
- Jesse End
{{gov|NationStates|Emperor}}produces: Lord of Darkness{{gov|Cyber Nations|Imperial Officer|bull=no}}produces: DeathAdder, Emperor Ice, SynysterGates, Tebeat{{gov|Cyber Nations|Imperial Officer|bull=no|desc=yes}}produces: DeathAdder (military/diplomacy), Emperor Ice (military/economy), SynysterGates, Tebeat (internal)