Template:Infotable/doc

From Valve Developer Community
Jump to: navigation, search
English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(台灣)‎ (zh-tw)
Edit-copy.png
This is a documentation subpage for Template:Infotable.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

This template creates a small table on the right with all the summary information. It can be used to describe various entities, console commands, modifications, games, tools, etc. For example for "Material Shader parameter" you can do:

{{infotable
|$param|img=[[File:param how it works.png|border|340px]]<br>$param in action
|type=s1
|char=P
|default=0
|engine=2
|in={{hl2|since}}
|shader={{ent|LightmappedGeneric}}<br>{{ent|VertexLitGeneric}}
|old={{ent|$olderparam}}
|new={{ent|$newerparam}}
}}


Preview

TypeThird Party Tool
EngineSource Source
PlatformsWindows Windows
 

Parameters

Icon-Bug.pngBug:{{{1}}}, located outside the table, will create paragraphs if the list of parameters continues, but there is nothing to the right of this parameter.   [todo tested in?]

The following describes all the parameters that are available in this template:

Template Description
{{infotable The beginning of this template.
| {{{declension}}} Optional. Some languages use declensions of words, so this parameter will allow you to choose which declension to use (if declension options are specified in the selected language).
Note.pngNote:If you are adding a translation to this template and there is a need to use declensions in your language, then the #default parameter should contain an indefinite declension, if possible, and subsequent ones, i.e. 0, 1, 2, etc., should contain other declension variants.
| {{{info}}} Optional. This parameter displays a small info message above the table. Available options:
  • 0 = Not in the FGD by default.
  • 1 = Not in the game by default, but got left over in the FGD.
  • 2 = This game is available on Steam, but it does not use any of the Source engines.
| {{{infotxt}}} Optional. Additional text that will be displayed under the text that is displayed by the {{{info}}} parameter. The text depends on the selected value in the {{{info}}} parameter:
  • If {{{info}}} = 0
    • 0 = It should not be put directly in a map.
    • 1 = It should not be put directly in a map. Can only be configured through code.
    • 2 = It should not be put directly in a map. Automatically generated by the game.
    • 3 = It should not be put directly in a map. Doesn't remove itself when picked up.
    • 4 = It should not be put directly in a map. Generated as part of another entity, and does not function on its own.
  • If {{{info}}} = 1
    • 0 = Not available anymore.
  • If {{{info}}} = 2
    • none
Note.pngNote:If you have entered anything other than the above numbers, it will be displayed instead.
| {{{1}}} OR {{{tico}}} Optional. Element name parameter. If {{{1}}} is specified, then this name will be used in the header of the table and at the beginning of the first line. {{{tico}}} (Template icon) - The name of the icon template, which is based on the template Template:New_icon, should be entered in this parameter. For example, to specify Half-Life 2, enter hl2. If it is specified, then it will be the same as {{{1}}}, but the name on the first line will have a color and an icon, and the name in the table header will also have an icon. if none of the parameters is specified, the page name will be used.
Note.pngNote:If the page name contains additional information, for example, the page is called "$someparam (Source)", then do not remove the "(Source)" part from the article title, but you need to write this element to this template without "(Source)". Example:
article title: $someparam (Source)
parameter {{{1}}}: $someparam
| {{{nt}}} Optional. This parameter can be used only if parameter {{{tico}}} is used.
| {{{state}}} Optional. The state of the element. Available options:
  • 0 = Obsolete
  • 1 = Released!
  • 2 = Development On Hold
  • 3 = In Open Beta development
  • 4 = In Closed Beta development
  • 5 = In Alpha development
  • 6 = In Pre-Alpha development
  • 7 = No longer being developed
| {{{replace}}} Optional. If the element is obsolete and has been replaced with another one, enter it in this parameter.
| {{{img}}} Optional. The image or icon of the element. If the element does not have an image, then you can put an image showing how this element works.
| {{{website}}} Optional. External link to the element's website.
| {{{download}}} Optional. External link to download the element. Mostly useful for modifications or third party tools.
| {{{ownwiki}}} Optional. External link to the element's own wikipedia.
| {{{type}}} The type of the element. Available options:
  • e0 = Point entity
  • e1 = Internal Point entity
  • e2 = Brush entity
  • e3 = Internal Brush entity
  • e4 = Mesh Entity
  • e5 = Path Entity
  • s0 = Material Shader
  • s1 = Material Shader parameter
  • c0 = QC command
  • c1 = Console Command
  • c2 = Console Variable
  • f0 = TXT File
  • f1 = CFG File
  • f2 = RES File
  • g0 = Game
  • g1 = Single Player Game
  • g2 = Multiplayer Game
  • g3 = Cooperative Game
  • g1,2 = Single Player Game<br>Multiplayer Game
  • m0 = Modification
  • m1 = Single Player Modification
  • m2 = Multiplayer Modification
  • m3 = Cooperative Modification
  • m1,2 = Single Player Modification<br>Multiplayer Modification
  • t0 = Official Tool
  • t1 = Open source Official Tool
  • t2 = Third Party Tool
  • t3 = Open source Third Party Tool
Note.pngNote:If you have entered anything other than the above numbers, it will be displayed instead.
| {{{char}}} Optional. It is needed for some elements if you need to specify that this article is in the category under this letter. For example, the $someparam element will have this parameter equal to S.
| {{{path}}} Optional. Indicates which path the element is in.
| {{{default}}} Optional. The default values of the element is written here. If this value differs in games, then each default value should be on a new line (use the <br> tag). For convenience, you can use a game icon template next to the value and specify in it, for example, only, remove, etc.
| {{{dev}}} Optional. The developer of the element. Available options:
  • 0 = Valve
  • 1 = Gearbox Software
  • 2 = Valve South
  • 3 = Ritual
  • 4 = Maverick Developments
  • 5 = Outerlight
  • 6 = Reperio Studios
  • 7 = Kuma Reality Games
  • 8 = Paleo
Note.pngNote:If you have entered anything other than the above numbers, it will be displayed instead.
| {{{engine}}} Optional. The engine on which this element works. Available options:
  • 0 = Quake
  • 1 = Goldsource
  • 2 = Source
  • 3 = Source 2
Note.pngNote:If you have entered anything other than the above numbers, it will be displayed instead.
| {{{in}}} Optional. Availability of this element. Available options:
  • 0 = In all games
Note.pngNote:If you have entered anything other than the above numbers, it will be displayed instead. Use icon templates with in, also, since, removed, not, etc.
| {{{platform}}} Optional. The platforms on which this element works.
| {{{base}}} Optional. What this element is based on. This parameter is suitable for third-party games that use existing versions of the engine and differ little from it, or it is suitable for mods to indicate which game the mod was created on.
| {{{releasedate}}} Optional. Release date of the element.
| {{{shader}}} Optional. A list of all shaders where this element is used. It is mainly used for "Material Shader parameter", but can be used in other situations as well.
| {{{lastver}}} Optional. The last version of the element. If the latest version is not the version that was released, then you should also write the release date of the latest version of the element.
| {{{metascore}}} Optional. Metacritic game score. The color is selected automatically based on this table
| {{{metalink}}} Optional. link to game review. Before adding a link, remove this part from it: https://store.steampowered.com/
| {{{old}}} Optional. This parameter will be placed at the bottom of the table with the left arrow. It is mainly intended to link to a similar article, but on which there is an older version of the element, or the version of the element on the previous game engine. It can also be used for a series of games, that is, an analog of a table with a hierarchy of the game, but more simplified. In this case, you need to enter the previous game in this parameter, based on the release date.
| {{{new}}} Optional. This parameter will be placed at the bottom of the table with the right arrow. It is mainly intended to link to a similar article, but on which there is a newer version of the element, or the version of the element on the next game engine. It can also be used for a series of games, that is, an analog of a table with a hierarchy of the game, but more simplified. In this case, you need to enter the next game in this parameter, based on the release date.
| {{{steam}}} Optional. Adds Steam icon with a link to the element's page in Steam. Before adding a link, remove this part from it: https://store.steampowered.com/
| {{{moddb}}} Optional. Adds ModDB icon with a link to the element page in ModDB. Before adding a link, remove this part from it: https://www.moddb.com/
| {{{github}}} Optional. Adds GitHub icon with a link to the element page in GitHub. Before adding a link, remove this part from it: https://github.com/
| {{{wiki}}} Optional. Adds Wikipedia icon with a link to the element's Wikipedia page.
| {{{discord}}} Optional. Adds Discord icon with a link to the element's Discord.
| {{{twitter}}}
| {{{x}}}
Optional. Adds X (formerly Twitter) icon with a link to the element's Twitter.
| {{{reddit}}} Optional. Adds Reddit icon with a link to the element's Reddit.
| {{{notion}}} Optional. Adds Notion icon with a link to the element's Notion.
}} End of template. The text should be written after this template, without going to a new line.