Difference between revisions of "Template:Client Patch"

m
m
Line 1: Line 1:
<noinclude>
+
<noinclude>{{Template Overview
{{tocright}}
+
|usedon=client patch
 
+
|purpose=standardize their look and feel and to make them easier to create
[[Template:Client Patch]] is designed for use on [[Client Patches|client patch pages]].
+
|template=<nowiki>{{Client Patch
 
+
==Full Template==
+
<pre>
+
{{Client Patch
+
 
|client=
 
|client=
 
|otherclient=
 
|otherclient=
Line 13: Line 9:
 
|notes=
 
|notes=
 
|patchnotes=
 
|patchnotes=
 +
}}</nowiki>
 
}}
 
}}
</pre>
+
{{Template Parameter
 
+
|name=client
==Parameters==
+
|usage=mandatory
 
+
|takes=a two-character code
===client===
+
|denotes=the client for which the client patch was issued
* '''Usage:''' Mandatory
+
|generates=the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section
* '''Description:''' The <span style="font-family:monospace;">client</span> parameter takes a two-character code denoting the client for which the client patch was issued. This is used to generate the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section.
+
|validvalues= "2d" (Classic Client), "en" (Enhanced Client), "kr" (Kingdom Reborn Client), "3d" (Third Dawn Client)
* '''Valid Value(s):'''
+
}}
** "2d" - Classic Client
+
{{Template Parameter
** "en" - Enhanced Client
+
|name=otherclient
** "kr" - Kingdom Reborn Client
+
|takes=a two-character code
** "3d" - Third Dawn Client
+
|denotes=a second client for which the client patch was issued
 
+
|generates=the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section
===otherclient===
+
|othernotes=At current, the only case in which this can be true is for old patches that were issued for both the Classic and Third Dawn Clients.
* '''Usage:''' Optional
+
|validvalues="3d" (Third Dawn Client)
* '''Description:''' The <span style="font-family:monospace;">otherclient</span> parameter takes a two-character code denoting a second client for which the client patch was issued. This is used to generate the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section. At current, the only case in which this can be true is for old patches that were issued for both the Classic and Third Dawn Clients.
+
}}
* '''Valid Value(s):''' "3d"
+
{{Template Parameter
 
+
|name=date
===date===
+
|usage=mandatory
* '''Usage:''' Mandatory
+
|takes=a string
* '''Description:''' The <span style="font-family:monospace;">date</span> parameter takes a string denoting the date on which the client patch was issued. This is used to generate the "Date" bullet point.
+
|denotes=the date on which the client patch was issued
* '''Valid Value(s):''' Any string representing a date.
+
|generates=the "Date" bullet point
 
+
|validvalues=Any string representing a date.
===size===
+
}}
* '''Usage:''' Optional
+
{{Template Parameter
* '''Description:''' The <span style="font-family:monospace;">size</span> parameter takes a string denoting the size, in bytes, of the client patch. This is used to generate the "Size" bullet point in the "Statistics" section. If this parameter is left blank or omitted, a default value of "Unknown" is displayed.
+
|name=size
* '''Valid Value(s):''' A comma-separated number.
+
|takes=a string
 
+
|denotes=the size, in bytes, of the client patch
===notes===
+
|generates=the "Size" bullet point in the "Statistics" section
* '''Usage:''' Optional
+
|defaultvalue=Unknown
* '''Description:''' The <span style="font-family:monospace;">notes</span> parameter takes a string or strings denoting any notes or other commentary on the client patch. This is used to generate the "Notes" bullet point. If this parameter is left blank or omitted, a default value of "None" is displayed.
+
|validvalues=A comma-separated number.
* '''Valid Value(s):''' Any string or strings.
+
}}
 
+
{{Template Parameter
===patchnotes===
+
|name=notes
* '''Usage:''' Mandatory
+
|takes=a string or strings
* '''Description:''' The <span style="font-family:monospace;">patchnotes</span> parameter takes a string or strings denoting the official patch notes, or a paraphrasing of the official patch notes, that correspond to the client patch. This is used to generate the "Patch Notes" section.
+
|denotes=any notes or other unofficial commentary on the client patch
* '''Valid Value(s):''' Any string or strings.</noinclude><includeonly>__NOTOC__
+
|generates=the "Notes" bullet point
 +
|defaultvalue=None
 +
|validvalues=Any string or strings.
 +
}}
 +
{{Template Parameter
 +
|name=patchnotes
 +
|usage=mandatory
 +
|takes=a string or strings
 +
|denotes=the official patch notes, or a paraphrasing of the official patch notes, that correspond to the client patch
 +
|generates=the "Patch Notes" section
 +
|validvalues=Any string or strings.
 +
}}</noinclude><includeonly>__NOTOC__
 
{{#ifeq: {{{client|}}} | kr
 
{{#ifeq: {{{client|}}} | kr
 
| This patch was for the [[Ultima Online: Kingdom Reborn|Kingdom Reborn Client]].
 
| This patch was for the [[Ultima Online: Kingdom Reborn|Kingdom Reborn Client]].

Revision as of 14:52, 3 October 2009

Template:Client Patch is designed for use on client patch pages to standardize their look and feel and to make them easier to create.

Template

{{Client Patch
|client=
|otherclient=
|date=
|size=
|notes=
|patchnotes=
}}

Parameters

[[Category:{{{category}}} Templates|Client Patch]]

client

  • Usage: Mandatory
  • Description: The client parameter takes a two-character code denoting the client for which the client patch was issued. This is used to generate the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section.
  • Valid Value(s): "2d" (Classic Client), "en" (Enhanced Client), "kr" (Kingdom Reborn Client), "3d" (Third Dawn Client)

otherclient

  • Usage: Optional
  • Description: The otherclient parameter takes a two-character code denoting a second client for which the client patch was issued. This is used to generate the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section. At current, the only case in which this can be true is for old patches that were issued for both the Classic and Third Dawn Clients.
  • Valid Value(s): "3d" (Third Dawn Client)

date

  • Usage: Mandatory
  • Description: The date parameter takes a string denoting the date on which the client patch was issued. This is used to generate the "Date" bullet point.
  • Valid Value(s): Any string representing a date.

size

  • Usage: Optional
  • Description: The size parameter takes a string denoting the size, in bytes, of the client patch. This is used to generate the "Size" bullet point in the "Statistics" section. If this parameter is left blank or omitted, a default value of "Unknown" is used.
  • Valid Value(s): A comma-separated number.

notes

  • Usage: Optional
  • Description: The notes parameter takes a string or strings denoting any notes or other unofficial commentary on the client patch. This is used to generate the "Notes" bullet point. If this parameter is left blank or omitted, a default value of "None" is used.
  • Valid Value(s): Any string or strings.

patchnotes

  • Usage: Mandatory
  • Description: The patchnotes parameter takes a string or strings denoting the official patch notes, or a paraphrasing of the official patch notes, that correspond to the client patch. This is used to generate the "Patch Notes" section.
  • Valid Value(s): Any string or strings.