Open main menu
Template documentation[view] [edit] [history] [purge]

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

Usage

{{Transclude lead excerpt | 1= | paragraphs= | files= | fileargs= | more= | errors= }}

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=left to move images to the left; the default is none.
  • A link to the article itself such as more=(more); the default is no link. Short cut: more= produces Read more...
  • 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.

Page options

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). The rare case of a pipe within page options must be doubly escaped. 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.

See also

Similar templates also using Module:Excerpt:

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Transclude lead excerpt

Transclude lead excerpt transcludes the lead of an article as an excerpt

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11

The name of the page to be transcluded

Default
empty
Example
Aviation, 1=Aviation
Stringrequired
Paragraphsparagraphs

Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max

Default
all paragraphs
Example
paragraphs=1,3-5
Stringoptional
Filesfiles

Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max

Default
no files
Example
files=1,3-5
Stringoptional
FileArgsfileargs

Arguments to pass to File:

Default
no arguments
Example
fileargs=left
Stringoptional
Moremore

Text for trailing link to the entire article. Note: more= with no value produces the standard text: Read more...

Default
no link
Example
more=(more)
Stringoptional
Errorserrors

Allow Lua error messages to appear in the output?

Default
false
Example
errors=true
Booleanoptional