Template:Broader/doc: Difference between revisions

Usage: {{see|WP:SUMMARYHATNOTE}}
 
imported>Fgnievinski
 
(One intermediate revision by one other user not shown)
Line 21: Line 21:
* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>selfref</code> - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See [[Template:Selfref]] for more information.
* <code>selfref</code> - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See [[Template:Self ref]] for more information.
* <code>category</code> - if set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only has an effect if the first positional parameter (the page to link to) is omitted.
* <code>category</code> - if set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only has an effect if the first positional parameter (the page to link to) is omitted.


Line 45: Line 45:
== See also ==
== See also ==
*{{tl|Further}}
*{{tl|Further}}
*{{tl|Redirect}}


{{Hatnote templates}}
{{Hatnote templates}}
Line 51: Line 52:
<templatedata>
<templatedata>
{
{
  "description": "This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.",
"description": "This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.",
  "params": {
"params": {
    "1": {
"1": {
      "label": "Article",
"label": "Article",
      "description": "The name of the article that you want to link to",
"description": "The name of the article that you want to link to",
      "type": "string",
"type": "wiki-page-name",
      "required": true
"required": true
    },
},
    "2": {
"2": {
      "label": "Article 2",
"label": "Article 2",
      "description": "The name of an additional article that you want to link to",
"description": "The name of an additional article that you want to link to",
      "type": "string",
"type": "wiki-page-name",
      "required": false
"required": false
    },
},
    "3": {
"3": {
      "label": "Article 3",
"label": "Article 3",
      "description": "The name of an additional article that you want to link to",
"description": "The name of an additional article that you want to link to",
      "type": "string",
"type": "wiki-page-name",
      "required": false
"required": false
    },
},
    "4": {
"4": {
      "label": "Article 4",
"label": "Article 4",
      "description": "The name of an additional article that you want to link to",
"description": "The name of an additional article that you want to link to",
      "type": "string",
"type": "wiki-page-name",
      "required": false
"required": false
    },
},
    "topic": {
"topic": {
      "label": "Topic",
"label": "Topic",
      "description": "A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'",
"description": "A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'",
      "type": "string",
"type": "string",
      "required": false
"required": false
    },
},
    "selfref": {
"selfref": {
      "type": "string/line",
"type": "string/line",
      "label": "Self reference",
"label": "Self reference",
      "description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see [[WP:SAND]]\".)"
"description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see [[WP:SAND]]\".)"
    },
},
    "category": {
"category": {
      "label": "Category",
"label": "Category",
      "description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted."
"description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted."
    }
}
  }
}
}
}
</templatedata>
</templatedata>