Template:Software page/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 65: Line 65:


== Parameters ==
== Parameters ==
* {{Param|name}} - Full name.
* {{Param|name}} - The full name of the game. Necessary for image detection.
* {{Param|shortname}} - ''Optional:'' A short name in case files cannot use the full name due to system restrictions.
* {{Param|desc}} - Description of the software.
* {{Param|appid}} - Steam AppID
 
* {{Param|tools}} - A link to the tools inside this wiki. The parameter is created for Half-Life:Alyx Workshop Tools and others.
 
==== Optional: ====
* {{Param|shortname}} - A short name in case files cannot use the full name due to system restrictions.
* {{Param|appid}} - Steam AppID. Used in some links.
* {{Param|docs}} - Disables the button if the value "false" is specified. You can specify your article inside this wiki.
* {{Param|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.
* {{Param|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.
* {{Param|wiki}} - Link to the wiki of the current software.
* {{Param|wiki}} - Link to the wiki of the current software.
* {{Param|background}} - Adds a background. By default, the template searches for <nowiki>[[File:{{{shortname|{{{name|}}} - Background.png]]</nowiki> (jpg is also supported, but not prioritized).
* {{Param|background}} - Adds a background. By default, the template searches for "<Project> - Background.<format>".
* {{Param|release}} - Release date. The value "Soon" indicates "Coming soon"
* {{Param|release}} - Release date. The value "Soon" indicates "Coming soon"
* {{Param|mode}}
* {{Param|mode}}
Line 77: Line 81:
* {{Param|genre}}
* {{Param|genre}}
* {{Param|genre2}}
* {{Param|genre2}}
* {{Param|engine}}
* {{Param|engine}} - Game engine. Available values: 0 ({{gldsrc|4}}), 1 ({{source|4}}), 2 ({{source2|4}})
* {{Param|developer}}
* {{Param|developer}}
* {{Param|dev2}}, {{Param|dev3}}, {{Param|dev4}}
* {{Param|dev2}}, {{Param|dev3}}, {{Param|dev4}}
* {{Param|publisher}}
* {{Param|publisher}}
* {{Param|pub2}}, {{Param|pub3}}, {{Param|pub4}}
* {{Param|pub2}}, {{Param|pub3}}, {{Param|pub4}}
* {{Param|shortdesc}}
* {{Param|shortdesc}} - A short description of the software.
* {{Param|desc}}


{{Doc/Sandbox other|
{{Doc/Sandbox other|

Revision as of 01:54, 27 February 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.

Template:ModernNote

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.

Maximum number of screenshots: 12.

Examples:

  • Counter-Strike Source - Background.jpg
  • Counter-Strike Source - Screenshot 1.jpg
  • Counter-Strike Source - Screenshot 2.jpg
  • GameCover-Counter-Strike Source.jpg

Developers and Publishers

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

Parameters

  • {{{name}}} - The full name of the game. Necessary for image detection.
  • {{{desc}}} - Description of the software.


Optional:

  • {{{shortname}}} - A short name in case files cannot use the full name due to system restrictions.
  • {{{appid}}} - Steam AppID. Used in some links.
  • {{{docs}}} - Disables the button if the value "false" is specified. You can specify your article inside this wiki.
  • {{{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.
  • {{{wiki}}} - Link to the wiki of the current software.
  • {{{background}}} - Adds a background. By default, the template searches for "<Project> - Background.<format>".
  • {{{release}}} - Release date. The value "Soon" indicates "Coming soon"
  • {{{mode}}}
  • {{{mode2}}}
  • {{{genre}}}
  • {{{genre2}}}
  • {{{engine}}} - Game engine. Available values: 0 (GoldSrc GoldSrc), 1 (Source Source), 2 (Source 2 Source 2)
  • {{{developer}}}
  • {{{dev2}}}, {{{dev3}}}, {{{dev4}}}
  • {{{publisher}}}
  • {{{pub2}}}, {{{pub3}}}, {{{pub4}}}
  • {{{shortdesc}}} - A short description of the software.