Difference between revisions of "Template:Client Patch"

m (Protected "Template:Client Patch" [edit=sysop:move=sysop])
m
 
(23 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
|notes=
 
|notes=
 
|patchnotes=
 
|patchnotes=
 +
|current=
 +
|previous=
 +
|previousactual=
 +
|next=
 +
|nextactual=
 +
|otherclientcurrent=
 +
|otherclientprevious=
 +
|ocpreviousactual=
 +
|otherclientnext=
 +
|ocnextactual=
 
}}</nowiki>
 
}}</nowiki>
−
|parameters=yes
+
|category=Article
 
}}
 
}}
 
{{Template Parameter
 
{{Template Parameter
Line 17: Line 27:
 
|takes=a two-character code
 
|takes=a two-character code
 
|denotes=the client for which the client patch was issued
 
|denotes=the 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
+
|generates=the introductory sentence, a link back to the corresponding list of client patches in the "See Also" section, and the category to which the article belongs
−
|validvalues= "2d" (Classic Client), "en" (Enhanced Client), "kr" (Kingdom Reborn Client), "3d" (Third Dawn Client)
+
|validvalues= "cc" (Classic Client), "ec" (Enhanced Client), "kr" (Kingdom Reborn Client), "td" (Third Dawn Client)
 
}}
 
}}
 
{{Template Parameter
 
{{Template Parameter
Line 26: Line 36:
 
|generates=the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section
 
|generates=the introductory sentence, as well a link back to the corresponding list of client patches in the "See Also" section
 
|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.
 
|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.
−
|validvalues="3d" (Third Dawn Client)
+
|validvalues="td" (Third Dawn Client)
 
}}
 
}}
 
{{Template Parameter
 
{{Template Parameter
Line 33: Line 43:
 
|takes=a string
 
|takes=a string
 
|denotes=the date on which the client patch was issued
 
|denotes=the date on which the client patch was issued
−
|generates=the "Date" bullet point
+
|generates=the "Date" bullet point, as well as the date displayed in the sequence box
 
|validvalues=Any string representing a date.
 
|validvalues=Any string representing a date.
 
}}
 
}}
Line 54: Line 64:
 
{{Template Parameter
 
{{Template Parameter
 
|name=patchnotes
 
|name=patchnotes
−
|usage=mandatory
 
 
|takes=a string or strings
 
|takes=a string or strings
 
|denotes=the official patch notes, or a paraphrasing of the official patch notes, that correspond to the client patch
 
|denotes=the official patch notes, or a paraphrasing of the official patch notes, that correspond to the client patch
 
|generates=the "Patch Notes" section
 
|generates=the "Patch Notes" section
 +
|defaultvalue=No patch notes given.
 
|validvalues=Any string or strings.
 
|validvalues=Any string or strings.
 
}}
 
}}
−
[[Category:Page Templates|{{PAGENAME}}]]</noinclude><includeonly>__NOTOC__ __NOEDITSECTION__
+
{{Template Parameter
−
{{#ifeq: {{{client|}}} | kr
+
|name=current
−
| This patch was for the [[Ultima Online: Kingdom Reborn|Kingdom Reborn Client]].
+
|takes=a string
−
| {{#ifeq: {{{client|}}} | en
+
|denotes=the number of the client patch described by the current article, as numbered for the client chosen in the {{Monospace|client}} parameter
 +
|generates=the bold patch number in the center of the primary sequence box under
 +
|othernotes=If this parameter is omitted, the template will automatically parse the number out of the article's name.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=previous
 +
|takes=a string
 +
|denotes=the number of the client patch that came before the current client patch, as numbered for the client chosen in the {{Monospace|client}} parameter
 +
|generates=a link to the previous client patch under the "Previous" heading in the leftmost section of the primary sequence box
 +
|othernotes=If there is no "Next" client patch, this parameter becomes mandatory, as otherwise you would be left with a one-patch sequence.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=previousactual
 +
|takes=a string
 +
|denotes=the actual number of the client patch page to link to for the client chosen in the {{Monospace|client}} parameter
 +
|generates=the actual link to the previous client patch under the "Previous" heading in the leftmost section of the primary sequence box, reducing the value supplied for the {{Monospace|previous}} parameter to be only the displayed value
 +
|othernotes=This parameter is meant to be used when the previous client patch is shared with the secondary client, but the patch number for the primary client is not the patch number used on the actual linked page.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=next
 +
|takes=a string
 +
|denotes=the number of the client patch that came after the current client patch, as numbered for the client chosen in the {{Monospace|client}} parameter
 +
|generates=a link to the next client patch under the "Next" heading in the rightmost section of the primary sequence box
 +
|othernotes=If there is no "Previous" article in the sequence, this parameter becomes mandatory, as otherwise you would be left with a one-patch sequence.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=nextactual
 +
|takes=a string
 +
|denotes=the actual number of the client patch page to link to for the client chosen in the {{Monospace|client}} parameter
 +
|generates=the actual link to the next client patch under the "Next" heading in the rightmost section of the primary sequence box, reducing the value supplied for the {{Monospace|next}} parameter to be only the displayed value
 +
|othernotes=This parameter is meant to be used when the next client patch is shared with the secondary client, but the patch number for the primary client is not the patch number used on the actual linked page.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=otherclientcurrent
 +
|takes=a string
 +
|denotes=the number of the client patch described by the current article, as numbered for the client chosen in the {{Monospace|otherclient}} parameter
 +
|generates=the bold patch number in the center of the secondary sequence box
 +
|othernotes=This parameter is meant to be used in situations where the current article describes a patch that applies to two clients, but its number is not synchronized across both. If this parameter is omitted, the template will automatically parse the number out of the article's name.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=otherclientprevious
 +
|takes=a string
 +
|denotes=the number of the client patch that came before the current client patch, as numbered for the client chosen in the {{Monospace|otherclient}} parameter
 +
|generates=a link to the previous client patch under the "Previous" heading in the leftmost section of the secondary sequence box
 +
|othernotes=This parameter is meant to be used in situations where the previous patch applies to two clients, but its number is not synchronized across both. This parameter is only usable if the {{Monospace|otherclient}} parameter is filled in. If this parameter is filled in with the string "none," thus denoting that the current patch is the first in its sequence, there will be no "Previous" in the secondary sequence box. If this parameter is omitted entirely the value defaults to that of the {{Monospace|previous}} parameter.
 +
|validvalues=Any string corresponding to a valid patch number, or the string "none."
 +
}}
 +
{{Template Parameter
 +
|name=ocpreviousactual
 +
|takes=a string
 +
|denotes=the actual number of the client patch page to link to for the client chosen in the {{Monospace|otherclient}} parameter
 +
|generates=the actual link to the previous client patch under the "Previous" heading in the leftmost section of the secondary sequence box, reducing the value supplied for the {{Monospace|otherclientprevious}} parameter to be only the displayed value
 +
|othernotes=This parameter is meant to be used when the previous client patch is shared with the primary client, but the patch number for the secondary client is not the patch number used on the actual linked page.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}
 +
{{Template Parameter
 +
|name=otherclientnext
 +
|takes=a string
 +
|denotes=the number of the client patch that came after the current client patch, as numbered for the client chosen in the {{Monospace|otherclient}} parameter
 +
|generates=a link to the next client patch under the "Next" heading in the rightmost section of the secondary sequence box
 +
|othernotes=This parameter is meant to be used in situations where the next patch applies to two clients, but its number is not synchronized across both. This parameter is only usable if the {{Monospace|otherclient}} parameter is filled in. If this parameter is filled in with the string "none," thus denoting that the current patch is the last in its sequence, there will be no "Next" in the secondary sequence box. If this parameter is omitted entirely the value defaults to that of the {{Monospace|next}} parameter.
 +
|validvalues=Any string corresponding to a valid patch number, or the string "none."
 +
}}
 +
{{Template Parameter
 +
|name=ocnextactual
 +
|takes=a string
 +
|denotes=the actual number of the client patch page to link to for the client chosen in the {{Monospace|otherclient}} parameter
 +
|generates=the actual link to the next client patch under the "Next" heading in the leftmost section of the secondary sequence box, reducing the value supplied for the {{Monospace|otherclientprevious}} parameter to be only the displayed value
 +
|othernotes=This parameter is meant to be used when the next client patch is shared with the primary client, but the patch number for the secondary client is not the patch number used on the actual linked page.
 +
|validvalues=Any string corresponding to a valid patch number.
 +
}}</noinclude><includeonly>__NOTOC__ __NOEDITSECTION__
 +
{{#ifeq: {{{client}}} | cc
 +
| {{#ifeq: {{{otherclient}}} | td
 +
  | This patch was for the [[Classic Client|Classic]] and [[Ultima Online: Third Dawn|Third Dawn]] Clients.
 +
  | This patch was for the [[Classic Client]].
 +
  }}
 +
| {{#ifeq: {{{client}}} | ec
 
   | This patch was for the [[Enhanced Client]].
 
   | This patch was for the [[Enhanced Client]].
−
   | {{#ifeq: {{{client|}}} | 2d
+
   | {{#ifeq: {{{client}}} | kr
−
     | {{#ifeq: {{{otherclient|}}} | 3d
+
     | This patch was for the [[Ultima Online: Kingdom Reborn|Kingdom Reborn Client]].
−
      | This patch was for the [[Classic Client]] and the [[Ultima Online: Third Dawn|Third Dawn Client]].
+
     | {{#ifeq: {{{client}}} | td
−
      | This patch was for the [[Classic Client]].
+
−
      }}
+
−
     | {{#ifeq: {{{client|}}} | 3d
+
 
       | This patch was for the [[Ultima Online: Third Dawn|Third Dawn Client]].
 
       | This patch was for the [[Ultima Online: Third Dawn|Third Dawn Client]].
 
       | ERROR: Must supply client code.
 
       | ERROR: Must supply client code.
Line 88: Line 177:
 
}}
 
}}
 
==Patch Notes==
 
==Patch Notes==
−
{{{patchnotes}}}
+
{{#if: {{{patchnotes|}}}
 +
| {{{patchnotes}}}
 +
| No patch notes given.
 +
}}
 
==See Also==
 
==See Also==
−
{{#ifeq: {{{client|}}} | kr
+
{{Sequence
−
| * [[List of Kingdom Reborn Client Patches]]
+
|title={{#ifeq: {{{client}}} | cc
−
| {{#ifeq: {{{client|}}} | en
+
| {{Colored Link|List of Classic Client Patches|Classic Client Patches|color=FFFFFF}}
−
   | * [[List of Enhanced Client Patches]]
+
| {{#ifeq: {{{client}}} | ec
−
   | {{#ifeq: {{{client|}}} | 2d
+
   | {{Colored Link|List of Enhanced Client Patches|Enhanced Client Patches|color=FFFFFF}}
−
     | {{#ifeq: {{{otherclient|}}} | 3d
+
   | {{#ifeq: {{{client}}} | kr
−
      | * [[List of Classic Client Patches]]
+
     | {{Colored Link|List of Kingdom Reborn Client Patches|Kingdom Reborn Client Patches|color=FFFFFF}}
−
* [[List of Third Dawn Client Patches]]
+
     | {{#ifeq: {{{client}}} | td
−
      | * [[List of Classic Client Patches]]
+
       | {{Colored Link|List of Third Dawn Client Patches|Third Dawn Client Patches|color=FFFFFF}}
−
      }}
+
−
     | {{#ifeq: {{{client|}}} | 3d
+
−
       | * [[List of Third Dawn Client Patches]]
+
 
       | ERROR: Must supply client code.
 
       | ERROR: Must supply client code.
 
       }}
 
       }}
Line 107: Line 196:
 
   }}
 
   }}
 
}}
 
}}
−
[[Category:Client Patches]]</includeonly>
+
|current={{#if: {{{current|}}} | {{{current}}} | [[{{PAGENAME}}|{{#sub: {{PAGENAME}} | 13 }}]] }}
 +
|date={{{date}}}
 +
|previous={{#if: {{{previous|}}} | Client Patch {{#if: {{{previousactual|}}} | {{{previousactual}}} | {{{previous}}} }} {{!}} {{{previous}}} }}
 +
|next={{#if: {{{next|}}} | Client Patch {{#if: {{{nextactual|}}} | {{{nextactual}}} | {{{next}}} }} {{!}} {{{next}}} }}
 +
}}
 +
{{#ifeq: {{{client}}} | cc
 +
| {{#ifeq: {{{otherclient}}} | td
 +
  | {{Sequence
 +
    |title={{Colored Link|List of Third Dawn Client Patches|Third Dawn Client Patches|color=FFFFFF}}
 +
    |current={{#if: {{{otherclientcurrent|}}} | {{{otherclientcurrent}}} | [[{{PAGENAME}}|{{#sub: {{PAGENAME}} | 13 }}]] }}
 +
    |date={{{date}}}
 +
    |previous={{#if: {{{otherclientprevious|}}} | {{#ifeq: {{{otherclientprevious}}} | none | | Client Patch {{#if: {{{ocpreviousactual|}}} | {{{ocpreviousactual}}} | {{{otherclientprevious}}} }} {{!}} {{{otherclientprevious}}} }} | Client Patch {{{previous}}} {{!}} {{{previous}}} }}
 +
    |next={{#if: {{{otherclientnext|}}} | {{#ifeq: {{{otherclientnext}}} | none | | Client Patch {{#if: {{{ocnextactual|}}} | {{{ocnextactual}}} | {{{otherclientnext}}} }} {{!}} {{{otherclientnext}}} }} | Client Patch {{{next}}} {{!}} {{{next}}} }}
 +
    }}
 +
  }}
 +
}}
 +
{{#ifeq: {{{client}}} | cc
 +
| {{#ifeq: {{{otherclient}}} | td
 +
  | [[Category:Classic Client Patches]][[Category:Third Dawn Client Patches]]
 +
  | [[Category:Classic Client Patches]]
 +
  }}
 +
| {{#ifeq: {{{client}}} | ec
 +
  | [[Category:Enhanced Client Patches]]
 +
  | {{#ifeq: {{{client}}} | kr
 +
    | [[Category:Kingdom Reborn Client Patches]]
 +
    | {{#ifeq: {{{client}}} | td
 +
      | [[Category:Third Dawn Client Patches]]
 +
      | ERROR: Must supply client code.
 +
      }}
 +
    }}
 +
  }}
 +
}}</includeonly>

Latest revision as of 11:11, 7 April 2012

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=
|current=
|previous=
|previousactual=
|next=
|nextactual=
|otherclientcurrent=
|otherclientprevious=
|ocpreviousactual=
|otherclientnext=
|ocnextactual=
}}

Parameters

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, a link back to the corresponding list of client patches in the "See Also" section, and the category to which the article belongs.
  • Valid Value(s): "cc" (Classic Client), "ec" (Enhanced Client), "kr" (Kingdom Reborn Client), "td" (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): "td" (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, as well as the date displayed in the sequence box.
  • 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: Optional
  • 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. If this parameter is left blank or omitted, a default value of "No patch notes given." is used.
  • Valid Value(s): Any string or strings.

current

  • Usage: Optional
  • Description: The current parameter takes a string denoting the number of the client patch described by the current article, as numbered for the client chosen in the client parameter. This is used to generate the bold patch number in the center of the primary sequence box under. If this parameter is omitted, the template will automatically parse the number out of the article's name.
  • Valid Value(s): Any string corresponding to a valid patch number.

previous

  • Usage: Optional
  • Description: The previous parameter takes a string denoting the number of the client patch that came before the current client patch, as numbered for the client chosen in the client parameter. This is used to generate a link to the previous client patch under the "Previous" heading in the leftmost section of the primary sequence box. If there is no "Next" client patch, this parameter becomes mandatory, as otherwise you would be left with a one-patch sequence.
  • Valid Value(s): Any string corresponding to a valid patch number.

previousactual

  • Usage: Optional
  • Description: The previousactual parameter takes a string denoting the actual number of the client patch page to link to for the client chosen in the client parameter. This is used to generate the actual link to the previous client patch under the "Previous" heading in the leftmost section of the primary sequence box, reducing the value supplied for the previous parameter to be only the displayed value. This parameter is meant to be used when the previous client patch is shared with the secondary client, but the patch number for the primary client is not the patch number used on the actual linked page.
  • Valid Value(s): Any string corresponding to a valid patch number.

next

  • Usage: Optional
  • Description: The next parameter takes a string denoting the number of the client patch that came after the current client patch, as numbered for the client chosen in the client parameter. This is used to generate a link to the next client patch under the "Next" heading in the rightmost section of the primary sequence box. If there is no "Previous" article in the sequence, this parameter becomes mandatory, as otherwise you would be left with a one-patch sequence.
  • Valid Value(s): Any string corresponding to a valid patch number.

nextactual

  • Usage: Optional
  • Description: The nextactual parameter takes a string denoting the actual number of the client patch page to link to for the client chosen in the client parameter. This is used to generate the actual link to the next client patch under the "Next" heading in the rightmost section of the primary sequence box, reducing the value supplied for the next parameter to be only the displayed value. This parameter is meant to be used when the next client patch is shared with the secondary client, but the patch number for the primary client is not the patch number used on the actual linked page.
  • Valid Value(s): Any string corresponding to a valid patch number.

otherclientcurrent

  • Usage: Optional
  • Description: The otherclientcurrent parameter takes a string denoting the number of the client patch described by the current article, as numbered for the client chosen in the otherclient parameter. This is used to generate the bold patch number in the center of the secondary sequence box. This parameter is meant to be used in situations where the current article describes a patch that applies to two clients, but its number is not synchronized across both. If this parameter is omitted, the template will automatically parse the number out of the article's name.
  • Valid Value(s): Any string corresponding to a valid patch number.

otherclientprevious

  • Usage: Optional
  • Description: The otherclientprevious parameter takes a string denoting the number of the client patch that came before the current client patch, as numbered for the client chosen in the otherclient parameter. This is used to generate a link to the previous client patch under the "Previous" heading in the leftmost section of the secondary sequence box. This parameter is meant to be used in situations where the previous patch applies to two clients, but its number is not synchronized across both. This parameter is only usable if the otherclient parameter is filled in. If this parameter is filled in with the string "none," thus denoting that the current patch is the first in its sequence, there will be no "Previous" in the secondary sequence box. If this parameter is omitted entirely the value defaults to that of the previous parameter.
  • Valid Value(s): Any string corresponding to a valid patch number, or the string "none."

ocpreviousactual

  • Usage: Optional
  • Description: The ocpreviousactual parameter takes a string denoting the actual number of the client patch page to link to for the client chosen in the otherclient parameter. This is used to generate the actual link to the previous client patch under the "Previous" heading in the leftmost section of the secondary sequence box, reducing the value supplied for the otherclientprevious parameter to be only the displayed value. This parameter is meant to be used when the previous client patch is shared with the primary client, but the patch number for the secondary client is not the patch number used on the actual linked page.
  • Valid Value(s): Any string corresponding to a valid patch number.

otherclientnext

  • Usage: Optional
  • Description: The otherclientnext parameter takes a string denoting the number of the client patch that came after the current client patch, as numbered for the client chosen in the otherclient parameter. This is used to generate a link to the next client patch under the "Next" heading in the rightmost section of the secondary sequence box. This parameter is meant to be used in situations where the next patch applies to two clients, but its number is not synchronized across both. This parameter is only usable if the otherclient parameter is filled in. If this parameter is filled in with the string "none," thus denoting that the current patch is the last in its sequence, there will be no "Next" in the secondary sequence box. If this parameter is omitted entirely the value defaults to that of the next parameter.
  • Valid Value(s): Any string corresponding to a valid patch number, or the string "none."

ocnextactual

  • Usage: Optional
  • Description: The ocnextactual parameter takes a string denoting the actual number of the client patch page to link to for the client chosen in the otherclient parameter. This is used to generate the actual link to the next client patch under the "Next" heading in the leftmost section of the secondary sequence box, reducing the value supplied for the otherclientprevious parameter to be only the displayed value. This parameter is meant to be used when the next client patch is shared with the primary client, but the patch number for the secondary client is not the patch number used on the actual linked page.
  • Valid Value(s): Any string corresponding to a valid patch number.
Retrieved from "https://www.uoguide.com/index.php?title=Template:Client_Patch&oldid=56153"