Template:See guide/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
(Created template documentation)
 
(Flagged required parameters)
Line 16: Line 16:
         "topic": {
         "topic": {
             "label": "Topic",
             "label": "Topic",
             "description": "A human-readable name of the topic being discussed. Only used if ''description'' is not present.",
             "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>


==Usage==
==Examples==
{{tlx|See guide|<nowiki>page=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>}}
 
 
===Examples===
 
{{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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Descriptiondescription explanation

If present, this text is displayed before the link to the guide.

Example
For a guide discussing how to manage the Atlas, see:
Stringoptional
Topictopic

A human-readable name of the topic being discussed.

Example
managing the Atlas
Stringrequired
Guide to be linked toarticle page

The name of the article to be linked to. Include the namespace like 'Guide:' if the article is not in the main namespace.

Example
Guide: Managing the Atlas
Page namerequired

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}}