Difference between revisions of "Help:Patch notes"

From Team Fortress Wiki
Jump to: navigation, search
(update to include new practices)
Line 1: Line 1:
−
{{Help navbar}}
+
{{TFWiki navbar}}
 +
 
 +
This page documents the procedure for adding '''patch notes''' to the wiki. Patch notes now use the template {{tl|Patch layout}} to keep the layout of patch notes consistent.
  
 
== Instructions ==
 
== Instructions ==
−
When adding patch notes, please ensure that the information is accurate, and properly cited. Also, please make sure a link (''for help see [[Wikipedia:Wikipedia:How_to_edit_a_page#Links_and_URLs|How to make links]]'') is added to the patch on the [[patches]] page.
+
=== Creating a new article ===
 +
<ol>
 +
<li>New patch articles should use the name format {{code|Month DD, YYYY Patch}}. If the patch is for the Xbox, append {{code|(Xbox)}} to the end. Examples:</li>
 +
:{{code|August 20, 2010 Patch}} or {{code|August 20, 2010 Patch (Xbox)}}
 +
<li>Copy and paste the following code:</li>
 +
<pre style="margin-left:2.5em;"><nowiki>
 +
{{Patch layout
 +
| source =
 +
| before =
 +
| after  =
 +
 
 +
| notes  =
 +
 
 +
...
 +
 
 +
}}
 +
{{Languages}}
 +
</nowiki></pre>
 +
<li>Copy and paste the patch notes ''directly'' from the article on http://store.steampowered.com/news/ and format them like this:</li>
 +
<pre style="margin-left:2.5em;"><nowiki>
 +
* Fixed a bug with the game
 +
* Updated cp_dustbowl
 +
** Made it less spammy
 +
** Fixed glitch
 +
* Updated the game
  
−
== Adding a patch ==
+
=== Community requests ===
−
<ol><li>Patch pages ''must'' be named in <br />the format "Month DD, YYYY Patch" or "Month DD, YYYY Patch (Xbox)". For example, "November 20, 2007 Patch" or "October 09, 2007 Patch (Xbox)".</li>
+
* Added a new cvar
−
<li>From the official patch notes page from http://store.steampowered.com/news/ paste all of the patch notes, and format them in the article in this way:
+
</nowiki></pre>
−
<pre style="margin-left:50px">==Changes==
+
<li>Add the URL of the update page to the {{code|source}} line at the top like this:</li>
−
*Change 1
+
:{{code|1={{!}} source = http://store.steampowered.com/news/4210/}}
−
**Change 1a
+
<li>Add the date of the previous patch to the {{code|before}} line like this:</li>
−
**Change 1b
+
:{{code|1={{!}} before = [[August 17, 2010 Patch]]}}
−
*Change 2
+
<li>Add {{code|N/A}} to the {{code|after}} line.</li>
 +
<li>Preview your article and if everything works fine hit '''Save page'''.
  
−
===Specific Class Changes===
+
<h3 style="margin:0.5em -2.5em;">Updating the rest of the wiki</h3>
−
*Change 3
 
  
−
==Bug Fixes==
+
<li>Go to [[Template:Updates]] and make sure {{code|patch-month}} and {{code|patch-day}} are all correct and up-to-date.</li>
−
*And so on.</pre>
+
<li>Go to the patch just before the new one and update its {{code|after}} line with a link to the latest patch:</li>
−
Be sure to look at an existing patch page for clarification on formatting.</li>
+
:{{code|1={{!}} after = N/A}} on the old patch article now becomes {{code|1={{!}} after = [[August 20, 2010 Patch]]}} (the date of the latest patch)
−
<li>Add the '''patch''' template to the new page:
+
<li>Go to the article on [[Patches]] and add the latest patch as a new item to the top of the list.</li>
−
<pre>{{Patch|SOURCE=http://store.steampowered.com/news/NUMBER/}}</pre>
+
<li>You're done.</li>
−
''Note:'' Please make sure that the link is accurate. It will always begin with http://store.steampowered.com/news/ and be followed by a number, as shown. Also, please remove any language/region settings from the link by removing any "&cc=XX" part of the URL (XX is a region code, typically "US").</li>
+
</ol>
−
<li>Add the [[Template:Succession box|succession box]] template to the bottom of the page as such, replacing the patch links. If the patch you are editing is the latest patch available, then set ''after'' to Unknown.
 
−
<pre>{{Succession box
 
−
|before=[[Month DD, YYYY Patch]]
 
−
|title=Patches
 
−
|after=[[Month DD, YYYY Patch]]
 
−
}}</pre></li>
 
−
<li>'''Make sure''' if you are adding a new patch that you appropriately edit the immediately surrounding patches so that their succession boxes link properly, otherwise, all of the patches will say "Unknown" for their ''after'' link.</li></ol>
 
  
−
After typing all the information for the patch, check the details with the '''Show preview''' button. If every thing looks correct, click the '''Save page''' button.
+
=== Advanced ===
 +
For more complicated patches.
  
−
__NOEDITSECTION__
+
* Handling two source links at once:
 +
<pre style="margin-left:1.5em;"><nowiki>
 +
| source        = http://store.steampowered.com/news/4210/
 +
| source-title  = Part 1
 +
| source2      = http://store.steampowered.com/news/1234/
 +
| source2-title = Part 2
 +
</nowiki></pre>
 +
* Handling update pages:
 +
<pre style="margin-left:1.5em;"><nowiki>
 +
| update    = http://www.teamfortress.com/engineerupdate/
 +
| updatelink = The Engineer Update
 +
</nowiki></pre>
 +
:* Handling update pages in different languages:
 +
<pre style="margin-left:2.5em;"><nowiki>
 +
| update      = http://www.teamfortress.com/scoutupdate/german.htm
 +
| updatelink  = Das Scout Update
 +
| update-lang = de
 +
</nowiki></pre>

Revision as of 11:03, 23 August 2010

v • d • e
Team Fortress Wiki
Guidelines
Images
Discussion
Languages
Help center
Wiki
Technical

This page documents the procedure for adding patch notes to the wiki. Patch notes now use the template {{Patch layout}} to keep the layout of patch notes consistent.

Instructions

Creating a new article

  1. New patch articles should use the name format Month DD, YYYY Patch. If the patch is for the Xbox, append (Xbox) to the end. Examples:
    2. August 20, 2010 Patch or August 20, 2010 Patch (Xbox)
  2. Copy and paste the following code:
    3. {{Patch layout
| source =
| before =
| after  =

| notes  =

...

}}
{{Languages}}
  3. Copy and paste the patch notes directly from the article on http://store.steampowered.com/news/ and format them like this:
    4. * Fixed a bug with the game
* Updated cp_dustbowl
** Made it less spammy
** Fixed glitch
* Updated the game

=== Community requests ===
* Added a new cvar
  4. Add the URL of the update page to the source line at the top like this:
    5. | source = http://store.steampowered.com/news/4210/
  5. Add the date of the previous patch to the before line like this:
    6. | before = August 17, 2010 Patch
  6. Add N/A to the after line.
  7. Preview your article and if everything works fine hit Save page.

    Updating the rest of the wiki

  8. Go to Template:Updates and make sure patch-month and patch-day are all correct and up-to-date.
  9. Go to the patch just before the new one and update its after line with a link to the latest patch:
    10. | after = N/A on the old patch article now becomes | after = August 20, 2010 Patch (the date of the latest patch)
  10. Go to the article on Patches and add the latest patch as a new item to the top of the list.
  11. You're done.

Advanced

For more complicated patches.

  • Handling two source links at once:
| source        = http://store.steampowered.com/news/4210/
| source-title  = Part 1
| source2       = http://store.steampowered.com/news/1234/
| source2-title = Part 2
  • Handling update pages:
| update     = http://www.teamfortress.com/engineerupdate/
| updatelink = The Engineer Update
  • Handling update pages in different languages:
| update      = http://www.teamfortress.com/scoutupdate/german.htm
| updatelink  = Das Scout Update
| update-lang = de
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Help:Patch_notes&oldid=77920"