Template:Location/Documentation: Difference between revisions

Revision as of 13:47, 18 January 2024

Template:Location is used to create the summary sidebar on Location pages.

These are mandatory parameters, but they have default values.

name defaults to {{PAGENAME}}. It's primary purpose is applying formatting characters, as in Fräulein Ärtzin.

These mandatory parameters must be supplied; they have no defaults:

color (default: cyan) controls the color of the background. The valid options are:

red

green

blue

yellow

purple

cyan

gray

white

These optional parameters control aspects that are out-of-character and control Mediawiki behavior.

sortkey (default: {{PAGETITLE}}) — This usually suffices for most article, but it can be overriden if needed.

An example of the possible output is to the right; edit the documentation to see how it is constructed.

@@ Line 13: / Line 13: @@
 ===Metaparameters===
-These {{Parameter|optional}}s control aspects that are out-of-character.
+These {{Parameter|optional}}s control aspects that are out-of-character and control Mediawiki behavior.
-* {{Code|sortkey}} (default: the last word in {{Code|<nowiki>{{PAGETITLE}}</nowiki>}}) &mdash; This usually suffices for characters using the standard English name order (Given Middle Family), characters with names presented in the Japanese pattern (Family Given) will need to specify the sort key explicitly.
+* {{Code|sortkey}} (default: {{Code|<nowiki>{{PAGETITLE}}</nowiki>}}) &mdash; This usually suffices for most article, but it can be overriden if needed.
 ==Returns==
 An example of the possible output is to the right; <span class="plainlinks">[{{fullurl:Template:{{PAGENAME}}/Documentation|action=edit}} edit the documentation]</span> to see how it is constructed.