Difference between revisions of "Template:Further/doc"
imported>Mathglot (→Interwiki links: Match caption order to example.) |
|||
| (26 intermediate revisions by 16 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{Selfref|"Template:See" redirects here. Not to be confused with [[Template:See also]].}} |
| − | {{ | + | {{Documentation subpage}} |
| + | {{High-use|40054}} | ||
| + | {{Lua|Module:Labelled list hatnote}} | ||
This template is used to link to articles containing further information on a topic. It looks like this: | This template is used to link to articles containing further information on a topic. It looks like this: | ||
| Line 6: | Line 8: | ||
{{further|Article}} | {{further|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 [[WP:SUMMARY|summary style]]. | + | 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]]. The corresponding template for use on category pages is {{tl|Cat more}} |
== Usage == | == Usage == | ||
| − | ; | + | ; One article: |
| − | + | :{{tlx|further|PAGE1}} → {{further|PAGE1}} | |
| − | + | ; More than one article: | |
| + | :{{tlx|further|PAGE1|PAGE2|PAGE3}} → {{further|PAGE1|PAGE2|PAGE3}} | ||
| + | ; With a topic: | ||
| + | :{{tlx|further|<nowiki>topic=TOPIC</nowiki>|PAGE1|PAGE2}} → {{further|topic=TOPIC|PAGE1|PAGE2}} | ||
; All parameters: | ; All parameters: | ||
| − | + | :{{tlx|further|<nowiki>topic=TOPIC</nowiki>|PAGE1|PAGE2#SECTION|<nowiki>selfref=yes</nowiki>|<nowiki>category=no</nowiki>|label1 = LABEL1}} → {{further|topic=TOPIC|PAGE1|PAGE2#SECTION|selfref=yes|category=no|label1 = LABEL1}} | |
== Parameters == | == Parameters == | ||
| Line 20: | Line 25: | ||
This template accepts the following 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>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>label1</code>, <code>label2</code>, <code>label3</code> ... alternative output labels for the corresponding linked pages. Aliases "<code>label ''N''</code>" (with a space) and "<code>l''N''</code>" (short) are also available. | ||
| + | * <code>topic</code> - the name of the topic | ||
* <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: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. | * <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. | ||
| − | == | + | == Interwiki links == |
| + | |||
| + | To link to articles on foreign language Wikipedias, use [[H:IL|interwiki links]], prefixing the page name in the foreign Wikipedia with the required interwiki language code: | ||
| + | |||
| + | ; Basic interwiki links to articles in Spanish and German: | ||
| + | :{{tlx|further|es:PÁGINA1|de:SEITE2}} → {{further|es:PÁGINA1|de:SEITE2}} | ||
| + | |||
| + | ; Multiple interwiki links with language names: | ||
| + | Note that you can use the ''TOPIC'' and ''LABEL'' parameters in combination to produce this effect: | ||
| + | : {{tlx|Further|topic{{=}}Eero Heinonen, in|de:Eero Heinonen|es:Eero Heinonen|fi:Eero Heinonen|l1{{=}}German|l2{{=}}Spanish|l3{{=}}Finnish}} → {{Further|topic=Eero Heinonen, in|de:Eero Heinonen|es:Eero Heinonen|fi:Eero Heinonen|l1=German|l2=Spanish|l3=Finnish}} | ||
| − | + | Template {{tl|Further ill}} can produce similar links, but in a format more like that of {{tl|interlanguage link}}. | |
| − | |||
== Errors == | == Errors == | ||
| Line 44: | Line 59: | ||
== See also == | == See also == | ||
| + | * {{tl|Further2}} | ||
| + | * {{tl|Excerpt}}, which allows transclusion of text (such as an intro section) from one article into another | ||
| + | * {{Tl|Broader}} | ||
* {{Tl|Main article}} | * {{Tl|Main article}} | ||
{{Hatnote templates}} | {{Hatnote templates}} | ||
| − | {{Collapse top|TemplateData}} | + | {{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} |
| − | {{ | + | {{TemplateData header|noheader=1}} |
<templatedata> | <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": "wiki-page-name", | |
| − | + | "required": true | |
| − | + | }, | |
| − | + | "2": { | |
| − | + | "label": "Page 2", | |
| − | + | "description": "The name of the second page that you want to link to.", | |
| − | + | "type": "wiki-page-name", | |
| − | + | "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": "wiki-page-name", | |
| − | + | "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." | |
| − | + | }, | |
| − | + | "label1": { | |
| + | "aliases": [ | ||
| + | "label 1", | ||
| + | "l1" | ||
| + | ], | ||
| + | "label": "Label 1", | ||
| + | "description": "The displayed label of the first page link", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "label2": { | ||
| + | "aliases": [ | ||
| + | "label 2", | ||
| + | "l2" | ||
| + | ], | ||
| + | "label": "Label 2", | ||
| + | "description": "The displayed label of the second page link", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "label3": { | ||
| + | "aliases": [ | ||
| + | "label 3", | ||
| + | "l3" | ||
| + | ], | ||
| + | "label": "Label 3", | ||
| + | "description": "The displayed label for the third page link. Labels for further pages can be added using the parameters \"label4\", \"label5\", \"label6\", etc.", | ||
| + | "type": "string" | ||
| + | } | ||
| + | } | ||
} | } | ||
</templatedata> | </templatedata> | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other|| |
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- 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]] | ||
| + | [[Category:Cross-reference templates]] | ||
| + | [[Category:Exclude in print]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 23:58, 29 December 2020
| 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 is used on approximately 47,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
| This template uses Lua: |
This template is used to link to articles containing further information on a topic. It looks like this:
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. The corresponding template for use on category pages is {{Cat more}}
Usage
- One article
{{further|PAGE1}}→- More than one article
{{further|PAGE1|PAGE2|PAGE3}}→- With a topic
{{further|topic=TOPIC|PAGE1|PAGE2}}→- All parameters
{{further|topic=TOPIC|PAGE1|PAGE2#SECTION|selfref=yes|category=no}}→
Parameters
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.label1,label2,label3... alternative output labels for the corresponding linked pages. Aliases "label N" (with a space) and "lN" (short) are also available.topic- the name of the topicselfref- 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.
Interwiki links
To link to articles on foreign language Wikipedias, use interwiki links, prefixing the page name in the foreign Wikipedia with the required interwiki language code:
- Basic interwiki links to articles in Spanish and German
{{further|es:PÁGINA1|de:SEITE2}}→
- Multiple interwiki links with language names
Note that you can use the TOPIC and LABEL parameters in combination to produce this effect:
{{Further|topic=Eero Heinonen, in|de:Eero Heinonen|es:Eero Heinonen|fi:Eero Heinonen|l1=German|l2=Spanish|l3=Finnish}}→
Template {{Further ill}} can produce similar links, but in a format more like that of {{interlanguage link}}.
Errors
If no page names are supplied, the template will output the following message:
- Error: no page names specified (help).
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
- {{Further2}}
- {{Excerpt}}, which allows transclusion of text (such as an intro section) from one article into another
- {{Broader}}
- {{Main article}}
TemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See the monthly parameter usage report for this template.
TemplateData for 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".
| |||||||||||||||||||||||||||||||||||||||||||||