Difference between revisions of "Template:Main list/doc"

From blackwiki
Jump to navigation Jump to search
test>Primefac
(TFD closed as no consensus (XFDcloser))
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
Line 1: Line 1:
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
{{Documentation subpage}}
This module produces a "For a more comprehensive list, see [...]" link. It implements the {{tl|main list}} template.
+
{{tsh|more}}
 +
{{lua|Module:Main list}}
  
== Use from wikitext ==
+
This template is used to make [[Wikipedia:Summary style|summary style]] explicit. It looks like this:
  
This module cannot be used directly from #invoke. Instead, it can only be used through the {{tl|main list}} template. Please see the template page for documentation.
+
{{Main list|Article}}
  
== Use from other Lua modules ==
+
It is used in sections for which there is also a separate more comprehensive list article on the subject.
  
Load the module:
+
== Usage ==
  
<source lang="lua">
+
; Basic usage:
local mMainList = require('Module:Main list')
+
{{tnull|Main list|''article''}}
</source>
 
  
You can then use the _mainList function like this:
+
; With a topic:
 +
{{tnull|Main list|''article 1''|''article 2''}}
  
<source lang="lua">
+
; All parameters:
mMainList._mainList (page1, page2)
+
{{tnull|Main list|''article 1''|''article 2''|4=category=''no''}}
</source>
 
  
The <var>page1</var> variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
+
== Parameters ==
  
The <var>page2</var> variable is optional; it is a second page link.
+
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>2</code> - a second page (optional). Same implications as the first parameter apply.
 +
* <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.
  
=== Example 1 ===
+
== Examples ==
<source lang="lua">
 
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates')
 
</source>
 
Produces:
 
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div></nowiki></code>
 
Displays as:
 
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div>
 
  
=== Example 2 ===
+
* {{tnull|Main list|Wikipedia:Hatnote#Hatnote templates }}<!--
<source lang="lua">
+
  --> → {{Main list|Wikipedia:Hatnote#Hatnote templates }}
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates','Wikipedia:Template messages/Cleanup#Cleanup')
+
* {{tnull|Main list|Wikipedia:Hatnote#Hatnote templates |Wikipedia:Template messages/Cleanup#Cleanup}}<!--
</source>
+
  --> → {{Main list|Wikipedia:Hatnote#Hatnote templates |Wikipedia:Template messages/Cleanup#Cleanup}}
Produces:
 
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div></nowiki></code>
 
Displays as:
 
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div>
 
  
== Technical details ==
+
== Errors ==
  
This module uses [[Module:Hatnote]] to format the hatnote text and [[Module:Arguments]] to fetch the arguments from wikitext.
+
If no page name is supplied, the template will output the following message:
 +
* {{Main list|category=no}}
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
If you see this error message, it is for one of three reasons:
<!-- Categories go here and interwikis go in Wikidata. -->
+
# No parameters were specified (the template code was {{tnull|Main list}}). Please use {{tnull|Main list|''page''}} instead.
[[Category:Hatnote modules]]
+
# 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 {{tnull|Main list|<nowiki>2+2=4</nowiki>}} will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code> before the page name, like this: {{tnull|Main list|<nowiki>1=2+2=4</nowiki>}}.
 +
# You tried to access [[Module:Main list]] directly by using {{tnull|&#35;invoke:Main list|mainList|''text''}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{tnull|Main list|''text''}} 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]].
 +
 
 +
== Alternative ==
 +
For cases where the present context provides no short list to which this template "a more comprehensive list" wording could refer, see the template {{tl|Main listing}}, which is just a pointer to the list article.
 +
 
 +
==TemplateData==
 +
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
 +
{{TemplateData header|noheader=1}}
 +
<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 1",
 +
"description": "The name of the article that you want 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\".",
 +
"type": "string",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Article 2",
 +
"description": "Name of the second article you want to link to (optional). 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\".",
 +
"type": "string",
 +
"required": false
 +
},
 +
"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.",
 +
"type": "boolean",
 +
"autovalue": ""
 +
}
 +
},
 +
"format": "block"
 +
}
 +
</templatedata>
 +
{{Collapse bottom}}
 +
 
 +
==See also==
 +
{{Hatnote templates}}
 +
 
 +
* {{tl|Summarize}} for use where details of one article need to be summed up in another
 +
* {{tl|Summarize section}} for use where part of an article contains too many details
 +
 
 +
<includeonly>{{Sandbox other||
 +
 
 +
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 +
[[Category:Cross-reference templates]]
 +
[[Category:Hatnote templates]]
 +
[[Category:Hatnote templates for lists]]
 +
[[Category:Wikipedia page-section templates]]
 +
 
 +
[[mk:Шаблон:Главен список]]
 +
[[tr:Şablon:Analiste]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 00:30, 26 April 2020

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

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

Usage

Basic usage
{{Main list|article}}
With a topic
{{Main list|article 1|article 2}}
All parameters
{{Main list|article 1|article 2|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 - a second page (optional). Same implications as the first parameter apply.
  • 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:

  • Error: no page name specified (help).

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

  1. No parameters were specified (the template code was {{Main list}}). Please use {{Main list|page}} instead.
  2. 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 {{Main list|2+2=4}} will produce this error. To work around this, you can specify the parameter name explicitly by using 1= before the page name, like this: {{Main list|1=2+2=4}}.
  3. You tried to access Module:Main list directly by using {{#invoke:Main list|mainList|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{Main list|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.

Alternative

For cases where the present context provides no short list to which this template "a more comprehensive list" wording could refer, see the template {{Main listing}}, which is just a pointer to the list article.

TemplateData

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Main list

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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Article 11

The name of the article that you want 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".

Stringrequired
Article 22

Name of the second article you want to link to (optional). 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".

Stringoptional
Categorycategory

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.

Auto value
Booleanoptional

See also

  • {{Summarize}} for use where details of one article need to be summed up in another
  • {{Summarize section}} for use where part of an article contains too many details