Difference between revisions of "Template:Mod/doc"

From Wildermyth Wiki
(Mods template doc page)
 
(Add documentation for coremod and external page)
Line 10: Line 10:
; ''mod name'' : Name of the mod
; ''mod name'' : Name of the mod


; ''link'' : Name of the root wiki page for this mod, e.g. "mods/myCoolMod"
; ''link'' : If <code>external</code> is not set, tame of the root wiki page for this mod, e.g. "mods/myCoolMod". Otherwise the link to an external page.
 
; ''external'': If set, <code>link</code> will be treated as an external link.
 
; ''coremod'': If set, the text will say 'coremod' instead of 'mod'


== Example ==
== Example ==
Line 19: Line 23:


{{Mod|My Cool Mod|mods/myCoolMod}}
{{Mod|My Cool Mod|mods/myCoolMod}}
<pre><nowiki>
{{Mod|My Cool Mod|https://example.com|external=true|coremod=true}}
</nowiki></pre>
{{Mod|Example|https://example.com|external=true|coremod=true}}


<includeonly>[[Category:Template]]</includeonly>
<includeonly>[[Category:Template]]</includeonly>

Revision as of 19:43, 17 September 2025

This is a documentation subpage for Template:Mod.

Usage

This template should be used at the top of any wiki page about modded content. (Modded content should always be put in a subfolder of the form wildermyth.com/wiki/mods/[myModName]/[pageName])

This template uses the following parameters:

mod name
Name of the mod
link
If external is not set, tame of the root wiki page for this mod, e.g. "mods/myCoolMod". Otherwise the link to an external page.
external
If set, link will be treated as an external link.
coremod
If set, the text will say 'coremod' instead of 'mod'

Example

{{Mod|My Cool Mod|mods/myCoolMod}}

Modded Content Icon.png      Modded Content: This content is part of the My Cool Mod mod

{{Mod|My Cool Mod|https://example.com|external=true|coremod=true}}

Modded Content Icon.png      Modded Content: This content is part of the Example coremod