Template:Marker/doc: Difference between revisions
From The Fifth City Wiki
Create documentation |
Add flair parameter documentation, fix supposedly-mandatory images and headers. |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Usage == | == Usage == | ||
See [[Template:Map|Map]] for usage details. | See [[Template:Map|Map]] for usage details. Tooltips will not show up on hover unless there is text in the tooltip. | ||
== Properties == | == Properties == | ||
{|class = "wikitable" width = "100%"| | {|class = "wikitable" width = "100%"| | ||
!Parameter name | !Parameter name | ||
! | !Mandatory? | ||
!Description | !Description | ||
!Example value | !Example value | ||
|- | |- | ||
|name | |name | ||
| | |X | ||
|Text that appears inside the marker, as a label. This is different from the text that appears when hovering over the marker, which would be wikitext placed between the {{((}}Marker{{))}} and {{((}}MarkerEnd{{))}} templates. | |Text that appears inside the marker, as a label. This is different from the text that appears when hovering over the marker, which would be wikitext placed between the {{((}}Marker{{))}} and {{((}}MarkerEnd{{))}} templates. | ||
|Flute Street | |Flute Street | ||
|- | |- | ||
|link | |link | ||
| | | | ||
|A wiki page that clicking on the marker links to. | |A wiki page that clicking on the marker links to. Defaults to <code>name</code>. To remove a link, just set this parameter as empty. | ||
|Jack-of-Smiles | |Jack-of-Smiles | ||
|- | |||
|flair | |||
| | |||
|Values: {<code>fallenlondon</code>, <code></code>}.<br>Default: <code>fallenlondon</code>.<br> | |||
With <code>fallenlondon</code>, add a flair to the top and bottom of the marker, as shown in-game. Otherwise, just have the marker itself. | |||
|- | |||
|image | |||
| | |||
|A portrait thumbnail in the tooltip, aligned to the right. | |||
|Snowflake.png | |||
|- | |||
|header | |||
| | |||
|A landscape header image in the tooltip, which takes up the full width. | |||
|Wolfstack.png | |||
|- | |- | ||
|x | |x | ||
| | |X | ||
|The horizontal position of the marker, as a percentage where 0% represents the left side of the map and 100% represents the right side. | |The horizontal position of the marker, as a percentage where 0% represents the left side of the map and 100% represents the right side. | ||
|72.1 | |72.1 | ||
|- | |- | ||
|y | |y | ||
| | |X | ||
|The vertical position of the marker, as a percentage where 0% represents the top side of the map and 100% represents the bottom side. | |The vertical position of the marker, as a percentage where 0% represents the top side of the map and 100% represents the bottom side. | ||
|21.8 | |21.8 | ||
|- | |- | ||
|scale | |scale | ||
| | | | ||
|Adjusts the scale of the marker. Defaults to 0.75x size (0. | |Adjusts the scale of the marker. Defaults to 0.75x size (0.5 ~ 1 is usually a good range). | ||
|0.5 | |0.5 | ||
|- | |- | ||
| | |{{((}}1{{))}} | ||
| | | | ||
| | |(First unnamed parameter) Wikitext to be shown inside the tooltip. If you want to add an image, consider the <code>image</code> or <code>header</code> parameters instead. | ||
| | |<nowiki>Just get 3200 scraps and trade them with the [[Relickers|Shivering Relicker]]. You could do this multiple times before any other source was available.</nowiki> | ||
|} | |} | ||
Latest revision as of 08:01, 17 July 2025
Usage[edit]
See Map for usage details. Tooltips will not show up on hover unless there is text in the tooltip.
Properties[edit]
| Parameter name | Mandatory? | Description | Example value |
|---|---|---|---|
| name | X | Text that appears inside the marker, as a label. This is different from the text that appears when hovering over the marker, which would be wikitext placed between the {{Marker}} and {{MarkerEnd}} templates. | Flute Street |
| link | A wiki page that clicking on the marker links to. Defaults to name. To remove a link, just set this parameter as empty.
|
Jack-of-Smiles | |
| flair | Values: {fallenlondon, Default: fallenlondon.With | ||
| image | A portrait thumbnail in the tooltip, aligned to the right. | Snowflake.png | |
| header | A landscape header image in the tooltip, which takes up the full width. | Wolfstack.png | |
| x | X | The horizontal position of the marker, as a percentage where 0% represents the left side of the map and 100% represents the right side. | 72.1 |
| y | X | The vertical position of the marker, as a percentage where 0% represents the top side of the map and 100% represents the bottom side. | 21.8 |
| scale | Adjusts the scale of the marker. Defaults to 0.75x size (0.5 ~ 1 is usually a good range). | 0.5 | |
| {{1}} | (First unnamed parameter) Wikitext to be shown inside the tooltip. If you want to add an image, consider the image or header parameters instead.
|
Just get 3200 scraps and trade them with the [[Relickers|Shivering Relicker]]. You could do this multiple times before any other source was available. |
