Template:Software page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page. -->
This template enables software pages to use a standardized, universal interface.
This template enables software pages to use a standardized, universal interface.


Line 319: Line 319:
| align="center" | {{Param|release}}
| align="center" | {{Param|release}}
| Release date. Available values:
| Release date. Available values:
* {{Code|Soon}} - Coming soon
* {{Code|Soon}} – Coming soon
* {{Code|TBA}} - To be announced
* {{Code|TBA}} – To be announced
| {{CodeBlock|<nowiki>{{Software page|release = 3 Mar 2023}}</nowiki>}}
| {{CodeBlock|<nowiki>{{Software page|release = 3 Mar 2023}}</nowiki>}}
|-
|-
| align="center" | {{Param|mode <2-4}}
| align="center" | {{Param|mode <2-4>}}
| Game mode(s). See [[#Modes|Modes]] for details.
| Game mode(s). See [[#Modes|Modes]] for details.


Line 341: Line 341:
| align="center" | {{Param|engine}} and {{Param|engine 2}}
| align="center" | {{Param|engine}} and {{Param|engine 2}}
| Game engine(s). Available values:
| Game engine(s). Available values:
* {{Code|GoldSrc}} - {{goldsrc|4}}
* {{Code|GoldSrc}} – {{goldsrc|4}}
* {{Code|Source}} - {{source|4}}
* {{Code|Source}} – {{source|4}}
* {{Code|Source 2}} - {{source2|4}}
* {{Code|Source 2}} – {{source2|4}}
You can also write something of your own in this parameter(s).
You can also write something of your own in this parameter(s).
| {{CodeBlock|<nowiki>{{Software page|engine = GoldSrc}}</nowiki>}}
| {{CodeBlock|<nowiki>{{Software page|engine = GoldSrc}}</nowiki>}}
Line 350: Line 350:
| align="center" | {{Param|branch}}
| align="center" | {{Param|branch}}
| Engine branch. Available values:
| Engine branch. Available values:
* {{Code|Source 4}} - {{src04|4}}
* {{Code|Source 4}} – {{src04|4}}
* {{Code|Source 6}} - {{src06|4}}
* {{Code|Source 6}} – {{src06|4}}
* {{Code|Source 7}} - {{src07|4}}
* {{Code|Source 7}} – {{src07|4}}
* {{Code|Source 9}} - {{src09|4}}
* {{Code|Source 9}} – {{src09|4}}
* {{Code|Source 13}} - {{src13|4}}
* {{Code|Source 13}} – {{src13|4}}
* {{Code|Source 13 SP}} - {{src13sp|4}}
* {{Code|Source 13 SP}} – {{src13sp|4}}
* {{Code|Source 13 MP}} - {{src13mp|4}}
* {{Code|Source 13 MP}} – {{src13mp|4}}
* {{Code|Portal 2}} - {{portal2branch|4}}
* {{Code|Portal 2}} – {{portal2branch|4}}
You can also write something of your own in this parameter.
You can also write something of your own in this parameter.
| {{CodeBlock|<nowiki>{{Software page|branch = Source 6}}</nowiki>}}
| {{CodeBlock|<nowiki>{{Software page|branch = Source 6}}</nowiki>}}
Line 388: Line 388:


{{Doc/Sandbox other|
{{Doc/Sandbox other|
<!-- Categories below this line, please -->
<!-- Categories below this line, please. -->
[[Category:Templates]]
[[Category:Templates]]
}}
}}

Revision as of 06:38, 9 April 2023

Edit-copy.png
This is a documentation subpage for Template:Software page.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template enables software pages to use a standardized, universal interface.

Translations

The used strings are on strings subpage. Please follow the format to add translations for them.

Sandbox

This template searches for files based only on the information provided to it in the parameters, that is, you can create a fully functional copy of the conditional Half-Life 2 page anywhere else.

Use the template sandbox for your experiments.

Images

Supported formats: JPG, PNG. Template:ModernTip Template:ModernTip Maximum number of screenshots: 12.

Recommended aspect ratio of screenshots: 16:9.

Recommended cover resolution: 460x215 pixels.

Examples:

  • Counter-Strike Source - Background.jpg
  • Counter-Strike Source - Trailer Preview.jpg
  • Counter-Strike Source - Screenshot 1.jpg
  • Counter-Strike Source - Screenshot 2.jpg
  • SoftwareCover-Counter-Strike Source.jpg

Translations:

At the moment, only screenshots have translation support. Below is an example of the names of the translated files.

  • Counter-Strike Source - Screenshot 1 (de).jpg
  • Counter-Strike Source - Screenshot 1 (ru).jpg
  • Counter-Strike Source - Screenshot 1 (zh).jpg

Media:

  • You can download a Photoshop document to create a software background.

Developers and Publishers

Use this in {{{developer}}} or {{{publisher}}}. You can also write something of your own and apply some special formatting to it.

Parameter Value Result
Valve Unrecognized string used!
Gearbox Unrecognized string used!
TRS Unrecognized string used!
Ritual Unrecognized string used!
MD Unrecognized string used!
Outerlight Unrecognized string used!
RS Unrecognized string used!
KRG Unrecognized string used!
Paleo Unrecognized string used!
Facepunch Unrecognized string used!

Modes

Parameter Value Result
SP Single Player
MP Multiplayer Game
COOP Cooperative Game
MMO MMO

Deck Verified Status

Parameter Value Result
Verified This game has been tested and is fully supported and playable on the Steam Deck
Playable This game has been tested and is playable on the Steam Deck
Unsupported This game has been tested and is unsupported on the Steam Deck
Unknown This game has not been tested on the Steam Deck

Genres

Parameter Value Result
Indie Indie
FPS First Person Shooter
TPS Third Person Shooter
Fighting Fighting
Arcade Arcade
Stealth Stealth
Adventure Adventure
Platformer Platformer
PAC Point & Click
VN Visual Novel
Racing Racing
RP Role Playing
Roguelike Roguelike
Remake Remake
MOBA MOBA
RTS Real-Time Strategy
Puzzle Puzzle
Sandbox Sandbox
Battle Royale Battle Royale

Platforms

Use these in the {{{platform <2-5>}}} parameter. While you can specify your own platform, it is recommended you use these, otherwise the automatic Category placement could not work correctly.

Parameter Value Result
PC PC
Xbox Xbox
X360 Xbox 360
Xbox_One Xbox One
Xbox_XS Xbox Series X|S
Ps2 PlayStation 2
Ps3 PlayStation 3
Ps4 PlayStation 4
Ps5 PlayStation 5
Switch Nintendo Switch
Steamdeck Steam Deck
Android Android

Please only put the platforms the game released on; Do not list the entire Xbox series for a game that released on the original (although, if a game released on two consoles from the same family, do list them separately)

Copy and Paste

{{Software page | name = | shortdesc = | release = | mode = | genre = | platform = | engine = | branch = | developer = | publisher = | desc = {{MultiPage}} }}

Parameters and Examples

Parameter Description Example
{{{name}}} The full name of the game. Necessary for image detection.
{{Software page|name = Counter-Strike: Source}}
{{{shortname}}} A short name in case files cannot use the full name due to system restrictions.
{{Software page|shortname = Counter-Strike Source}}
{{{appid}}} Steam AppID. Used in some links.
{{Software page|appid = Team Fortress 2}}

Links

{{{docs}}} Disables the button if the value "false" is specified. You can also specify an article located inside this wiki.
{{Software page|docs = true}}
{{Software page|docs = Counter-Strike/docs}}
{{{workshop}}} Disables the button if the value "false" is specified. If this is a mod located in the workshop of some game, then you can specify its ID here. Leave blank if you want to point it to the game's workshop via AppID instead.
{{Software page|workshop = true}}
{{Software page|workshop = 2269588821}}
{{{wiki}}} Link to the wiki.
{{Software page|wiki = http://wiki.teamfortress.com
{{{website}}} Link to the website.
{{Software page|website = http://www.teamfortress.com
{{{blog}}} Link to the blog.
{{Software page|blog = https://blog.counter-strike.net}}

Background

{{{background}}} Disables the background if the value "false" is specified. By default, the template searches for "<Project> - Background.<format>", but you can specify any file in this parameter.
{{Software page|background = false }}
{{Software page|background = [[File:Counter-Strike - Screenshot 1.jpg]] }}
{{{background opacity}}} Background opacity. The default value is .1.
{{Software page|background opacity = .5 }}

Screenshots and Movies

{{{trailer}}} Link to the trailer.
{{Software page|trailer = http://cdn.cloudflare.steamstatic.com/steam/apps/256881738/movie480_vp9.webm}}
{{{trailer preview}}} Specifies the format of the desired image. After specifying the format, creates a file based on {{{name}}} and {{{shortname}}}. See Images for details.
{{Software page|trailer preview = jpg}}
{{{screenshot <1-12> desc}}} Screenshot description.
{{Software page|screenshot 7 desc = Particle System}}
{{{screenshot <1-12> lang}}} Screenshot translation.
{{Software page|screenshot 7 lang = {{Autolang||de = de|ru = ru|zh = zh}}}}

Infopanel

{{{DLC}}} or {{{mod}}} If the value "true" is specified, the tags corresponding to the name of the parameters will appear in the upper left corner of the cover.
{{Software page|DLC = true}}
{{{deck}}} Steam Deck verified status. For avaliable values, see Deck Verified Status.
{{Software page|deck = Verified}}
{{{shortdesc}}} A short description of the software.
{{Software page|shortdesc = Hello, World!}}
{{{release}}} Release date. Available values:
  • Soon – Coming soon
  • TBA – To be announced
{{Software page|release = 3 Mar 2023}}
{{{mode <2-4>}}} Game mode(s). See Modes for details.

Template:ModernNote

{{Software page|mode = MP}}
{{Software page|mode 2 = Indie}}
{{{genre <2-4>}}} The genre(s) of the game. See Genres for details.

Template:ModernNote

{{Software page|genre = Action}}
{{Software page|genre 2 = FPS}}
{{{platform <2-5>}}} Platform(s) the game released on. See Platforms for details.
{{Software page|platform = PC}}
{{Software page|platform = PC|platform 2 = Linux}}
{{{engine}}} and {{{engine 2}}} Game engine(s). Available values:

You can also write something of your own in this parameter(s).

{{Software page|engine = GoldSrc}}
{{Software page|engine = Unity}}
{{{branch}}} Engine branch. Available values:

You can also write something of your own in this parameter.

{{Software page|branch = Source 6}}
{{Software page|branch = Source 13 MP}}
{{Software page|branch = Unity}}
{{{developer <2-4>}}} Game developer(s). See Developers and Publishers for details.
{{Software page|developer = Valve}}
{{Software page|developer = Valve|developer 2 = [http://www.valvesoftware.com Valve]}}
{{{publisher <2-4>}}} Publisher(s) of the game. See Developers and Publishers for details.
{{Software page|publisher = Valve}}
{{Software page|publisher = Valve|publisher 2 = [http://www.valvesoftware.com Valve]}}

Software Description

{{{desc}}} Description of the software. This is the main body of the article, and is usually where the {{MultiPage}} template is placed.
{{Software page|desc = {{MultiPage}}}}

Used Categories

Template Subpages


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Software_page/doc&oldid=294422"