Template:System requirements/doc

This template is designed to simplify to add additional information about system requirements to articles.

Syntax

{{System requirements
|caption      =
|useminandrec =<!--{yes/no}-->
|collapse     =
|align        =<!-- {none/left/right} Default is right -->
|width        =<!-- Default is 32em -->
|pad          =<!-- Default is 1em -->
<!--
          Mandatory section
-->
|platform1    =<!--Required -->
|os1          =
|os1rec       =
|cpu1         =
|cpu1rec      =
|memory1      =
|memory1rec   =
|gpu1         =
|gpu1rec      =
|sound1       =
|sound1rec    =
|network1     =
|network1rec  =
|hdspace1     =
|hdspace1rec  =
|media1       =
|media1rec    =
|display1     =
|display1rec  =
|input1       =
|input1rec    =
<!--
          Optional section
-->
|platform2    =<!--Required -->
|os2          =
|os2rec       =
|cpu2         =
|cpu2rec      =
|memory2      =
|memory2rec   =
|gpu2         =
|gpu2rec      =
|sound2       =
|sound2rec    =
|network2     =
|network2rec  =
|hdspace2     =
|hdspace2rec  =
|media2       =
|media2rec    =
|display2     =
|display2rec  =
|input2       =
|input2rec    =
<!--
          More optional sections below
-->
}}

Generic parameters

width

Specifies the width of the entire table. Default is 32em (length of 32 "M" characters). To specify width in pixels, use px suffix, e.g. 300px.

useminandrec

Set to "yes" if you want to use both "Minimum" and "Recommended" columns for requirements. Any other value, or omitting this parameter, will only give a "Requirements" column.

pad

Specifies the amount of indentation before the caption. Default is 2.5em (length of 2.5 "M" characters). To specify width in pixels, use px suffix, e.g. 15px.

collapse

If set, the table will start collapsed.

caption

If not set, the title to the requirements table will be set as "System requirements". Set this value to change this title.

align

Specifies whether the table should float to the left or right of the screen. Can be none, left or right. Default is right.

System specific parameters

platformn (where n is a number from 1 to 9)

Identify the personal computing platform that requirements will be given form. The number will correspond with the numbers in the parameters below (eg "cpu1" corresponds with "platform1"). If this value is missing, then all parameters of the same number will be ignored.

The remaining parameters take the form of "fieldn" and "fieldnrec", where n corresponds to the platform number above. The first parameter is what will be used for that field, or as it's minimum if "useminandrec" is set to "yes". If no value exists for this field, there will be no entry in the row (all field parameters below are optional). The second parameter "fieldnrec" is used to specific the recommended requirements for this field; this value will only be shown if "useminandrec" is set to "yes". If this parameter is not specified and "useminandrec" is set to "yes", then the first parameter value will be used in its place (via column-spanning). For example, to describe the minimum CPU requirements for the 2nd platform that is specified, define a value for the parameter "cpu2"; the recommended CPU requirements would be "cpu2rec".

The field values are:

os	Operating System
cpu	CPU
memory	Memory requirements
hdspace	Hard Drive Space
media	Media type (floppy, CD-Rom, DVD, etc.)
gpu	Graphics Hardware (card or graphic driver support)
display	Display (minimum resolution, VGA/EGA/etc.)
sound	Sound Hardware
input	Input Devices
network	Network requirements (dial-up/DSL/Cable, minimum up/down speed, etc.)

Example

The following example is based on the BioShock system requirements.

Code

{{System requirements
|useminandrec=yes
|align=none
|platform1=Windows
|os1=Windows XP with Service Pack 2 or Windows Vista
|cpu1=Pentium 4 2.5 GHz (single core)
|cpu1rec=Intel Core 2 Duo or AMD Athlon 64 X2
|memory1=1 GB
|memory1rec=2 GB
|gpu1=DirectX 9.0c compliant card with 128 MB RAM (NVIDIA 6600/ATI X1300 or better, excluding ATI X1550), Must support Pixel Shader 3.0
|gpu1rec=DirectX 9.0c compliant card with 512 MB RAM (NVIDIA 7900GT or better) or DirectX 10 compliant card (NVIDIA 8600 or better)
|sound1=100% DirectX 9.0c compliant card
|sound1rec=Sound Blaster X-Fi (Optimized for EAX ADVANCED HD 4.0/5.0 compatible cards)
|network1=Internet connection required for activation
|hdspace1=8 GB of free space
}}

Product

Configuration requise

Minimum Recommended Windows Système d'exploitation Windows XP with Service Pack 2 or Windows Vista CPU Pentium 4 2.5 GHz (single core) Intel Core 2 Duo or AMD Athlon 64 X2 Memory 1 GB 2 GB Hard Drive 8 GB of free space Graphics DirectX 9.0c compliant card with 128 MB RAM (NVIDIA 6600/ATI X1300 or better, excluding ATI X1550), Must support Pixel Shader 3.0 DirectX 9.0c compliant card with 512 MB RAM (NVIDIA 7900GT or better) or DirectX 10 compliant card (NVIDIA 8600 or better) Carte son 100% DirectX 9.0c compliant card Sound Blaster X-Fi (Optimized for EAX ADVANCED HD 4.0/5.0 compatible cards) Network Internet connection required for activation

See also

• Template:System requirements/Sub (backlinks edit)