Help:Editing/Page Templates

From Valve Developer Community
< Help:Editing
Revision as of 18:26, 7 February 2018 by Mattshu (talk | contribs) (Behavior switches: added __FORCETOC__)

Jump to: navigation, search

Page Creation

Editing Toolbar

button_bold.png Bold text
button_italic.png Italic text
button_link.png Adding internal links
button_extlink.png Adding external links
button_headline.png Adding a headline
button_image.png Inserting a picture
button_nowiki.png Ignore Wiki formatting
button_sig.png Inserting your signature
button_hr.png Horizontal lines

Formatting Pages

Page Templates

Specific Formatting Guidelines

Markup Templates

{{note}} {{tip}} {{warning}} {{bug}} {{todo}} {{confirm}} {{unsigned}} {{clr}} {{wiki}}

Note

Adds an indented message to note information.

 
   Syntax {{note|<message>}} 
 Example {{note|You will never be [[VAC]] banned for using built-in cheat commands.}} 
   Results
Note:You will never be VAC banned for using built-in cheat commands.

Tip

Adds a helpful tip.

 
   Syntax {{tip|<message>}} 
 Example {{tip|With the Face Edit Sheet window, you can right-click on any surface to apply the current texture to it.}} 
   Results
Tip:With the Face Edit Sheet window, you can right-click on any surface to apply the current texture to it.

Warning

Adds a warning message.

 
   Syntax {{warning|<message>}} 
 Example {{warning|Do not release a mod without first checking for leaks.}} 
   Results Warning: Do not release a mod without first checking for leaks.

Bug

Used for describing a bug.

 
   Syntax {{bug|<message>}} 
 Example {{bug|Hammer will sometimes hang during play-testing.}} 
   Results
Bug: Hammer will sometimes hang during play-testing.

Todo

Describes what needs changed to a page.

 
   Syntax {{todo|<message>}} 
 Example {{todo|Add more information on textures}} 
   Results To do: Add more information on textures

Confirm

Marks information that needs confirmation.

 
   Syntax {{confirm|<message>}} 
 Example {{confirm|<code>multiplayer_break</code> determines where the gibs from a [[prop_physics_multiplayer]] are simulated.}} 
   Results
Confirm:multiplayer_break determines where the gibs from a prop_physics_multiplayer are simulated.
 
   Syntax {{confirm}} 
 Example * '''-exit''' - Exits the engine. {{confirm}} 
   Results * -exit - Exits the engine. [confirm]

Unsigned

For those who are slightly obsessive-compulsive, this template signs posts that were left unsigned in discussion pages.

 
   Syntax {{unsigned|<username>}} 
 Example Anybody else hate it when people don't sign their own comments? {{unsigned|FakeUser27}} 
   Results Anybody else hate it when people don't sign their own comments? Unsigned comment added by FakeUser27 (talkcontribs). Please use four tildes (~~~~) to sign your username.

Clr

Clears vertical space after an image. In the example below, {{clr}} is omitted in the input, then added between the text and image in the output.

Example This is cleared. {{clr}} [[Image:Skull_and_crossbones.png|50px|link=]]
With template This is cleared.
Skull and crossbones.png
Without template This is not cleared. Skull and crossbones.png

Wiki

Links the supplied text to a Wikipedia page. The syntax is similar to using internal links.

 
   Syntax {{wiki|<page name>|<alternate text>}} 
 Example The platform this game runs on is: {{wiki|Personal_computer|PC}} 
   Results The platform this game runs on is: PC

[Back to top]

Maintenance Templates

Note:These templates should be placed at the beginning of each page.
{{cleanup}} {{stub}} {{delete}} {{orphan}} {{screenshot}} {{cleanupmod}} | {{pov}} {{wip}} {{merge}} {{update}} {{translate}} {{finishtranslation}} {{updatetranslation}}

Cleanup

Used to mark articles in need of a general cleanup to conform to a sufficient level of quality. Pages with this template are added to Category:Cleanup.

Tip:You can also choose to add a reason for the cleanup by using {{cleanup|reason}}

Stub

Used to mark stub articles. Stubs are small articles that may need expanded. Pages with this template are added to Category:Stubs.


Delete

Used to mark a page for deletion. Pages with this template are added to Category:Candidates for speedy deletion.

Tip:You can also choose to add a reason for the deletion request by using {{delete|reason}}

Orphan

Used to mark pages that have few or no links to it. Pages with this template are added to Category:Cleanup and Category:Orphans.


Screenshot

Used to mark pages that are in need of a screenshot to visually convey the subject. Pages with this template are added to Category:Cleanup and Category:Screenshot needed.


Cleanupmod

Used to mark pages that do not conform to the mod profiles page. Pages with this template are added to Category:Cleanup.


POV

Used to mark pages that are not formatted in third-person. For help, see Help:Cleanup#Point_of_View. Pages with this template are added to Category:Cleanup and Category:POV Cleanup.


WIP

Used to mark pages that are currently undergoing active construction. Pages with this template are added to Category:Articles actively undergoing construction.


Merge

Used to mark similar pages that should be considered for a merge. For more information, see Help:Merging. Pages with this template are added to Category:Articles to be merged.

 
   Syntax {{merge|<article>}}


Update

Used to mark outdated articles that need updated with current information. Pages with this template are added to Category:Cleanup.


Translate

Used to mark pages that aren't translated for the page's language. Pages with this template are added to Category:To be translated.


Finishtranslation

Used to mark pages that have a reasonable amount of translated information, but isn't completely translated. Pages with this template are added to Category:To be translated.


Updatetranslation

Used to mark pages that require an update to its current translation. Pages with this template are added to Category:To be translated.


[Back to top]

Formatting Templates

Note:These templates effect elements outside of the editing boundaries and should be placed at the beginning of the article.

Otherlang2

Successor of the outdated {{otherlang}} template, this template is used to add a navigational bar at the upper-right corner of the page that links to other available translations for the current article.

 
   Syntax {{otherlang2
title=Title of page (optional)
noborder=true/false (optional)
lang=Page name:lang
lang2=Page name:lang2
etc...

For more detailed information, please see the template's page. It includes a list of available languages and explanations.

{{DISPLAYTITLE}}

This is a MediaWiki feature that is similar to the now-deprecated {{wrongtitle}} template. It changes the title of the page. This is mostly used for grammatical changes, as used on the page Filter_activator_team to make the name lowercase, as is the actual entity filter_activator_team. Another popular use is for translated pages. Instead of "Make_a_model_with_3DS_and_Photoshop:fr" as the title for French page, it reads Faire un modèle avec 3DS et Photoshop.

 
   Syntax {{DISPLAYTITLE:Title of page}}
Note:Do not use this template if the page uses the otherlang2 template. Instead, use the template's title=Title of page option.

Behavior switches

These templates can be placed anywhere in the page. A behavior switch controls the layout or behavior of the page and can often be used to specify desired omissions and inclusions in the content.

   Syntax Description
__NOTOC__ Hides the table of contents (TOC). Useful for small pages with many headers.
__FORCETOC__ Forces the table of contents to appear when there are less than three sections.
{{toc-right}} Acts as a behavior switch. This aligns the Table of Contents box to the right side of the page instead of the default left side.
__NOEDITSECTION__ Hides the [edit] boxes beside the headers.
__NEWSECTIONLINK__ Enables the option to add a sections to non-discussion pages.


[Back to top]

Entity-specific Templates

Valve Game Icons

These are generally placed on entity pages. They're used to help identify that an entity is only for certain Valve games. There are also specific templates that mark an entity as belonging to a specific game. They have names along the format of {{gamecode point}} and {{gamecode brush}}.

 Input   Output Game
{{source}} <Source> Source icon
{{as}} <Alien Swarm> Alien Swarm
{{cs}} <Counter-Strike> Counter-Strike
{{css}} <Counter-Strike: Source> Counter-Strike: Source
{{csgo}} <Counter-Strike: Global Offensive> Counter-Strike: Global Offensive
{{dm}} <Dark Messiah of Might and Magic> Dark Messiah of Might and Magic
{{dods}} <Day of Defeat: Source> Day of Defeat: Source
{{dota2}} <Dota 2> Dota 2
{{hl1}} <Half-Life> Half-Life
{{hl2}} <Half-Life 2> Half-Life 2
{{l4d}} <Left 4 Dead> Left 4 Dead
{{l4d2}} <Left 4 Dead 2> Left 4 Dead 2
{{portal}} [Portal] Portal
{{portal2}} [Portal 2] Portal 2
{{ricochet}} <Ricochet> Ricochet
{{tf2}} <Team Fortress 2> Team Fortress 2

EP2 add

Lists a feature added with the Orange Box Source Engine update.

 
   Syntax {{EP2 add|feature}} 
 Example {{EP2 add|barrels}} 
   Results barrels (New with Half-Life 2: Episode Two / Source 2007)

L4D add

Lists a feature added with the <Left 4 Dead>Left 4 Dead Source Engine update.

 
   Syntax {{L4D add|feature}} 
 Example {{L4D add|crates and barrels}} 
   Results crates and barrels (New with Left 4 Dead)

L4D2 add

Lists a feature added with the <Left 4 Dead 2>Left 4 Dead 2 Source Engine update.

 
   Syntax {{L4D2 add|feature}} 
 Example {{L4D2 add|vscripts and squirrels}} 
   Results vscripts and squirrels (New with Left 4 Dead 2)

P2 add

Lists a feature added with the [Portal 2]Portal 2 Source Engine update.

 
   Syntax {{P2 add|feature}} 
 Example {{P2 add|excursion funnel}} 
   Results excursion funnel (New with Portal 2)

OutputsTable

Easily creates an entity outputs table. See the template page for more information on it's syntax.

Keyvalues

Inputs

Outputs

<Counter-Strike: Source> Counter-Strike: Source Templates

<Team Fortress 2> Team Fortress 2 Templates


[Back to top]