Difference between revisions of "Template:Further/doc"
From Ava Zinn Wiki
| [unchecked revision] | [unchecked revision] |
Aeverinezinn (talk | contribs) m (19 revisions from wikipedia:Template:Further/doc) |
|||
| (12 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{documentation subpage}} | |
| − | + | {{lua|Module:Further}} | |
| − | + | This template is used to link to articles containing further information on a topic. It looks like this: | |
| − | |||
| − | {{ | + | {{further|Article}} |
| − | <includeonly> | + | It is typically used at the top of a section, when the topic of that section is covered in more detail by another page. It is useful for implementing [[WP:SUMMARY|summary style]]. |
| − | <!-- | + | |
| + | == Usage == | ||
| + | |||
| + | ; Basic usage: | ||
| + | {{further|''page1''|''page2''|''page3''|...}} | ||
| + | |||
| + | ; All parameters: | ||
| + | {{further|''page1''|''page2''|''page3''|...|selfref=''yes''|category=''no''}} | ||
| + | |||
| + | == Parameters == | ||
| + | |||
| + | This template accepts the following parameters: | ||
| + | * <code>1</code>, <code>2</code>, <code>3</code>, ... - the pages to link to. At least one page name is required. Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. | ||
| + | * <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>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. | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | * <code><nowiki>{{further|Article}}</nowiki></code> → {{further|Article}} | ||
| + | * <code><nowiki>{{further|Article1|Article2|Article3}}</nowiki></code> → {{further|Article1|Article2|Article3}} | ||
| + | |||
| + | == Errors == | ||
| + | |||
| + | If no page names are supplied, the template will output the following message: | ||
| + | * {{further|category=no}} | ||
| + | |||
| + | If you see this error message, it is for one of four reasons: | ||
| + | # No parameters were specified (the template code was <code><nowiki>{{further}}</nowiki></code>). Please use <code><nowiki>{{further|</nowiki>''page''<nowiki>}}</nowiki></code> instead. | ||
| + | # Some parameters were specified, but no page names were included. For example, the template text <code><nowiki>{{further|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{further|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> instead. | ||
| + | # A page name was specified, but it contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code <code><nowiki>{{further|1+1=2|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code>, <code>2</code>, etc., before the page name, like this: <code><nowiki>{{further|1=1+1=2|2=2+2=4}}</nowiki></code>. | ||
| + | # You tried to access [[Module:Further]] directly by using <code><nowiki>{{#invoke:further|further|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{further|</nowiki>''text''<nowiki>}}</nowiki></code> instead. | ||
| + | |||
| + | If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk]], and someone should be able to help you. | ||
| + | |||
| + | Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]]. | ||
| + | |||
| + | == See also == | ||
| + | * {{Tl|Main article}} | ||
| + | |||
| + | {{Hatnote templates}} | ||
| + | {{Collapse top|TemplateData}} | ||
| + | {{TemplateDataHeader}} | ||
| + | <templatedata> | ||
| + | { | ||
| + | "description": "Template used to link to pages containing further information on a topic. Produces the output \"Further information: page 1, page 2 and page 3\".", | ||
| + | "params": { | ||
| + | "1": { | ||
| + | "label": "Page 1", | ||
| + | "description": "The name of the first page that you want to link to.", | ||
| + | "type": "string", | ||
| + | "required": true | ||
| + | }, | ||
| + | "2": { | ||
| + | "label": "Page 2", | ||
| + | "description": "The name of the second page that you want to link to.", | ||
| + | "type": "string", | ||
| + | "required": false | ||
| + | }, | ||
| + | "3": { | ||
| + | "label": "Page 3", | ||
| + | "description": "The name of the third page that you want to link to. More pages can be added using the parameters \"4\", \"5\", \"6\", etc.", | ||
| + | "type": "string", | ||
| + | "required": false | ||
| + | }, | ||
| + | "selfref": { | ||
| + | "type": "string/line", | ||
| + | "label": "Self reference", | ||
| + | "description": "Set to \"yes\" if the template is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site." | ||
| + | }, | ||
| + | "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 no page names are specified." | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </templatedata> | ||
| + | {{Collapse bottom}} | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
| + | <!-- Categories go here and interwikis go in Wikidata. --> | ||
[[Category:Wikipedia page-section templates|{{PAGENAME}}]] | [[Category:Wikipedia page-section templates|{{PAGENAME}}]] | ||
[[Category:Hatnote templates]] | [[Category:Hatnote templates]] | ||
| − | + | }}</includeonly> | |
| − | |||
| − | |||
| − | |||
| − | </includeonly> | ||
Latest revision as of 13:21, 2 March 2016
 |
This is a documentation subpage for Template:Further. It contains usage information, categories and other content that is not part of the original template page. |
|
This template uses (or will be using) Lua programming language.
Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
This template is used to link to articles containing further information on a topic. It looks like this:
Further information: Article
It is typically used at the top of a section, when the topic of that section is covered in more detail by another page. It is useful for implementing summary style.
Contents
Usage[edit]
- Basic usage
{{further|page1|page2|page3|...}}
- All parameters
{{further|page1|page2|page3|...|selfref=yes|category=no}}
Parameters[edit]
This template accepts the following parameters:
-
1,2,3, ... - the pages to link to. At least one page name is required. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section. -
selfref- 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. -
category- 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.
Examples[edit]
-
{{further|Article}}→Further information: Article -
{{further|Article1|Article2|Article3}}→
Errors[edit]
If no page names are supplied, the template will output the following message:
- Further information: [[{{{1}}}]]
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{further}}). Please use{{further|page}}instead. - Some parameters were specified, but no page names were included. For example, the template text
{{further|selfref=yes}}will produce this error. Please use (for example){{further|page|selfref=yes}}instead. - A page name was specified, but it contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{further|1+1=2|2+2=4}}will produce this error. To work around this, you can specify the parameter name explicitly by using1=,2, etc., before the page name, like this:{{further|1=1+1=2|2=2+2=4}}. - You tried to access Module:Further directly by using
{{#invoke:further|further|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{further|text}}instead.
If you see this error message and are unsure of what to do, please post a message on the help desk, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
See also[edit]
- {{Main article}}
| TemplateData | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Further Template used to link to pages containing further information on a topic. Produces the output "Further information: page 1, page 2 and page 3".
| ||||||||||||||||||||||||||||||
