Template:Mod Header/Doc
From Starfield Wiki
Summary[edit]
This template places one or more mod icons on the top right of the screen. On the main page for a mod, it can also be used to save information about the mod for use on other pages.
Parameters[edit]
| Parameter | Scope | Description |
|---|---|---|
| 1+ | required | The page names of one or more mods (minus the namespace—use ns_base for that, if needed). The referenced page(s) must contain a {{Mod Header}} with any necessary mod data (see below) included in it. |
| ns_base | optional | Namespace of the mod page(s). Defaults to NAMESPACE if not specified. |
| Mod Data | ||
| If any of these are specified, all of them will be evaluated and saved. These should only be used on a mod's base page, nowhere else. | ||
| icon | optional | The file name of the icon. |
| iconSize | optional | The size of the icon in px (without the "px" at the end). |
| modlabel | optional | The label for the mod (default: page name stripped of any disambiguation). |
| shortcut | optional | The shortcut template for the mod. Note that, like all saved data, even if a template is specified, it will be expanded to hard-coded wiki code on saving. In the event that the wiki code changes, it may take some time to propagate to all pages.
Example: |
| default | optional | Specify any value to force all mod data to use the default values. It allows the template to determine and update whatever values need to be saved without having to specify any of them redundantly. |
| inherit | optional | If specified, this will take all of the above values from the parent page itself instead of needing to pass them to the template. |
Returns[edit]
On dedicated mod pages (i.e., where only a single mod is specified in the Mod Header call), the root page of the mod will be returned in modheaderpage for other templates to use.
Example[edit]
{{Mod Header|Dragonhold|Thieves Guild}}
In Online space, places the icons seen at the top right of this page.
Notes[edit]
- Where the mod's page name is different from the parameter used for this template, the list of exceptions under {{Mod Header/Indicator}} needs to be updated. For example,
{{Mod Header|Markarth}}links to Online:Markarth (DLC).
