Template:See guide/doc: Difference between revisions
Jump to navigation
Jump to search
KickahaOta (talk | contribs) (Created template documentation) |
KickahaOta (talk | contribs) (Flagged required parameters) |
||
Line 16: | Line 16: | ||
"topic": { | "topic": { | ||
"label": "Topic", | "label": "Topic", | ||
"description": "A human-readable name of the topic being discussed | "description": "A human-readable name of the topic being discussed.", | ||
"type": "string", | "type": "string", | ||
"example": "managing the Atlas" | "example": "managing the Atlas", | ||
"required": true | |||
}, | }, | ||
"article": { | "article": { | ||
Line 25: | Line 26: | ||
"description": "The name of the article to be linked to. Include the namespace like 'Guide:' if the article is not in the main namespace.", | "description": "The name of the article to be linked to. Include the namespace like 'Guide:' if the article is not in the main namespace.", | ||
"type": "wiki-page-name", | "type": "wiki-page-name", | ||
"example": "Guide: Managing the Atlas" | "example": "Guide: Managing the Atlas", | ||
"required": true | |||
} | } | ||
} | } | ||
Line 31: | Line 33: | ||
</templatedata> | </templatedata> | ||
==Examples== | |||
{{tlx|See guide|<nowiki>description=For a guide discussing how to manage the Atlas, see:|topic=managing the Atlas|article=Guide:Managing the Atlas</nowiki>}} | |||
{{tlx|See guide|<nowiki>description=For a guide discussing how to manage the Atlas, see:|article=Guide:Managing the Atlas</nowiki>}} | |||
{{tlx|See guide|<nowiki>topic=managing the Atlas|article=Guide:Managing the Atlas</nowiki>}} | {{tlx|See guide|<nowiki>topic=managing the Atlas|article=Guide:Managing the Atlas</nowiki>}} |
Revision as of 19:20, 4 December 2021
This subpage provides documentation for Template:See guide.
Use this template to refer the reader to a guide on a topic.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Description | description explanation | If present, this text is displayed before the link to the guide.
| String | optional |
Topic | topic | A human-readable name of the topic being discussed.
| String | required |
Guide to be linked to | article page | The name of the article to be linked to. Include the namespace like 'Guide:' if the article is not in the main namespace.
| Page name | required |
Examples
{{See guide|description=For a guide discussing how to manage the Atlas, see:|topic=managing the Atlas|article=Guide:Managing the Atlas}}
{{See guide|topic=managing the Atlas|article=Guide:Managing the Atlas}}