Difference between revisions of "Template:Infobox mapframe/doc/parameters/doc"
< Template:Infobox mapframe | doc | parameters
Jump to navigation
Jump to search
imported>DePiep |
imported>DePiep (+example) |
||
| Line 3: | Line 3: | ||
Parameter documentation for {{tl|Infobox mapframe}}, and infoboxes using [[Module:Infobox mapframe]] (<code>auto</code> function). | Parameter documentation for {{tl|Infobox mapframe}}, and infoboxes using [[Module:Infobox mapframe]] (<code>auto</code> function). | ||
== Usage == | == Usage == | ||
| + | In the ''documentation page'' of the target template (could be the infobox), add {{tlx|Infobox mapframe}}. | ||
| + | :Parameter options are: | ||
* Set {{para|noprefix|yes}} to show without the "mapframe-" prefix – for use on [[Template:Infobox mapframe/doc]]. | * Set {{para|noprefix|yes}} to show without the "mapframe-" prefix – for use on [[Template:Infobox mapframe/doc]]. | ||
* Set alternate default values by passing in parameters of the form ''parameter-name''=''value'' e.g. {{para|mapframe-marker|church}}. | * Set alternate default values by passing in parameters of the form ''parameter-name''=''value'' e.g. {{para|mapframe-marker|church}}. | ||
* Set {{para|deprecated|yes}} to show deprecated parameters | * Set {{para|deprecated|yes}} to show deprecated parameters | ||
| + | ;Example | ||
| + | :{{tl|Infobox museum/doc}} has: | ||
| + | <pre> | ||
| + | {{Infobox mapframe/doc/parameters | ||
| + | |mapframe-marker={{kbd|museum}} | ||
| + | }} | ||
| + | </pre> | ||
| + | :Corresponding with its template code: | ||
| + | <pre> | ||
| + | | image4 = {{#invoke:Infobox mapframe| ... |mapframe-marker=museum}} | ||
| + | </pre> | ||
| + | :Showing documentation text: | ||
| + | :{{xt|1='''mapframe-marker''' – Marker symbol to use for coordinates; see [...] for options. Default: museum}} | ||
== Parameters == | == Parameters == | ||
Revision as of 16:55, 29 November 2020
| This is a documentation subpage for Template:Infobox mapframe/doc/parameters. It contains usage information, categories and other content that is not part of the original template page. |
Parameter documentation for {{Infobox mapframe}}, and infoboxes using Module:Infobox mapframe (auto function).
Usage
In the documentation page of the target template (could be the infobox), add {{Infobox mapframe}}.
- Parameter options are:
- Set
|noprefix=yesto show without the "mapframe-" prefix – for use on Template:Infobox mapframe/doc. - Set alternate default values by passing in parameters of the form parameter-name=value e.g.
|mapframe-marker=church. - Set
|deprecated=yesto show deprecated parameters
- Example
- {{Infobox museum/doc}} has:
{{Infobox mapframe/doc/parameters
|mapframe-marker={{kbd|museum}}
}}
- Corresponding with its template code:
| image4 = {{#invoke:Infobox mapframe| ... |mapframe-marker=museum}}
- Showing documentation text:
- mapframe-marker – Marker symbol to use for coordinates; see [...] for options. Default: museum
Parameters
Parameter list
|
|---|
<!-- Infobox mapframe: all parameters, no aliases (29) --> <!-- Basic parameters: --> | mapframe = | mapframe-caption = | mapframe-custom = | qid = | mapframe-coordinates = | mapframe-wikidata = <!-- Customise features displayed: --> | mapframe-shape = | mapframe-point = | mapframe-line = | mapframe-geomask = | mapframe-switcher = <!-- Other optional parameters: --> | mapframe-frame-width = | mapframe-frame-height = | mapframe-shape-fill = | mapframe-shape-fill-opacity = | mapframe-stroke-color = | mapframe-stroke-width = | mapframe-marker = | mapframe-marker-color = | mapframe-geomask-stroke-color = | mapframe-geomask-stroke-width = | mapframe-geomask-fill = | mapframe-geomask-fill-opacity = | mapframe-zoom = | mapframe-length_km = | mapframe-length_mi = | mapframe-area_km2 = | mapframe-area_mi2 = | mapframe-frame-coordinates = <!-- Infobox mapframe: parameters, including aliases (40) --> <!-- Basic parameters: --> | mapframe = | mapframe-caption = | mapframe-custom = | id = | mapframe-id = | qid = | mapframe-coordinates = | mapframe-coord = | coordinates = | coord = | mapframe-wikidata = <!-- Customise features displayed: --> | mapframe-shape = | mapframe-point = | mapframe-line = | mapframe-geomask = | mapframe-switcher = <!-- Other optional parameters: --> | mapframe-frame-width = | mapframe-width = | mapframe-frame-height = | mapframe-height = | mapframe-shape-fill = | mapframe-shape-fill-opacity = | mapframe-stroke-color = | mapframe-stroke-colour = | mapframe-stroke-width = | mapframe-marker = | mapframe-marker-color = | mapframe-marker-colour = | mapframe-geomask-stroke-color = | mapframe-geomask-stroke-colour = | mapframe-geomask-stroke-width = | mapframe-geomask-fill = | mapframe-geomask-fill-opacity = | mapframe-zoom = | mapframe-length_km = | mapframe-length_mi = | mapframe-area_km2 = | mapframe-area_mi2 = | mapframe-frame-coordinates = | mapframe-frame-coord = |
Deprecated
Deprecated parameters
|
|---|
|