வார்ப்புரு:Transclude lead excerpt/doc
{{Documentation subpage}}
 {{high-use|3,348}}
 {{Lua|Module:Excerpt}}
 '''Transclude lead 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 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===
 &lt;pre style=&quot;overflow:auto&quot;&gt;{{Transclude lead excerpt | 1= | paragraphs= | files= | fileargs= | more= | errors= }}&lt;/pre&gt;
 
 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 &lt;code&gt;paragraphs=1,3-5&lt;/code&gt;; the default is all paragraphs.
 *A list of file (image) numbers such as &lt;code&gt;files=1&lt;/code&gt;; the default is no images.  Non-free images are removed.
 *Arguments to pass to File: such as &lt;code&gt;fileargs=left&lt;/code&gt; to move images to the left; the default is none.
 *A link to the article itself such as &lt;code&gt;more=(more)&lt;/code&gt;; the default is no link.  Short cut: &lt;code&gt;more=&lt;/code&gt; produces [[Wikipedia|Read more...]]
 *&lt;code&gt;errors=&lt;/code&gt; 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.
 
 ===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
 {{Portal templates navbox}}
 
 ===TemplateData===
 {{TemplateData header}}
 &lt;templatedata&gt;
 {
 	&quot;description&quot;: &quot;Transclude lead excerpt transcludes the lead of an article as an excerpt&quot;,
 	&quot;params&quot;: {
 		&quot;1&quot;: {
 			&quot;label&quot;: &quot;1&quot;,
 			&quot;description&quot;: &quot;The name of the page to be transcluded&quot;,
 			&quot;type&quot;: &quot;string&quot;,
 			&quot;required&quot;: true,
 			&quot;example&quot;: &quot;Aviation, 1=Aviation&quot;,
 			&quot;default&quot;: &quot;empty&quot;
 		},
 		&quot;paragraphs&quot;: {
 			&quot;label&quot;: &quot;Paragraphs&quot;,
 			&quot;description&quot;: &quot;Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max&quot;,
 			&quot;type&quot;: &quot;string&quot;,
 			&quot;required&quot;: false,
 			&quot;example&quot;: &quot;paragraphs=1,3-5&quot;,
 			&quot;default&quot;: &quot;all paragraphs&quot;
 		},
 		&quot;files&quot;: {
 			&quot;label&quot;: &quot;Files&quot;,
 			&quot;description&quot;: &quot;Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max&quot;,
 			&quot;type&quot;: &quot;string&quot;,
 			&quot;required&quot;: false,
 			&quot;example&quot;: &quot;files=1,3-5&quot;,
 			&quot;default&quot;: &quot;no files&quot;
 		},
 		&quot;fileargs&quot;: {
 			&quot;label&quot;: &quot;FileArgs&quot;,
 			&quot;description&quot;: &quot;Arguments to pass to File:&quot;,
 			&quot;type&quot;: &quot;string&quot;,
 			&quot;required&quot;: false,
 			&quot;example&quot;: &quot;fileargs=left&quot;,
 			&quot;default&quot;: &quot;no arguments&quot;
 		},
 		&quot;more&quot;: {
 			&quot;label&quot;: &quot;More&quot;,
 			&quot;description&quot;: &quot;Text for trailing link to the entire article.  Note: more= with no value produces the standard text: Read more...&quot;,
 			&quot;type&quot;: &quot;string&quot;,
 			&quot;required&quot;: false,
 			&quot;example&quot;: &quot;more=(more)&quot;,
 			&quot;default&quot;: &quot;no link&quot;
 		},
 		&quot;errors&quot;: {
 			&quot;label&quot;: &quot;Errors&quot;,
 			&quot;description&quot;: &quot;Allow Lua error messages to appear in the output?&quot;,
 			&quot;type&quot;: &quot;boolean&quot;,
 			&quot;required&quot;: false,
 			&quot;example&quot;: &quot;errors=true&quot;,
 			&quot;default&quot;: &quot;false&quot;
 		}
 	},
 	&quot;format&quot;: &quot;inline&quot;
 }
 &lt;/templatedata&gt;
 
 &lt;includeonly&gt;{{sandbox other||
 [[Category:Encyclopedic content templates]]