Template:Further/doc

From Ava Zinn Wiki
< Template:Further
Revision as of 11:17, 5 May 2014 by Mr. Stradivarius (talk) (Dummy edit - previous summary should have been "started updating the documentation in preparation for switching to Module:Further". (Made a mistake with my external editor.))
Jump to: navigation, search
Gnome-utilities-terminal.svg 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:

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.

Usage

Basic usage
{{details|article1|article2|article3|...}}
All parameters
{{detail|article1|article2|article3|...|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.
  • 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

Errors

If no page name is supplied, the template will output the following message:

If you see this error message, it is for one of three reasons:

  1. No parameters were specified (the template code was {{details}}). Please use {{details|page}} instead.
  2. Some parameters were specified, but the page name wasn't included. For example, the template text {{details|selfref=yes}} will produce this error. Please use (for example) {{details|page|selfref=yes}} instead.
  3. The 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 {{details|2+2=4}} will produce this error. To work around this, you can specify the parameter name explictly by using 1= before the page name, like this: {{details|1=2+2=4}}.

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.

Template:Other uses templates documentation