Template:Patch Notes/doc: Difference between revisions

From [N8]
Jump to navigation Jump to search
VisualWikitext
Created page with "{{documentation}} This template displays a copyright notice that the article has patch notes that are Gemini Station's property. ==Usage== This template can be used by enteri..."
 
No edit summary
 
Line 5: Line 5:
This template can be used by entering the following onto a relevant patch note article. It automatically adds [[:Category:Patch Notes]] to the article.
This template can be used by entering the following onto a relevant patch note article. It automatically adds [[:Category:Patch Notes]] to the article.


<pre>{{Patch Notes|date=|qfc=|author=|rev=|titleOverride=|link=}}</pre>
<pre>{{Patch Notes|date=|qpr=|titleOverride=|link=}}</pre>


===date===
===date===
This required parameter accepts the date. It should not be linked and can be in any format accepted by [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23time #time].
This required parameter accepts the date. It should not be linked and can be in any format accepted by [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23time #time].


===qfc===
===qpr===
This required parameter accepts the Quick Find Code for the forum thread where Gemini Station publishes the patch notes. It should be in the comma-delimited format (nn,nn,nnn,nnnnnnnn), but the template can accept stroke-delimited format (nn-nn-nnn-nnnnnnnn). Alternatively, one can use <code>no</code> if a QFC cannot be found anymore. Use <code>none</code> if no forum thread was created.
This should always be the link to the patch note page on Gemini Station website.
 
===author===
This optional parameter accepts the name of the author posting the patch notes. Include 'mod' prefix.
 
===rev===
This optional parameter accepts the revision date. Gemini Station occasionally adds additional system updates and hot fixes to patch notes that have already been published. The date should not be linked and can be in any format accepted by [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions#.23time #time].


===titleOverride===
===titleOverride===
Line 23: Line 17:


===link===
===link===
This optional parameter can be used to link to the dedicated news post for these patch notes. Do not use this to link to the forum thread, that is what QFC is for.
This optional parameter can be used to link to the dedicated news post for these patch notes if there is another location (such as the forum, if ever) that patch notes get posted.


<includeonly>[[Category:Transclusion templates|{{PAGENAME}}]]</includeonly>
<includeonly>[[Category:Transclusion templates|{{PAGENAME}}]]</includeonly>

Latest revision as of 14:43, 8 June 2020

This is a documentation subpage for Template:Patch Notes.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Patch Notes invokes function patchnotes in Module:Update using Lua.

This template displays a copyright notice that the article has patch notes that are Gemini Station's property.

Usage

This template can be used by entering the following onto a relevant patch note article. It automatically adds Category:Patch Notes to the article. 

{{Patch Notes|date=|qpr=|titleOverride=|link=}}

date

This required parameter accepts the date. It should not be linked and can be in any format accepted by #time.

qpr

This should always be the link to the patch note page on Gemini Station website.

titleOverride

This optional parameter can be used to prevent the default override of the page's display title to be Patch Notes (date) - e.g. "Patch Notes (4 June 2026)". Supplying no to this parameter prevents any override of the displayed page title. Any other value supplied will be passed through into {{DISPLAYTITLE}}, resulting in the page's display title becoming the supplied value.

link

This optional parameter can be used to link to the dedicated news post for these patch notes if there is another location (such as the forum, if ever) that patch notes get posted.


Retrieved from "https://wiki.geministation.com/index.php?title=Template:Patch_Notes/doc&oldid=5078"