Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

Difference between revisions of "Template:Series/Documentation"

From PCGamingWiki, the wiki about fixing PC games
m (→‎The table: rephrased)
(Series template deprecated)
Line 1: Line 1:
 +
==Series template deprecated==
 +
'''Note: April 15, 2020'''
 +
The series sidebar tag is being replaced by a new row inside the Infobox:
 +
 +
<pre>|taxonomy    =
 +
{{Infobox game/row/taxonomy/series            | Deus Ex }}</pre>
 +
 +
Please check the [[Taxonomy]] project page for more information.
 +
 +
==Overview==
 
The series sidebar serves as an extension of sorts for the Infobox, and is made up of two parts, [[#The tag|the tag]] as well as [[#The table|the table]]. It gives a list of all the games in a particular series and points out where the current article resides in that list. Code-wise, it is always located directly beneath [[PCGamingWiki:Editing guide/The infobox|the infobox]] and above [[PCGamingWiki:Editing guide/Key points and General information|Key points/General information]].
 
The series sidebar serves as an extension of sorts for the Infobox, and is made up of two parts, [[#The tag|the tag]] as well as [[#The table|the table]]. It gives a list of all the games in a particular series and points out where the current article resides in that list. Code-wise, it is always located directly beneath [[PCGamingWiki:Editing guide/The infobox|the infobox]] and above [[PCGamingWiki:Editing guide/Key points and General information|Key points/General information]].
  

Revision as of 15:15, 15 April 2020

Series template deprecated

Note: April 15, 2020 The series sidebar tag is being replaced by a new row inside the Infobox:

|taxonomy     =
{{Infobox game/row/taxonomy/series            | Deus Ex }}

Please check the Taxonomy project page for more information.

Overview

The series sidebar serves as an extension of sorts for the Infobox, and is made up of two parts, the tag as well as the table. It gives a list of all the games in a particular series and points out where the current article resides in that list. Code-wise, it is always located directly beneath the infobox and above Key points/General information.

Should only be used with a collection of games part of an overall series or franchise.


The tag

Syntax

{{Series|Game}}

Example

Halo
Halo: Combat Evolved 2003
Halo 2 2007
Halo: Spartan (series)
Halo Online 2015*
Halo 5: Forge 2016
Halo Wars (series)
Halo Recruit 2017
Halo: The Master Chief Collection (series)
Halo Infinite 2021

The tag is the portion that is written to articles. It acts as a proxy for the actual table (located in a dedicated Series: page).

In most cases, the actual table is already created and only the tag needs to be added. That being said, there will be times where a new series needs to be added in with no prior entry available. See below for details.


The table

The following is to used on a separate page using the Series: prefix. Creating a Series: page is the same process as creating a game article.

Syntax

{{Seriesbox|entries=
{{Seriesbox/parent|My Little Parent Series|}}
{{Seriesbox/row|[[The Game]]|2000}}
{{Seriesbox/row|[[Game 2: Electric Boogaloo]]|2004}}
{{Seriesbox/row|[[Game 3: Not Game 2]]|2014}}
{{Seriesbox/child|The Electric Boogaloo Spin-off}}
}}


Example

See Series:Game, Series:Halo, Series:Lego, or Series:Lego Batman.

The table is where the actual information is stored. It consists of two or more parts:

  • The header. Besides holding the table together, the title of the sidebar resides here:
    {{Seriesbox|entries=
    (content goes here)
    }}
    
  • Main game row. A row meant for full game releases in the series:
    {{Seriesbox/row|[[The Game]]|2000}}
    
  • Child series row. Defines a child series of the current series, such as a spin-off series or subseries that connects specific titles:
    {{Seriesbox/child|Name of the child series}}
    
  • Parent series row. Defines a parent series of the current series:
    {{Seriesbox/parent|Name of the parent series}}
    


General rules

  • Games should be ordered on first PC release date (oldest to newest).
  • If an expansion is standalone (i.e. does not require the base game to function), it should be considered a separate game and listed as a full title.
  • Use the full title of the game when adding it to the list.
  • Some franchises are too large to fit onto one table (ex. Star Wars). Narrow in on what sub-series a collection of games follow.
  • A new game in a series should only be added in if it has been confirmed that it will be released on the PC (either Windows, OS X, or Linux).
  • While not common, fan games and major mods for a series can be added in if it is worth mentioning. Ask a mod before editing it in.


Common issues

  • Issue: Cover thumbnail is listed as text in the series table.
  • Solution: Refresh the cache for the series page (More -> Refresh).
  • Description: This is caused by PCGW not having generated and cached the thumbnail of the cover yet, which might take a couple of minutes. A refresh of the cache might help.
  • Issue: Game includes a cover that isn't listed as a thumbnail nor as text in the series table.
  • Solution: Refresh the cache for the game page (More -> Refresh), and then the cache for the series page.
  • Description: This is caused by the game page not having updated its cached in a while, so the properties Property:Cover and Property:Cover filename haven't been set for it yet and therefor the series list can't retrieve the thumbnail.
  • Issue: Game includes the series sidebar, but isn't listed in the large series table even after cache refreshes.
  • Solution: Verify that {{Series|xxxx}} is being used, with a pipe | between the series template call and the name of the series, and that a colon : is not used instead, and then refresh the series page cache.
  • Description: Mistakenly writing {{Series:xxxx}} with a colon ( : ) instead of a pipe ( | ) will result in the game page transcluding the relevant Series:xxxx page directly instead of going through the Template:Series. This will case the necessary Property:Part of series declaration to not be set, which will mean the game will not be seen as a part of the series.