View source for Template:Transclude list item excerpt/doc

{{Documentation subpage}}
{{Lua|Module:Excerpt/portals}}
'''Transclude list item 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 an 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===
<pre style="overflow:auto">{{Transclude list item excerpt | 1= | section= | sectiononly= | paragraphs= | files= | fileargs= | errors= }}</pre>

=== Parameters ===
The template accepts one page name as an unnamed parameter.  Wikilinked list items are collected from that page, or a section of it.  One such item is selected randomly, and its destination is transcluded.  (If the selected page is invalid, the template will choose again.) Include a namespace where necessary.  There are no other positional parameters, but there are some optional named parameters:
*A section name such as <code>section=Featured articles</code>; the default is to collect wikilinks from all sections.
**A flag <code>sectiononly=yes</code> to exclude subsections.
*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
*<code>showall=</code> to show all articles simultaneously
*<code>list=</code> to show a list of articles <small>{{warnsign| coding not compatible with mobile versions of Wikipedia causing display and accessibility problems}}</small>
<code>paragraphs=</code> and <code>files=</code> each accept a comma-separated list containing numbers and/or number ranges in the format min-max.  Alternatively, <code>files=</code> can accept the name of a single image, e.g. <code>files=My image file.jpg</code>.

<code>showall=</code> shows all articles simultaneously.  This option is intended for a subpage aimed at editors as well as readers.  Using this template on a subpage with <code><nowiki><noinclude>|showall=</noinclude></nowiki></code> and transcluding the subpage on a main page will show all excerpts on the subpage but only one on the main page, without repeating the template and its arguments.
{{#section:Template:Transclude lead excerpt/doc|Miscellaneous options}}

===Page options===
{{#section-h:Template:Transclude lead excerpt/doc|Page options}}
===See also===
*{{tl|Transclude lead excerpt}}: specifies the article explicitly
*{{tl|Transclude linked excerpt}}: chooses the article randomly from those linked from 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 [[Wikipedia: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]].
{{Portal templates navbox}}

===TemplateData===
{{TemplateData header}}
<templatedata>
{
	"description": "Transclude list item excerpt transcludes the lead of a randomly chosen article as an excerpt",
	"params": {
		"1": {
			"label": "1",
			"description": "The name of a page containing list items with wikilinks to articles which may be transcluded",
			"type": "string",
			"required": true,
			"example": "Outline of forestry, 1=Outline of forestry",
			"default": "empty"
		},
		"section": {
			"label": "section",
			"description": "Limits wikilink collection to one section of the page",
			"type": "string",
			"required": false,
			"example": "section=Harvesting",
			"default": "empty"
		},
		"sectiononly": {
			"label": "sectiononly",
			"description": "Excludes subsections of the selected section",
			"type": "boolean",
			"required": false,
			"example": "sectiononly=yes",
			"default": "false"
		},
		"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=no suppresses the link.",
			"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"
		},
		"showall": {
			"label": "ShowAll",
			"description": "Show all excerpts simultaneously?",
			"type": "string",
			"required": false,
			"example": "showall={{clear}}{{hr}}",
			"default": "no arguments"
		},
		"list": {
			"label": "List",
			"description": "Show a list of excerpts?",
			"type": "string",
			"required": false,
			"example": "list=List of articles",
			"default": "no list"
		}
	},
	"format": "inline"
}
</templatedata>

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