Template:PageOutdated/doc: Difference between revisions

From Vintage Story Wiki
(Added Notice templates category)
(Changed default for lookat; changed help text; explained how to use the template. Discord discussion proceeding re: use of lookat text)
 
Line 4: Line 4:
"params": {
"params": {
"lookat": {
"lookat": {
"description": "A link to show if there is an updated page/section.",
"description": "A link to show if there is an updated page/section, or discussion about the page's status.",
"type": "string",
"type": "string",
"required": false,
"required": false,
"example": "lookat={{ll|Template:PageOutdated|nsp=0}}"
"example": "lookat=[[{{TALKPAGENAME}}|this article's talk page]]"
}
}
},
},
"description": "Adds an 'page outdated' message box. Use the |lookat={{ll link}} parameter to add an up-to-date link."
"description": "Adds an 'page outdated' message box. Use the |lookat=wikitext parameter to add an up-to-date link."
}
}
</templatedata>
</templatedata>
Line 16: Line 16:
== Usage ==
== Usage ==


Demonstrate how to use the template. The section below should list out every parameter with a description, such that a user should be able to just copy-paste it into a page for use.
You may place the template just under the relevant section header. The <code>lookat</code> parameter may be any wikitext string; templates, links, and other normal wikitext formatting will work. <code>lookat</code> is an '''optional''' parameter.
<pre>
<pre>
{{PageOutdated}}
{{PageOutdated}}
{{PageOutdated|lookat={{ll|link}}}}
{{PageOutdated|lookat=[[{{TALKPAGENAME}}|this article's talk page]]
}}</pre>
}}</pre>
produces:
{{PageOutdated}}
{{PageOutdated|lookat=[[{{TALKPAGENAME}}|this article's talk page]]
}}


<noinclude>[[Category:Template documentation|{{PAGENAME}}]][[Category:Notice_templates]]</noinclude>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]][[Category:Notice_templates]]</noinclude>

Latest revision as of 14:51, 28 March 2024

Adds an 'page outdated' message box. Use the |lookat=wikitext parameter to add an up-to-date link.

Template parameters

ParameterDescriptionTypeStatus
lookatlookat

A link to show if there is an updated page/section, or discussion about the page's status.

Example
lookat=[[{{TALKPAGENAME}}|this article's talk page]]
Stringoptional

Usage

You may place the template just under the relevant section header. The lookat parameter may be any wikitext string; templates, links, and other normal wikitext formatting will work. lookat is an optional parameter.

{{PageOutdated}}
{{PageOutdated|lookat=[[{{TALKPAGENAME}}|this article's talk page]]
}}

produces:

GameIcon.png

This page is outdated!
Some details may not be accurate, so use with caution!

GameIcon.png

This page is outdated!
Some details may not be accurate, so use with caution! Please view this article's talk page for an up-to-date page!