Template:Transclude lead excerpt/doc

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: It is also used to share the lead section between the pages of a multi-page glossary.
 * initial templates such as infoboxes, hatnotes and article improvement tags
 * noinclude sections
 * references and footnotes
 * images, unless specifically retained

Usage


Parameters
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: 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..
 * A list of paragraphs such as ; the default is all paragraphs.
 * A list of file (image) numbers such as ; the default is no images.  Non-free images are removed.
 * Arguments to pass to File: such as  to move images to the left; the default is none.
 * to allow Lua error messages to appear in the output



Miscellaneous options

 * no – to suppress link to the article at the end of the excerpt. custom text to customize the link text at the end of the excerpt. Default is "Full article...".
 * will cause Article#Section to retain any subsections of that section
 * will keep references for display in a reflist or similar
 * will cause bold text to be displayed in normal font

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: ;  ;  ;. (Any piped text will be ignored.)

Any of the above formats may be followed by option(s) separated by pipes, e.g. .  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: ;. ( need not be escaped if the parameter is explicitly numbered, e.g.  ).

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  using. To add a wikilink within a caption, escape the link brackets and any pipe twice using !()! and possibly !, e.g. .  This text can be achieved more simply using Doubly escaped wikilink, e.g..

TemplateData
{	"description": "Transclude lead excerpt transcludes the lead of an article as an excerpt", "params": { "1": {			"label": "1", "description": "The name of the page to be transcluded", "type": "string", "required": true, "example": "Aviation, 1=Aviation", "default": "empty" },		"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= with no value produces the standard text: Read more...", "type": "string", "required": false, "example": "more=(more)", "default": "no link" },		"errors": { "label": "Errors", "description": "Allow Lua error messages to appear in the output?", "type": "boolean", "required": false, "example": "errors=true", "default": "false" }	},	"format": "inline" }