Difference between revisions of "Template:Map"

From DoomWiki.org

(mention sort key issues in documentation)
(markup -> algorithm, if that's not 199% pretentious)
 
Line 14: Line 14:
 
* '''{{c|<nowiki>name=</nowiki>}}''' overrides automatic detection of the title, for example to ignore a leading "The" or "A".
 
* '''{{c|<nowiki>name=</nowiki>}}''' overrides automatic detection of the title, for example to ignore a leading "The" or "A".
  
<u>Technical note about automatic sort keys:</u> The markup in this template is not designed to cover every possible grammatical situation (to avoid creating unmaintainable {{wp|Kudzu in the United States|kudzu}}). Unusual cases should be spot checked on category pages once they have updated, and if sorting is incorrect, just use '''{{c|nocat{{=}}true}}''' and manually add a [[mw:Help:Magic words#Technical metadata|DEFAULTSORT]] and the additional categories. In particular, there are known issues with:
+
<u>Technical note about automatic sort keys:</u> The algorithm in this template is not designed to cover every possible grammatical situation (to avoid creating unmaintainable {{wp|Kudzu in the United States|kudzu}}). Unusual cases should be spot checked on category pages once they have updated, and if sorting is incorrect, just use '''{{c|nocat{{=}}true}}''' and manually add a [[mw:Help:Magic words#Technical metadata|DEFAULTSORT]] and the additional categories. In particular, there are known issues with:
 
* Map names beginning with '''{{c|A}}''', '''{{c|An}}''', '''{{c|The}}''', or similar words in other languages.
 
* Map names beginning with '''{{c|A}}''', '''{{c|An}}''', '''{{c|The}}''', or similar words in other languages.
 
* Map names containing colons, where the mod is a single map not inhabiting MAP01 (e.g. [[Jägermörder 2: Terra Nova]]).
 
* Map names containing colons, where the mod is a single map not inhabiting MAP01 (e.g. [[Jägermörder 2: Terra Nova]]).

Latest revision as of 22:02, 13 March 2018

This level occupies the map slot {{{SLOT}}}. For other maps which occupy this slot, see [[:Category:{{{SLOT}}}]].


Usage[edit]

{{map}} categorizes a map by its number, and outputs a disambiguation notice linking to that category. This should be placed at the top of every map article (see also Template:Map skel).

Required parameter:

  • slot= is the level number in the Doom engine's usual format, e.g. E2M1 or MAP05.

Optional parameters:

  • nocat=true suppresses categorization; use for single-map mods.
  • nocat=noname invokes the subcategory for levels without individual titles (e.g. Galaxia). Ignored if the name parameter is used. This parameter may create strange results if the page title is not in the standard form SLOT (Mod Name).
  • name= overrides automatic detection of the title, for example to ignore a leading "The" or "A".

Technical note about automatic sort keys: The algorithm in this template is not designed to cover every possible grammatical situation (to avoid creating unmaintainable kudzu). Unusual cases should be spot checked on category pages once they have updated, and if sorting is incorrect, just use nocat=true and manually add a DEFAULTSORT and the additional categories. In particular, there are known issues with: