Template:See guide/doc: Difference between revisions
Jump to navigation
Jump to search
KickahaOta (talk | contribs) (Flagged required parameters) |
KickahaOta (talk | contribs) (Updated documentation) |
||
Line 7: | Line 7: | ||
"params": | "params": | ||
{ | { | ||
"article": { | |||
"label": "Guide to be linked to", | |||
"aliases": [ "page", "1" ] , | |||
"description": "The name of the article to be linked to. You can include an explicit namespace. If you don't, the link will be to Guide:(article) if that page exists, or to the main namespace (article) otherwise.", | |||
"type": "wiki-page-name", | |||
"example": "Guide: Managing the Atlas", | |||
"required": true | |||
}, | |||
"description": { | "description": { | ||
"label": "Description", | "label": "Description", | ||
Line 18: | Line 26: | ||
"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" | ||
} | } | ||
} | } | ||
Line 34: | Line 33: | ||
==Examples== | ==Examples== | ||
{{tlx|See guide|Managing the Atlas}} | |||
{{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:|topic=managing the Atlas|article=Guide:Managing the Atlas</nowiki>}} | ||
{{tlx|See guide|<nowiki>topic=managing the Atlas|article= | {{tlx|See guide|<nowiki>topic=managing the Atlas|article=:Managing the Atlas</nowiki>}} | ||
{{Documentation categories| | {{Documentation categories| |
Latest revision as of 20:49, 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 | |
---|---|---|---|---|
Guide to be linked to | article page 1 | The name of the article to be linked to. You can include an explicit namespace. If you don't, the link will be to Guide:(article) if that page exists, or to the main namespace (article) otherwise.
| Page name | required |
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 | optional |
Examples
{{See guide|Managing the Atlas}}
{{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=:Managing the Atlas}}