View source for Template:Transclude lead excerpt/doc

{{Documentation subpage}}
{{high-use}}
{{Lua|Module:Excerpt/portals}}
'''Transclude lead excerpt''' transcludes the lead of an article as an excerpt.  It is designed for use in [[BP:portal|portal]]s, [[BP:stand-alone lists|stand-alone lists]] and [[BP:outlines|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===
<pre style="overflow:auto">{{Transclude lead excerpt | 1= | paragraphs= | files= | fileargs= | errors= }}</pre>

=== 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:
*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
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. <code>files=My image file.jpg</code>.

<section begin=Miscellaneous options />
====Miscellaneous options====
* {{para|more|no}} – to suppress link to the article at the end of the excerpt. {{para|more|<var>custom text</var>}} to customize the link text at the end of the excerpt. Default is "Full article...".
*<code>keepSubsections=1</code> will cause Article#Section to retain any subsections of that section
*<code>keepRefs=1</code> will keep references for display in a {{tl|reflist}} or similar
*<code>nobold=1</code> will cause bold text to be displayed in normal font
<section end=Miscellaneous options />
===Page options===
<!-- This section is transcluded into the documentation of similar templates. -->
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: <code>Article</code>; <code>Article#Section</code>; <code><nowiki>[[Article]]</nowiki></code>; <code><nowiki>[[Article#Section|A section of an article]]</nowiki></code>.  (Any piped text will be ignored.)

Any of the above formats may be followed by option(s) separated by pipes, e.g. <code>Article|paragraphs=2</code>.  Such options override any global options for the given page only.  Note that the characters <code>|</code> and <code>=</code> have special meaning within calls to templates but can be escaped using {{tl|!}} and {{tl|{{=}}}} respectively.  Examples: <code><nowiki>Article#Section{{!}}files{{=}}2</nowiki></code>; <code><nowiki>[[Article|Some page]]{{!}}files{{=}}3,4{{!}}more{{=}}Click here</nowiki></code>.  (<code>=</code> need not be escaped if the parameter is explicitly numbered, e.g. <code><nowiki>1=Article{{!}}files=2</nowiki></code>).

Special characters such as pipes within page options must be doubly escaped, replacing their double braces by {{tl|((}} and {{tl|))}}.  For example, to set display Custom image.jpg on the left with a custom caption, set fileargs to <code>left|Custom caption</code> using <code><nowiki>Article{{!}}files{{=}}Custom image.jpg{{!}}fileargs{{=}}left{{((}}!{{))}}Custom caption</nowiki></code>.  To add a wikilink within a caption, escape the link brackets and any pipe twice using {{tl|!((}}, {{tl|))!}} and possibly {{tl|!}}, e.g. <code><nowiki>Caption with {{((}}!(({{))}}Pipe (computer science){{((}}!{{))}}piped{{((}}))!{{))}} link</nowiki></code>.  This text can be achieved more simply using {{tl|Doubly escaped wikilink}}, e.g. <code><nowiki>Caption with {{Doubly escaped wikilink|Pipe (computer science)|piped}} link</nowiki></code>.

===See also===
Similar templates also using [[Module:Excerpt]]:
*{{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
*{{tl|Transclude selected excerpt}}: chooses the article from a list using an index such as the week number
The templates were discussed at [[Bharatpedia:Village_pump_(policy)/Archive_155#Use of direct transclusion in portals and the newer portal transclusion templates|Use of direct transclusion in portals and the newer portal transclusion templates]].
*{{tl|Excerpt}}: template designed for excerpt transclusion in articles
{{Portal templates navbox}}

===TemplateData===
{{TemplateData header}}
<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"
}
</templatedata>

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