Difference between revisions of "Template:Patch layout/doc"

From Team Fortress Wiki
Jump to: navigation, search
m
 
(19 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
== Usage ==
 
== Usage ==
 +
{{hatnote|'''Please see [[Help:Patch notes]] for full instructions on adding patch notes to the wiki.'''}}
 
This template keeps the style of [[patches|patch note]] pages consistent. '''This template supersedes {{tl|Patch}} and {{tl|Succession box}}'''.
 
This template keeps the style of [[patches|patch note]] pages consistent. '''This template supersedes {{tl|Patch}} and {{tl|Succession box}}'''.
 +
This template uses other helper templates for some parts of its translation. See also: {{tl|Patch layout/Diff header}}
  
 
=== Parameters ===
 
=== Parameters ===
Line 14: Line 16:
  
 
<nowiki>* Added a new cvar that disables W+M1.</nowiki>
 
<nowiki>* Added a new cvar that disables W+M1.</nowiki>
−
 
−
<nowiki>=== Community requests ===</nowiki>
 
−
 
−
<nowiki>* Added a new output for something asked by the community.</nowiki>
 
 
</code>
 
</code>
 
| yes
 
| yes
 
| The actual patch notes.
 
| The actual patch notes.
 +
|-
 +
| {{code|game}}
 +
| {{code|tfc}}
 +
| no
 +
| This isn't necessary for TF2 patches. If set to "{{code|tfc}}", this will change the links and categories accordingly (i.e. link to [[Patches (Classic)]]) and categorize into [[:Category:Patches (Classic)]].
 
|-
 
|-
 
! colspan="4" style="text-align: left;" | ''Next / Previous''
 
! colspan="4" style="text-align: left;" | ''Next / Previous''
Line 28: Line 31:
 
| yes
 
| yes
 
| A link to the previous patch.
 
| A link to the previous patch.
 +
|-
 +
| {{code|day}}, {{code|month}}, {{code|year}}
 +
| {{code|17}}. {{code|august}}, {{code|2010}}
 +
| ''Automatically set by [[User:WindBOT|WindBOT]]''
 +
| The date the current patch was released on. Required for translated patches in order to have {{code|DISPLAYTITLE}} automatically populated.
 
|-
 
|-
 
| {{code|after}}
 
| {{code|after}}
Line 41: Line 49:
 
| The URL of the Steam news article on the patch. Supports up to 3 individual sources.
 
| The URL of the Steam news article on the patch. Supports up to 3 individual sources.
 
|-
 
|-
−
| <code>source-title<sub><n></sub></code>
+
| <code>source<sub><n></sub>-title</code>
 
| {{code|22 Jul 2010 &ndash; Team Fortress 2 Update Released}}
 
| {{code|22 Jul 2010 &ndash; Team Fortress 2 Update Released}}
 
| no
 
| no
 
| Optional name override on source link. Supports up to 3 individual sources.
 
| Optional name override on source link. Supports up to 3 individual sources.
 
|-
 
|-
−
| <code>source-lang<sub><n></sub></code>
+
 
−
| {{code|fr}}
 
−
| no
 
−
| If the source is Steam news then this parameter should be unused. Defaults to "en" on non-English pages. Supports all 3 source links.
 
−
|-
 
 
| {{code|updatelink}}
 
| {{code|updatelink}}
 
| {{code|http://www.teamfortress.com/war/part1/index.htm}}
 
| {{code|http://www.teamfortress.com/war/part1/index.htm}}
Line 61: Line 65:
 
| Name of major update to be displayed with the link.
 
| Name of major update to be displayed with the link.
 
|-
 
|-
−
| {{code|update-lang}}
+
! colspan="4" style="text-align: left;" | ''Diffs''
−
| {{code|fr}}
+
|-
 +
| ''Nothing''
 +
|
 +
|
 +
| If it exists, the page at <code>Template:PatchDiff/Patch page name</code> will be transcluded. If <code>Template:PatchDiff/Patch page name n</code> exists, where n is an integer, it will also be transcluded.
 +
|-
 +
| <code>hide-diff</code>
 +
| {{code| <nowiki> | hide-diff = yes</nowiki>}}
 +
| no
 +
| Override to not transclude the patch diff.
 +
|-
 +
! colspan="4" style="text-align: left;" | ''Other''
 +
|-
 +
| {{code|displaytitle}}
 +
| <code><nowiki>| displaytitle = no</nowiki></code>
 +
| no
 +
| Template will automatically set the displayed title of the page (i.e. <code><nowiki>{{DISPLAYTITLE:Title}}</nowiki></code>) unless this is parameter is defined. The automatic title used is the text of the {{code|current}} parameter; if this is not defined, no display title is set.
 +
|-
 +
| {{code|no-category}}
 +
| <code><nowiki>| no-category = yes</nowiki></code>
 
| no
 
| no
−
| If the update page linked is in a different language. Helpful for some update pages that are offered in different languages. Defaults to "en" on non-English pages.
+
| Disables automatic categorization. Should be used for pages such as user sandboxes.
 
|-
 
|-
 +
| {{code|crowdin}}
 +
| <code><nowiki>| crowdin = yes</nowiki></code>
 +
| no
 +
| Removes automatic {{tlx|lang icon}} from patches that have been translated and published on Steam.
 
|}
 
|}
  
Line 72: Line 99:
 
{{Patch layout
 
{{Patch layout
 
| source = http://store.steampowered.com/news/4102/
 
| source = http://store.steampowered.com/news/4102/
 +
| source-title = Team Fortress 2 Update Released
 
| before = [[July 19, 2010 Patch]]
 
| before = [[July 19, 2010 Patch]]
 
| after  = [[July 23, 2010 Patch]]
 
| after  = [[July 23, 2010 Patch]]
Line 86: Line 114:
  
 
}}
 
}}
−
{{Languages}}
 
 
</pre><noinclude>
 
</pre><noinclude>
 
[[Category:Template documentation|Patch layout]]
 
[[Category:Template documentation|Patch layout]]
 
</noinclude>
 
</noinclude>

Latest revision as of 15:23, 29 September 2022

Usage

Please see Help:Patch notes for full instructions on adding patch notes to the wiki.

This template keeps the style of patch note pages consistent. This template supersedes {{Patch}} and {{Succession box}}. This template uses other helper templates for some parts of its translation. See also: {{Patch layout/Diff header}}

Parameters

Parameter Example Required? Description
notes

* Fixed bug that caused a crash.

* Added a new cvar that disables W+M1.

yes The actual patch notes.
game tfc no This isn't necessary for TF2 patches. If set to "tfc", this will change the links and categories accordingly (i.e. link to Patches (Classic)) and categorize into Category:Patches (Classic).
Next / Previous
before August 2, 2010 Patch yes A link to the previous patch.
day, month, year 17. august, 2010 Automatically set by WindBOT The date the current patch was released on. Required for translated patches in order to have DISPLAYTITLE automatically populated.
after August 20, 2010 Patch yes A link to the next patch. If none, put N/A.
Sources
source<n> http://store.steampowered.com/news/4102/ yes The URL of the Steam news article on the patch. Supports up to 3 individual sources.
source<n>-title 22 Jul 2010 – Team Fortress 2 Update Released no Optional name override on source link. Supports up to 3 individual sources.
updatelink http://www.teamfortress.com/war/part1/index.htm no URL of official update page (only for major updates).
update The WAR! Update no Name of major update to be displayed with the link.
Diffs
Nothing If it exists, the page at Template:PatchDiff/Patch page name will be transcluded. If Template:PatchDiff/Patch page name n exists, where n is an integer, it will also be transcluded.
hide-diff | hide-diff = yes no Override to not transclude the patch diff.
Other
displaytitle | displaytitle = no no Template will automatically set the displayed title of the page (i.e. {{DISPLAYTITLE:Title}}) unless this is parameter is defined. The automatic title used is the text of the current parameter; if this is not defined, no display title is set.
no-category | no-category = yes no Disables automatic categorization. Should be used for pages such as user sandboxes.
crowdin | crowdin = yes no Removes automatic {{lang icon}} from patches that have been translated and published on Steam.

Examples

{{Patch layout
| source = http://store.steampowered.com/news/4102/
| source-title = Team Fortress 2 Update Released
| before = [[July 19, 2010 Patch]]
| after  = [[July 23, 2010 Patch]]

| notes  = 

=== Server Browser ===
* Fixed the server browser not saving filter settings properly

=== Team Fortress 2 ===
* Fixed a speed exploit related to benchmarks
* Fixed Parasite hat not being posed correctly on class loadout panels
* Fixed a level change crash

}}
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Template:Patch_layout/doc&oldid=3268054"