Template:Details/doc View history

(Created initial doc)
 
m (fixed error)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{doc subpage}}
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
This template is used to make [[Wikipedia:Summary style|summary style]] explicit. It looks like this:
This template is used to make summary style explicit. It looks like this:


{{details|Article}}
{{details|Article}}
Line 21: Line 21:


This template accepts the following parameters:
This template accepts the following parameters:
* <code>1</code> - the page to link to (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> - the page to link to (required). Categories and files are automatically escaped with the [[Wikipedia:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
* <code>2</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>2</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.
<!-- {{Selfref}} not installed * <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. This only has an effect if the first positional parameter (the page to link to) is omitted.


== Examples ==
== Examples ==
Line 36: Line 36:
* {{details|category=no}}
* {{details|category=no}}


If you see this error message, it is for one of four reasons:
If you see this error message, it is for one of <!--four-->three reasons:
# No parameters were specified (the template code was <code><nowiki>{{details}}</nowiki></code>). Please use <code><nowiki>{{details|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
# No parameters were specified (the template code was <code><nowiki>{{details}}</nowiki></code>). Please use <code><nowiki>{{details|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
# Some parameters were specified, but the page name wasn't included. For example, the template text <code><nowiki>{{details|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{details|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> instead.
# Some parameters were specified, but the page name wasn't included. For example, the template text <code><nowiki>{{details|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{details|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> instead.
# 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 <code><nowiki>{{details|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the page name, like this: <code><nowiki>{{details|1=2+2=4}}</nowiki></code>.
# 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 <code><nowiki>{{details|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the page name, like this: <code><nowiki>{{details|1=2+2=4}}</nowiki></code>.
# You tried to access [[Module:Details]] directly by using <code><nowiki>{{#invoke:details|details|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{details|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
<!-- LUA is not installed at this time. # You tried to access [[Module:Details]] directly by using <code><nowiki>{{#invoke:details|details|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{details|</nowiki>''text''<nowiki>}}</nowiki></code> instead. -->
 
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
 
{{Hatnote templates documentation}}
{{Collapse top|TemplateData}}
{{TemplateDataHeader}}
{{Pre2|
<templatedata>
{
  "description": "This template is used to show readers where to find more details about a particular topic. It is usually placed at the top of a section or article.",
  "params": {
    "1": {
      "label": "Article",
      "description": "The name of the article that you want to link to",
      "type": "string",
      "required": true
    },
    "2": {
      "label": "Topic",
      "description": "A brief description of the topic for which more details will be provided. If left blank, the template will read 'For more information on this topic...'",
      "type": "string",
      "required": false
    },
    "selfref": {
      "type": "string/line",
      "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]]\".)"
    },
    "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."
    }
  }
}
</templatedata>
}}


{{Collapse bottom}}
== Other hatnote templates ==
{{Hatnote templates}}


<includeonly>
<includeonly>
Line 86: Line 51:
[[Category:Hatnote templates]]
[[Category:Hatnote templates]]


}}</includeonly>
</includeonly>

Latest revision as of 01:04, 21 May 2017

This is a documentation subpage for Template:Details.
It contains usage information, categories and other content that is not part of the original template page.

This template is used to make summary style explicit. It looks like this:

For more details on this topic, see Article.

It is used in sections for which there is also a separate article on the subject.

Usage

Basic usage
{{details|article}}
With a topic
{{details|article|topic}}
All parameters
{{details|article|topic|selfref=yes|category=no}}

Parameters

This template accepts the following parameters:

  • 1 - the page to link to (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.
  • 2 - the name of the topic. If this is not specified, the text "this topic" is used.
  • category - if set to "no", "n", "false", or "0", suppresses the error tracking category. This only has an effect if the first positional parameter (the page to link to) is omitted.

Examples

  • {{details|Article}}
For more details on this topic, see Article.
  • {{details|Article|some topic}}
For more details on some topic, see Article.

Errors

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

For more details on this topic, see [[{{{1}}}]].

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

Other hatnote templates

The following templates are considered part of the Hatnote template family, used typically at the top of a page, but can be used as needed.

  • {{about}}: To differentiate this page from other similar topics or the disambiguation page of the same base page name.
  • {{details}}: A derivative of {{for}} that forces the opening sentence to be displayed as "For more details..."
  • {{for}}: Enables any description to be given for the reason to want to link to up to four other pages.
  • {{further}}: Mainly for linking to more detailed articles and pages typically places before the shortened description, but could be placed after if necessary.
  • {{hatnote}}: This is the core of the other templates. It simply places text on the page in italics with a paragraph indent.
  • {{See also}} (not yet copied from Wikipedia): It can be created manually with {{hatnote}}.