Difference between revisions of "Template:Series/Documentation"

Latest revision as of 21:03, 4 June 2020

Series template deprecated

Note: April 15, 2020

The manual use of the series sidebar tag ({{Series}}) has been deprecated and 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.

Using the taxonomy series row will automatically add an appropriate {{Series}} call below the infobox for the very first listed series (that actually has a series page) in the taxonomy row.

@@ Line 1: / Line 1: @@
-{{ii}} Should only be used with a collection of games part of an overall series or franchise
+==Series template deprecated==
+'''Note: April 15, 2020'''
-The Series Sidebar serves as an extension of sorts for the Infobox. 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.
+The manual use of the series sidebar tag ({{T|Series}}) has been deprecated and is being replaced by a new row inside the infobox:
-The sidebar is made up of two parts:
+<pre>|taxonomy     =
+{{Infobox game/row/taxonomy/series            | Deus Ex }}</pre>
+Please check the [[Taxonomy]] project page for more information.
+Using the taxonomy series row will automatically add an appropriate {{T|Series}} call below the infobox '''for the very first''' listed series (that actually has a series page) in the taxonomy row.
+<!-- Old documentation
+==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]].
+{{ii}} Should only be used with a collection of games part of an overall series or franchise.
 ==The tag==
@@ Line 18: / Line 30: @@
 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==
+-->
-{{ii}} The following is to used on a separate page using the <code>Series:</code> prefix. Creating a <code>Series:</code> page is the same process as creating a game article
-'''Syntax'''
-<pre><nowiki>
-{{Seriesbox|entries=
-{{Seriesbox/row|[[The Game]]|2000}}
-{{Seriesbox/row|[[Game 2: Electric Boogaloo]]|2004}}
-{{Seriesbox/row|[[Game 3: Not Game 2]]|2014}}
-}}<noinclude>[[Category:Series]]{{Series/ask}}</noinclude>
-</nowiki></pre>
-'''Example'''
-See [[Series:Game]], [[Series:Halo]], or [[Series:Lego]].
-The table is where the actual information is stored. It consists of 2 main parts:
-* The header. Besides holding the table together, the title of the sidebar resides here.
-<pre><nowiki>
-{{Seriesbox|entries=
-(content goes here)
-}}<noinclude>[[Category:Series]]{{Series/ask}}</noinclude>
-</nowiki></pre>
-* Main game row. A row meant for full game releases in the series.
-<pre><nowiki>
-{{Seriesbox/row|[[The Game]]|2000}}
-</nowiki></pre>
-Below the syntax you also have an <code><nowiki><noinclude> </noinclude></nowiki></code> section (prevents the contents they surround from being included into other pages) that adds the important <code>[[Template:Series/ask|<nowiki>{{Series/ask}}</nowiki>]]</code> template call. This is what constructs the larger table of games on the <code>Series:</code> pages, by querying for all games with the relevant [[Property:Part of series]] value. This property is declared by this very template, by the inclusion of <code><nowiki>{{Series|Game}}</nowiki></code> (or relevant game series) on game pages.
-<pre><nowiki>
-<noinclude>[[Category:Series]]{{Series/ask}}</noinclude>
-</nowiki></pre>
-'''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.