Template:Transclude lead excerpt/sandbox Source: en.wikipedia.org/wiki/Template:Transclude_lead_excerpt/sandbox
 | This is the template sandbox page for Template:Transclude lead excerpt (diff). See also the companion subpage for test cases. |
 | This template is used on approximately 3,600 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. |
 | This template uses Lua: |
Transclude lead excerpt transcludes the lead of an article as an excerpt. It is designed for use in portals, stand-alone lists and outlines. It returns the text of the named 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
It is also used to share the lead section between the pages of a multi-page glossary.
Usage
[edit]{{Transclude lead excerpt | 1= | paragraphs= | files= | fileargs= | errors= }}
Parameters
[edit]The template requires one parameter: the name of the page to be transcluded. Include a namespace where necessary. There are no other positional parameters, but there are some optional named parameters:
- A list of paragraphs such as
paragraphs=1,3-5; the default is all paragraphs. - A list of file (image) numbers such as
files=1; the default is no images. Non-free images are removed. - Arguments to pass to File: such as
fileargs=leftto move images to the left; the default is none. errors=to allow Lua error messages to appear in the output
paragraphs= and files= each accept a comma-separated list containing numbers and/or number ranges in the format min-max. Alternatively, files= can accept the name of a single image, e.g. files=My image file.jpg.
Miscellaneous options
[edit]|more=no– to suppress link to the article at the end of the excerpt.|more=custom textto customize the link text at the end of the excerpt. Default is "Full article...".keepSubsections=1will cause Article#Section to retain any subsections of that sectionkeepRefs=1will keep references for display in a {{reflist}} or similarnobold=1will cause bold text to be displayed in normal font
Page options
[edit]Each page to be transcluded may be specified either plain or as a wikilink, possibly piped. Links to sections also work, and extract the named section rather than the lead. Examples: Article; Article#Section; [[Article]]; [[Article#Section|A section of an article]]. (Any piped text will be ignored.)
Any of the above formats may be followed by option(s) separated by pipes, e.g. Article|paragraphs=2. Such options override any global options for the given page only. Note that the characters | and = have special meaning within calls to templates but can be escaped using {{!}} and {{=}} respectively. Examples: Article#Section{{!}}files{{=}}2; [[Article|Some page]]{{!}}files{{=}}3,4{{!}}more{{=}}Click here. (= need not be escaped if the parameter is explicitly numbered, e.g. 1=Article{{!}}files=2).
Special characters such as pipes within page options must be doubly escaped, replacing their double braces by {{((}} and {{))}}. For example, to set display Custom image.jpg on the left with a custom caption, set fileargs to left|Custom caption using Article{{!}}files{{=}}Custom image.jpg{{!}}fileargs{{=}}left{{((}}!{{))}}Custom caption. To add a wikilink within a caption, escape the link brackets and any pipe twice using {{!((}}, {{))!}} and possibly {{!}}, e.g. Caption with {{((}}!(({{))}}Pipe (computer science){{((}}!{{))}}piped{{((}}))!{{))}} link. This text can be achieved more simply using {{Doubly escaped wikilink}}, e.g. Caption with {{Doubly escaped wikilink|Pipe (computer science)|piped}} link.
See also
[edit]Similar templates also using Module:Excerpt:
- {{Transclude linked excerpt}}: chooses the article randomly from those linked from a page
- {{Transclude list item excerpt}}: chooses the article randomly from those listed on a page
- {{Transclude random excerpt}}: chooses the article randomly from a list
- {{Transclude selected excerpt}}: chooses the article from a list using an index such as the week number
The templates were discussed at Use of direct transclusion in portals and the newer portal transclusion templates.
- {{Excerpt}}: template designed for excerpt transclusion in articles
TemplateData
[edit]TemplateData for Transclude lead excerpt
Transclude lead excerpt transcludes the lead of an article as an excerpt
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | The name of the page to be transcluded
| String | required |
| Paragraphs | paragraphs | Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max
| String | optional |
| Files | files | Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max
| String | optional |
| FileArgs | fileargs | Arguments to pass to File:
| String | optional |
| More | more | Text for trailing link to the entire article. Note: more= with no value produces the standard text: Read more...
| String | optional |
| Errors | errors | Allow Lua error messages to appear in the output?
| Boolean | optional |