imported>Deadfire: Template Doc Creation

2023-08-12T21:02:17Z

Template Doc Creation

New page

{{Documentation subpage}}
{{Lua|Module:Excerpt/portals}}
'''Transclude selected excerpt''' transcludes the lead of an article as an excerpt. It is designed for use in [[WP:portal|portal]]s. It returns the text of an article up to but excluding the first header, after removing:
*initial templates such as infoboxes, hatnotes and article improvement tags
*noinclude sections
*references and footnotes
*images, unless specifically retained

===Usage===
<pre style="overflow:auto">{{Transclude selected excerpt | 1= | 2= | selected= | paragraphs= | files= | fileargs= | more= | errors= }}</pre>

=== Parameters ===
The template accepts any number of page names as unnamed parameters. One of them is selected using the <code>selected=</code> parameter, and the page with that title is transcluded. (If the selected page is invalid, the template will choose again.) Include a namespace where necessary. There are no other positional parameters, but there is one mandatory named parameter:
*An integer representing the parameter number of the selected article, such as <code>selected=3</code>. Ideally the integer will range from 1 to the number of articles named, but the number will be normalised into that range if necessary. {{tl|Date and time templates}} or [[mw:Help:Extension:ParserFunctions##time|time parser functions]] may be useful, for example <code>selected={<nowiki/>{#time:n}}</code> to use the month number (1–12).
There are some optional named parameters:
*A list of paragraphs such as <code>paragraphs=1,3-5</code>; the default is all paragraphs.
*A list of file (image) numbers such as <code>files=1</code>; the default is no images. Non-free images are removed.
*Arguments to pass to File: such as <code>fileargs=left</code> to move images to the left; the default is none.
*<code>errors=</code> to allow Lua error messages to appear in the output
*<code>showall=</code> to show all articles simultaneously
*<code>list=</code> to show a list of articles <small>{{warnsign| coding not compatible with mobile versions of Wikipedia causing display and accessibility problems}}</small>
<code>paragraphs=</code> and <code>files=</code> each accept a comma-separated list containing numbers and/or number ranges in the format min-max. Alternatively, <code>files=</code> can accept the name of a single image, e.g. <code>files=My image file.jpg</code>.

<code>showall=</code> shows all articles simultaneously. This option is intended for a subpage aimed at editors as well as readers. Using this template on a subpage with <code><nowiki><noinclude>|showall=</noinclude></nowiki></code> and transcluding the subpage on a main page will show all excerpts on the subpage but only one on the main page, without repeating the template and its arguments.

As an alternative, the article names can be given as named parameters. In this case, there will be no unnamed parameters. The desired article is selected using its parameter name. For example, <code>|selected={<nowiki/>{#time:Md}}|Jan01=New Year's Day|Jan02=1971 Ibrox disaster|Jan03=...</code> could display an appropriate anniversary, without having to calculate how many days have elapsed in a (possibly leap) year. (#time:Md evaluates to a string representing the current date, e.g. "{{#time:Md}}".)
{{#section:Template:Transclude lead excerpt/doc|Miscellaneous options}}

===Page options===
{{#section-h:Template:Transclude lead excerpt/doc|Page options}}
===See also===
*{{tl|Transclude lead excerpt}}: specifies the article explicitly
*{{tl|Transclude linked excerpt}}: chooses the article randomly from those linked from a page
*{{tl|Transclude list item excerpt}}: chooses the article randomly from those listed on a page
*{{tl|Transclude random excerpt}}: chooses the article randomly from a list

{{Portal templates navbox}}

===TemplateData===
{{TemplateData header}}
<templatedata>
{
"description": "Transclude selected excerpt transcludes the lead of an article chosen from a list as an excerpt",
"params": {
"1": {
"label": "1",
"description": "The name of a page which may be transcluded",
"type": "string",
"required": false,
"example": "Aviation, 1=Aviation"
},
"2": {
"label": "2",
"description": "The name of another page which may be transcluded. Similarly for optional parameters 3, 4, ...",
"type": "string",
"required": false,
"example": "Egypt, 2=Egypt"
},
"selected": {
"label": "Selected",
"description": "Number of the article to be transcluded",
"type": "number",
"required": true,
"example": "selected=3",
"default": "random article"
},
"paragraphs": {
"label": "Paragraphs",
"description": "Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max",
"type": "string",
"required": false,
"example": "paragraphs=1,3-5",
"default": "all paragraphs"
},
"files": {
"label": "Files",
"description": "Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max",
"type": "string",
"required": false,
"example": "files=1,3-5",
"default": "no files"
},
"fileargs": {
"label": "FileArgs",
"description": "Arguments to pass to File:",
"type": "string",
"required": false,
"example": "fileargs=left",
"default": "no arguments"
},
"more": {
"label": "More",
"description": "Text for trailing link to the entire article. Note: more=no suppresses the link.",
"type": "string",
"required": false,
"example": "more=Read the full article",
"default": "no arguments"
},
"errors": {
"label": "Errors",
"description": "Allow Lua error messages to appear in the output?",
"type": "boolean",
"required": false,
"example": "errors=true",
"default": "false"
},
"showall": {
"label": "ShowAll",
"description": "Show all excerpts simultaneously?",
"type": "string",
"required": false,
"example": "showall={{clear}}{{hr}}",
"default": "no arguments"
},
"list": {
"label": "List",
"description": "Show a list of excerpts?",
"type": "string",
"required": false,
"example": "list=List of articles",
"default": "no list"
}
},
"format": "inline"
}
</templatedata>

<includeonly>{{sandbox other||
[[Category:Article shared content templates]]
}}</includeonly>

Template:Transclude selected excerpt/doc - Revision history

imported>Deadfire: Template Doc Creation