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 (woops, added missing <nowiki> tags)
m (linkifieid)
Line 50: Line 50:
 
</nowiki></pre>
 
</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><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.
+
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>
 
<pre><nowiki>

Revision as of 12:58, 12 March 2019

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

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 sidebar is made up of two parts:

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|title=Game|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>

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.
{{Seriesbox|title=Game|entries=
(content goes here)
}}<noinclude>[[Category:Series]]{{Series/ask}}</noinclude>
  • Main game row. A row meant for full game releases in the series.
{{Seriesbox/row|[[The Game]]|2000}}

Below the syntax you also have an <noinclude> </noinclude> section (prevents the contents they surround from being included into other pages) that adds the important {{Series/ask}} template call. This is what constructs the larger table of games on the Series: 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 {{Series|Game}} (or relevant game series) on game pages.

<noinclude>[[Category:Series]]{{Series/ask}}</noinclude>

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.