Difference between revisions of "Help:Style guide/Maps"

From Team Fortress Wiki
Jump to: navigation, search
(Strategy)
(Locations: more clarification)
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Help navbar}}
 
{{Help navbar}}
  
This guide will hopefully help people adhere to a consistent standard of style and formatting throughout TF Wiki [[:Category:Maps|map articles]]. Covering all situations would take a long time and the following is only meant to be a reference for TF Wiki specific guidelines.
+
This '''Map Style guide''' will hopefully help people adhere to a consistent standard of style and formatting throughout the Team Fortress Wiki [[:Category:Maps|map articles]]. Covering all situations would take a long time, and the following is only meant to be a reference for the Team Fortress Wiki's specific guidelines.
  
== Article Titles ==
+
== Article titles ==
 
Article titles should be the map's name, without a prefix. For maps with conflicting versions of the name, the name displayed in the game on the loading screen should be used.
 
Article titles should be the map's name, without a prefix. For maps with conflicting versions of the name, the name displayed in the game on the loading screen should be used.
  
*'''Example:''' [[Double Cross]], not Doublecross, is used despite appearing in both forms, as Double Cross is what appears in-game.
+
*'''Example:''' [[Double Cross]], not Doublecross, is used despite appearing in both forms as Double Cross is what appears in-game.
  
For maps with multiple versions, the original version, or official version, takes the normal article title, while additional versions have their full game mode appended in parentheses.
+
For maps with multiple versions, the original version or official version takes the normal article title, while additional versions have their full game mode appended in parentheses.
  
*'''Example:''' arena_nucleus uses the title [[Nucleus]], while koth_nucleus uses [[Nucleus (King of the Hill)]]
+
*'''Example:''' arena_nucleus uses the title [[Nucleus]], while koth_nucleus uses the title [[Nucleus (King of the Hill)]].
*'''Example:''' koth_harvest uses the title [[Harvest]], despite arena_harvest being the original version, because koth_harvest is official
+
*'''Example:''' koth_harvest uses the title [[Harvest]], despite arena_harvest being the original version, because koth_harvest is the official version.
  
 
Maps with multiple variations should list the other variations via hatnote on each article, reading as follows:
 
Maps with multiple variations should list the other variations via hatnote on each article, reading as follows:
 
{{hatnote|'''Map''' has multiple variations, including game mode}}
 
{{hatnote|'''Map''' has multiple variations, including game mode}}
  
*'''Example:''' {{hatnote|'''Nucleus''' has multiple variations, including [[Nucleus (Arena)|Arena]]}}
+
*'''Example:''' {{hatnote|'''Nucleus''' has multiple variations, including [[Nucleus (Arena)|Arena]].}}
** Notice that Arena links to [[Nucleus (Arena)]]
+
** Notice that Arena links to [[Nucleus (Arena)]].
  
 
== Introduction ==
 
== Introduction ==
Line 26: Line 26:
 
A quotation from an update or promotional page may be added at the top of the page, but below any hatnotes related to variations.
 
A quotation from an update or promotional page may be added at the top of the page, but below any hatnotes related to variations.
  
'''Introduction videos''' should be the first body section, immediately following the introduction.
+
'''Introduction videos''' should be the first body section immediately following the introduction section.
  
 
== Content ==
 
== Content ==
These are body sections strongly recommended to be used. If content for the article fits one of the following sections, that section should be created and content should be placed there. Sections should be ordered as they appear here. Sections not mentioned should appear after the introduction video and before screenshots, but not be placed inbetween Locations and Strategy.
+
These are body sections strongly recommended to be used. If content for the article fits one of the following sections, that section should be created and content should be placed there. Sections should be ordered as they appear here. Sections not mentioned should appear after the introduction video and before screenshots, but not be placed in between the Locations and Strategy sections.
  
=== Introduction Video ===
+
=== Introduction video ===
 
If an introduction video exists for the map, it should be embedded in this section. This section should immediately follow the article introduction and be the first titled section.
 
If an introduction video exists for the map, it should be embedded in this section. This section should immediately follow the article introduction and be the first titled section.
  
Line 37: Line 37:
  
 
=== Locations ===
 
=== Locations ===
This section should contain notable locations and basic information about the locations.
+
This section should identify notable tactical locations of the map as well as basic information about the locations, including related gameplay features. Primarily, the Locations section supports writing map-specific Community map strategies; as map-specific tactics are usually specific to particular places on the map. In this sense, Locations should also be the basis for describing unique mechanics of the map (commonly, gate openings on Payload and Attack/Defend maps, or event triggers in [[Halloween map]]s).
  
*For [[Control Point]] maps, Locations should be divided by '''control point'''.
+
* At a minimum [[Control Point (game mode)|Control Point maps]] and [[Payload]] should be divided by '''control points''' and '''capture points''', respectively.  Often, further map sections can be identified, since, especially on Payloads and Attack/Defend, major tactical combat areas and chokes appear separate from the points (an example being [[Mossrock]]).
*For maps with multiple stages, Locations should be divided by '''stage'''.
+
* Locations for multi-stage maps should overall be divided by the '''stages'''.
*For single-stage [[Payload]] maps, Locations should be divided by '''capture point'''.
+
* For [[Arena]], [[King of the Hill]], and [[Capture the Flag]] maps, locations should be divided ''as appropriate''.
*For [[Arena]], [[King of the Hill]], and [[Capture the Flag]] maps, Locations should be divided ''as appropriate''.
 
  
Locations should be properly titled, as by their name. Control points are named in maps, and the names as they appear in-game should be used.
+
Locations should be properly titled, as by their name (typically '''bolded'''). Control points are named in maps, and the names as they appear as the points are captured in-game should be used in Locations. Location names used by developers can sometimes be found in change logs and Community maps developer workshop pages. Each Location subsection optimally would contain some screenshots of the locations being discussed.
  
 
'''Example''' (from [[Coldfront]]):
 
'''Example''' (from [[Coldfront]]):
 
  == Locations ==
 
  == Locations ==
  === Control Point 3 (Decrepit Cabin) ===
+
  === Control point 3 (Decrepit Cabin) ===
  The central control point rests comfortably within the wreckage of the cabin.
+
  * '''Control Point''': The central control point rests comfortably within the wreckage of the cabin.
  *Entrances: Each team has 3 paths to the house area. Two paths enter from the ground, going uphill as you get closer to the house, and an upper path among the one of the high cliffs.
+
  * '''Entrances''': Each team has three paths to the house area. Two paths enter from the ground, going uphill as you get closer to the house, and an upper path among the one of the high cliffs.
  *High Cliff: One of the passageways into the area from yard. Normally a one-way drop-down, but scouts and soldiers can climb up, too. Common sniper perch.
+
  * '''High Cliff''': One of the passageways into the area from yard. Normally a one-way drop-down, but Scouts and Soldiers can climb up, too. It is a common Sniper perch.
  *House: The worn down cabin which holds the CP. Soldiers and demos can rocket jump on top for a better view of the area.
+
  * '''House''': The worn down cabin which holds the control point. Soldiers and Demomen can rocket jump on top for a better view of the area.
  *Behind the Rocks: A small safe haven for medics and engineers, especially due to the close proximity to medium health and ammo packs.
+
  * '''Behind the Rocks''': A small safe haven for Medics and Engineers, especially due to the close proximity to medium Health and Ammo packs.
  *Yard: Each side has a large, open intermediate area in between CP2 and the CP3 cabin. Separated into two halves by a pipe-bridge.
+
  * '''Yard''': Each side has a large, open intermediate area in between CP2 and the CP3 cabin. Separated into two halves by a pipe-bridge.
 
 
Each section optimally would contain a screenshot of the location being discussed.
 
  
 
=== Strategy ===
 
=== Strategy ===
To keep the map pages clean, strategies for playing on various maps should be placed on their own community strategy pages, such as [[Community 2Fort strategy]] for [[2Fort]]. Be sure to place class-specific strategies under their respective sections, and cooperative or counter-class strategies where appropriate.
+
: ''See also [[Help:Style guide/Community Strategy|Community Strategy Style Guide]] and [[Team Fortress Wiki:Community Strategy|Community Strategy Project]].''
 +
To keep the map pages clean, strategies for playing on various maps should be placed on separate Community strategy pages, such as the [[Community 2Fort strategy]] page for [[2Fort]]. In most cases, this section contains only a link to the [[:Template:Main|''Main article'']] template linking to the map's Community strategy page. This section may also contain a [[:Template:Community strategy stub link|Community strategy stub]] tag when the map's Community strategy page has too little content.
  
Users are encouraged to add relevant strategies where needed, but also remember to follow the [[Help:Style guide|style guidelines]] as well.
+
A [[:Template:Start map strategy|start map strategy]] substitution template is provided for creating Community strategy stubs. Users are encouraged to contribute relevant strategies as they are able, while remembering to follow the [[Help:Style guide|general style guidelines]] as well. Be sure to place class-specific strategies under their respective sections, and cooperative or counter-class strategies where appropriate.  
  
 
=== Control Point Timing ===
 
=== Control Point Timing ===
For maps with a control point or capture point, use of [[:Template:Control Point Timing]] is encouraged, and should be placed in this section.
+
For maps with a control point or capture point, use of [[:Template:Control Point Timing]] is encouraged and should be placed in this section.
  
=== Screenshots ===
+
=== Update history ===
Screenshots related to the map should be placed in a gallery, in this section, using the <nowiki><gallery></nowiki> tags.
+
For official maps, patch logs relevant to the map must be placed in this section using the [[:Template:Patch name|Patch name]] and [[:Template:Update history|Update history]] templates.
 +
 
 +
=== Changelog ===
 +
For custom Community maps, a changelog is usually included with the map. This changelog can be added to the article using [[:Template:Changelog]] within this section.
 +
 
 +
=== Bugs ===
 +
A bulleted list of the map's observed Bugs, if any, is included here.
 +
 
 +
=== Trivia ===
 +
This section should contain any small facts about the map that may be interesting to a reader that are not covered by other sections. As with other Trivia sections, please be sure to follow the [[Help:Style_guide/Trivia|Trivia guidelines]].
 +
{{anchor|Screenshots}}
 +
=== Gallery ===
 +
Screenshots and other images related to the map are usually placed in this section in a gallery, using the {{code|<nowiki><gallery></nowiki>}} tags.  Screenshots galleries are also commonly used in Locations sections.
  
 
'''Example''' (from [[Coldfront]]):
 
'''Example''' (from [[Coldfront]]):
Line 78: Line 88:
 
Screenshots should be captioned if possible.
 
Screenshots should be captioned if possible.
  
=== Changelog ===
+
=== References ===
For custom maps, a changelog is usually included with the map. This changelog can be added to the article using [[:Template:Changelog]] and contained within this section.
+
Include this section with the {{code|<nowiki><references/></nowiki>}} tag if {{code|<nowiki><ref></ref></nowiki>}} tags are used.
 
 
For official maps, a patch log can be contained here.
 
  
=== Trivia ===
+
{{anchor|Additional links}}
This section should contain any small facts about the map that may be interesting to a reader.
+
=== External links ===
 +
Links to external information should be contained within this section in a bulleted list. Any screenshots should be uploaded to the Team Fortress Wiki and included in the Gallery section, so '''do not''' link to external image galleries.
  
=== Additional Links ===
+
=== See also ===
Links to external information should be contained within this section. Any screenshots should be uploaded to TF Wiki and included in the Screenshots section, so '''do not''' link to external image galleries.
+
A bulleted ''See also'' section may be added to link to other notably relevant Team Fortress Wiki pages.
  
 
== Categorization ==
 
== Categorization ==
Through use of [[:Template:Map infobox]], map articles are automatically included in [[:Category:Maps]]. Custom maps must be manually included in [[:Category:Custom maps]].
+
Through use of [[:Template:Map infobox]], map articles are automatically included in [[:Category:Maps]]. Custom maps must be manually included in [[:Category:Custom maps]] using [[:Template:Custom map]].
  
Maps should be sub-categorized by game mode.
+
Maps are automatically subcategorized by game mode when using the infobox.
  
 
== Spelling & Phrasing ==
 
== Spelling & Phrasing ==
Spelling and phrasing should be consistent across articles. The following applies only to map articles unless contained in the style guide for the entire wiki.
+
Spelling and phrasing should be consistent across articles. The following applies only to map articles unless contained in the Style guide for the entire wiki.
  
* '''Control point''' is not capitalized. [[Control Point]], the game mode, is.
+
* '''Control point''' is not capitalized. [[Control Point (game mode)|Control Point]], the game mode, is.
 
* '''The payload''' is to be referred to as ''the cart''. ''The bomb'' and ''the payload'' are not acceptable.
 
* '''The payload''' is to be referred to as ''the cart''. ''The bomb'' and ''the payload'' are not acceptable.
* '''Capture point''' can be used in place of ''control point'' in attack/defend maps. ''Capture point'' cannot be used if both teams can control them.
+
* '''Capture point''' can be used in place of ''control point'' in Attack/Defend maps. ''Capture point'' cannot be used if both teams can control them.
 
** ''Exception'': in [[Arena]], it is a ''capture point'', as only one team can capture the point in each round.
 
** ''Exception'': in [[Arena]], it is a ''capture point'', as only one team can capture the point in each round.
  

Latest revision as of 23:21, 10 February 2019

This Map Style guide will hopefully help people adhere to a consistent standard of style and formatting throughout the Team Fortress Wiki map articles. Covering all situations would take a long time, and the following is only meant to be a reference for the Team Fortress Wiki's specific guidelines.

Article titles

Article titles should be the map's name, without a prefix. For maps with conflicting versions of the name, the name displayed in the game on the loading screen should be used.

  • Example: Double Cross, not Doublecross, is used despite appearing in both forms as Double Cross is what appears in-game.

For maps with multiple versions, the original version – or official version – takes the normal article title, while additional versions have their full game mode appended in parentheses.

  • Example: arena_nucleus uses the title Nucleus, while koth_nucleus uses the title Nucleus (King of the Hill).
  • Example: koth_harvest uses the title Harvest, despite arena_harvest being the original version, because koth_harvest is the official version.

Maps with multiple variations should list the other variations via hatnote on each article, reading as follows:

Map has multiple variations, including game mode
  • Example:
    Nucleus has multiple variations, including Arena.

Introduction

All map articles must contain an introduction. This introduction should include basic information about the map, such as the game mode, style of play, and goal, as well as any immediately pertinent information for a reader.

All map articles must use Template:Map infobox to include an infobox with the basic map details and a screenshot. For custom maps, an author, version, and download link must be provided.

A quotation from an update or promotional page may be added at the top of the page, but below any hatnotes related to variations.

Introduction videos should be the first body section immediately following the introduction section.

Content

These are body sections strongly recommended to be used. If content for the article fits one of the following sections, that section should be created and content should be placed there. Sections should be ordered as they appear here. Sections not mentioned should appear after the introduction video and before screenshots, but not be placed in between the Locations and Strategy sections.

Introduction video

If an introduction video exists for the map, it should be embedded in this section. This section should immediately follow the article introduction and be the first titled section.

To embed a video, use Template:Youtube.

Locations

This section should identify notable tactical locations of the map as well as basic information about the locations, including related gameplay features. Primarily, the Locations section supports writing map-specific Community map strategies; as map-specific tactics are usually specific to particular places on the map. In this sense, Locations should also be the basis for describing unique mechanics of the map (commonly, gate openings on Payload and Attack/Defend maps, or event triggers in Halloween maps).

  • At a minimum Control Point maps and Payload should be divided by control points and capture points, respectively. Often, further map sections can be identified, since, especially on Payloads and Attack/Defend, major tactical combat areas and chokes appear separate from the points (an example being Mossrock).
  • Locations for multi-stage maps should overall be divided by the stages.
  • For Arena, King of the Hill, and Capture the Flag maps, locations should be divided as appropriate.

Locations should be properly titled, as by their name (typically bolded). Control points are named in maps, and the names as they appear as the points are captured in-game should be used in Locations. Location names used by developers can sometimes be found in change logs and Community maps developer workshop pages. Each Location subsection optimally would contain some screenshots of the locations being discussed.

Example (from Coldfront):

== Locations ==
=== Control point 3 (Decrepit Cabin) ===
* Control Point: The central control point rests comfortably within the wreckage of the cabin.
* Entrances: Each team has three paths to the house area. Two paths enter from the ground, going uphill as you get closer to the house, and an upper path among the one of the high cliffs.
* High Cliff: One of the passageways into the area from yard. Normally a one-way drop-down, but Scouts and Soldiers can climb up, too. It is a common Sniper perch.
* House: The worn down cabin which holds the control point. Soldiers and Demomen can rocket jump on top for a better view of the area.
* Behind the Rocks: A small safe haven for Medics and Engineers, especially due to the close proximity to medium Health and Ammo packs.
* Yard: Each side has a large, open intermediate area in between CP2 and the CP3 cabin. Separated into two halves by a pipe-bridge.

Strategy

See also Community Strategy Style Guide and Community Strategy Project.

To keep the map pages clean, strategies for playing on various maps should be placed on separate Community strategy pages, such as the Community 2Fort strategy page for 2Fort. In most cases, this section contains only a link to the Main article template linking to the map's Community strategy page. This section may also contain a Community strategy stub tag when the map's Community strategy page has too little content.

A start map strategy substitution template is provided for creating Community strategy stubs. Users are encouraged to contribute relevant strategies as they are able, while remembering to follow the general style guidelines as well. Be sure to place class-specific strategies under their respective sections, and cooperative or counter-class strategies where appropriate.

Control Point Timing

For maps with a control point or capture point, use of Template:Control Point Timing is encouraged and should be placed in this section.

Update history

For official maps, patch logs relevant to the map must be placed in this section using the Patch name and Update history templates.

Changelog

For custom Community maps, a changelog is usually included with the map. This changelog can be added to the article using Template:Changelog within this section.

Bugs

A bulleted list of the map's observed Bugs, if any, is included here.

Trivia

This section should contain any small facts about the map that may be interesting to a reader that are not covered by other sections. As with other Trivia sections, please be sure to follow the Trivia guidelines.

Gallery

Screenshots and other images related to the map are usually placed in this section in a gallery, using the <gallery> tags. Screenshots galleries are also commonly used in Locations sections.

Example (from Coldfront):

<gallery perrow="5">
File:Cp coldfront0007.jpg
File:Cp coldfront rc20001.jpg
File:Cp coldfront0010.jpg
</gallery>

Screenshots should be captioned if possible.

References

Include this section with the <references/> tag if <ref></ref> tags are used.

External links

Links to external information should be contained within this section in a bulleted list. Any screenshots should be uploaded to the Team Fortress Wiki and included in the Gallery section, so do not link to external image galleries.

See also

A bulleted See also section may be added to link to other notably relevant Team Fortress Wiki pages.

Categorization

Through use of Template:Map infobox, map articles are automatically included in Category:Maps. Custom maps must be manually included in Category:Custom maps using Template:Custom map.

Maps are automatically subcategorized by game mode when using the infobox.

Spelling & Phrasing

Spelling and phrasing should be consistent across articles. The following applies only to map articles unless contained in the Style guide for the entire wiki.

  • Control point is not capitalized. Control Point, the game mode, is.
  • The payload is to be referred to as the cart. The bomb and the payload are not acceptable.
  • Capture point can be used in place of control point in Attack/Defend maps. Capture point cannot be used if both teams can control them.
    • Exception: in Arena, it is a capture point, as only one team can capture the point in each round.

When referring to a specific variation of a map, use the map's name appended with the game mode in parentheses. This holds true even if the variation in question is the original, and the article is not appended.

  • Example: Sawmill (King of the Hill) not KOTH Sawmill or koth_sawmill
  • Example: Nucleus (Arena) not Nucleus

See also

Team Fortress Wiki style guide A-Z - The TF Wiki A-Z of style guidelines