View source for Template:Excerpt/doc

{{Documentation subpage}}
{{High-risk}}
{{Lua|Module:Excerpt}}
{{Uses TemplateStyles|Template:Excerpt/styles.css}}
{{Commons Import}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This template is used for reusing parts of pages in other pages. This practice has several advantages:

* '''Reduces maintenance''' by avoiding duplicate content that must be updated multiple times
* '''Improves content quality''' by encouraging editors to merge related content, rather than having multiple versions in various stages of development
* '''Fosters collaboration''' by channeling contributors into one place, rather than working in parallel

This template extends the capabilities of the built-in [[Help:Transclusion|normal transclusion]] and [[Help:Labeled section transclusion|labeled section transclusion]].

==Usage==

===Basic usage===

* <code><nowiki>{{Excerpt|Page title}}</nowiki></code> — Transclude the lead section ([[#Lead section|example]])
* <code><nowiki>{{Excerpt|Page title|Section title}}</nowiki></code> — Transclude a specific section, excluding any subsections ([[#Specific section|example]])

===Parameters===

* <code>1</code> or <code>article</code> — Title of the page to transclude. '''Only required parameter.''' By default<!-- defaul is actually about the next parameter--> the lead section is transcluded ([[#Lead section|example]]).
* <code>2</code> or <code>section</code> — Title of the section to transclude ([[#Specific section|example]]).
* <code>fragment</code> — Name of the fragment to transclude. Must be marked with <code><nowiki><section begin=Name of the fragment/></nowiki></code> and <code><nowiki><section end=Name of the fragment/></nowiki></code> in the transcluded page ([[#Specific fragment|example]]). Notice that this template provides other ways of targeting specific fragments of a page without having to resort to section tags.
* <code>only</code> — Elements to transclude ([[#Files only|example]]). By default all elements are transcluded.
** <code>only=file</code> or <code>only=files</code> — Transclude only files ([[#Table only|example]])
** <code>only=list</code> or <code>only=lists</code> — Transclude only lists ([[#List only|example]])
** <code>only=table</code> or <code>only=tables</code> — Transclude only tables ([[#File only|example]])
** <code>only=template</code> or <code>only=templates</code> — Transclude only templates
** <code>only=paragraph</code> or <code>only=paragraphs</code> — Transclude only paragraphs
* <code>paragraphs</code> — Paragraphs to transclude. By default all paragraphs are transcluded.
** <code>paragraphs=0</code> — Transclude no paragraphs
** <code>paragraphs=1</code> — Transclude the first paragraph
** <code>paragraphs=2</code> — Transclude the second paragraph
** <code>paragraphs=1,3</code> — Transclude the first and third paragraphs
** <code>paragraphs=1-3</code> — Transclude the first, second and third paragraphs
** <code>paragraphs=1-3,5</code> — Transclude the first, second, third and fifth paragraphs
** <code>paragraphs=-1</code> — Transclude all paragraphs except the first
** <code>paragraphs=-2</code> — Transclude all paragraphs except the second
** <code>paragraphs=-1,3</code> — Transclude all paragraphs except the first and third
** <code>paragraphs=-1-3</code> — Transclude all paragraphs except the first, second and third
** <code>paragraphs=-1-3,5</code> — Transclude all paragraphs except the first, second, third and fifth
* <code>lists</code> — Lists to transclude. By default all lists are transcluded. Same syntax as when transcluding paragraphs.
* <code>files</code> — Files to transclude. By default all files are transcluded. Same syntax as when transcluding paragraphs, but also:
** <code>files=A.jpg</code> — Transclude the file named 'A.jpg'
** <code>files=A.jpg, B.png, C.gif</code> — Transclude the files named 'A.jpg', 'B.png' and 'C.gif'
** <code>files=.+%.png</code> — Transclude all PNG files
** <code>files=-A.jpg</code> — Transclude all files except the one named 'A.jpg'
** <code>files=-A.jpg, B.png, C.gif</code> — Transclude all files except the ones named 'A.jpg', 'B.png' and 'C.gif'
** <code>files=-.+%.png</code> — Transclude all non-PNG files
* <code>tables</code> — Tables to transclude. By default all tables are transcluded. Same syntax as when transcluding paragraphs, but also:
** <code>tables=Stats2020</code> — Transclude the table with id 'Stats2020'
** <code>tables=Stats2020, Stats2019, Stats2018</code> — Transclude the tables with ids 'Stats2020', 'Stats2019' and 'Stats2018'
** <code>tables=-Stats2020</code> — Transclude all tables except the one with id 'Stats2020'
** <code>tables=-Stats2020, Stats2019, Stats2018</code> — Transclude all tables except the ones with ids 'Stats2020', 'Stats2019' and 'Stats2018'
* <code>templates</code> — Templates to transclude. By default all templates are transcluded. Same syntax as when transcluding paragraphs, but also:
** <code>templates=Infobox</code> — Transclude the template 'Infobox'
** <code>templates=Infobox, Navbox, Chart</code> — Transclude the template 'Infobox', 'Navbox' and 'Chart'
** <code>templates=-Infobox</code> — Transclude all templates except 'Infobox'
** <code>templates=-Infobox, Navbox, Chart</code> — Transclude all templates except 'Infobox', 'Navbox' and 'Chart'
* <code>this</code> — Change the initial text of the hatnote. For example, if the transcluded content is a gallery, you can set <code>this=This gallery is</code> so that the hatnote reads "This gallery is an excerpt from..." ([[#Specific fragment|example]]).
* <code>hat=no</code> — Hide the [[Wikipedia:Hatnote|hatnote]] "This section is an excerpt from..."
* <code>quote=yes</code> — Wrap the excerpt with <code><nowiki><blockquote></nowiki></code> tags.
* <code>inline=yes</code> — Wrap the excerpt with <code><nowiki><span></nowiki></code> tags to use it inside other text.
* <code>indicator=yes</code> — Show a vertical bar along the excerpt to indicate where it starts and where it ends.
* <code>references=no</code> — Remove all references.
* <code>subsections=yes</code> — Include subsections of the transcluded section. Notice that if the transclusion is done from a section level 3, and the transcluded subsections are level 3 too, then the transcluded subsections will show with the same hierarchy as the transcluding section, which is probably not desirable, so use with caution.

=== Replacing Template:Main ===

[[File:How_to_excerpt.webm|thumb|How to replace a section for an excerpt.]]

Sections are often summaries of more precise subpages (generally linked with [[Template:Main]]). Sometimes it's convenient to replace the content of such sections for excerpts of the subpages, after merging the original content of the section (if any) into the subpage. This improves both the subpage and the section, reduces maintenance, drives contributors to collaborate, etc.

An efficient way to proceed is:

# Open the section in one tab and the subpage in another.
# Edit both.
# Copy the text of the section and paste it below the lead section of the subpage.
# Delete repeated content and adjust using common sense.
# Save the changes in the subpage with an edit summary like: Bring content from <nowiki>[[Page]]</nowiki>.
# Back to the section, delete all content and replace it for an excerpt of the subpage.
# Save the changes in the section with an edit summary like: Move content to <nowiki>[[Subpage]]</nowiki> and leave an excerpt.

===Compared to #section===
For simple cases of transcluding sections of articles, the {{pf|section}}, {{pf|section-x}}, and {{pf|section-h}} (abbreviated {{pf|lst}}, {{pf|lstx}}, and {{pf|lsth}})) parser functions can be used instead of this template. {{pf|lsth|article|section}} will transclude the section of "article" with the header "section", and {{pf|lsth|article}} will transclude the lead section of "article". Excerpting only specific paragraphs can be done by marking up the source article with {{tag|section}} tags and using {{pf|lst|fragmentname}} to transclude those fragments, which is equivalent to using the {{para|fragment}} parameter with this template. {{tag|lsth}} can also be used to transclude everything ''but'' those fragments.

The text will not be trimmed of excess whitespace, there will not be a header (equivalent to {{para|nohat|yes}}, and all files, templates, tables, references, and subsections will be included unless the source article is marked up with {{tag|section}}, {{tag|noinclude}}, or {{tag|onlyinclude}} tags. [[Help:Self link|Self links]] will appear in bold.

==Examples==

===Lead section===
<pre>{{Excerpt|Science}}</pre>
{{Excerpt|Science}}
{{Sources-talk}}

===Specific section===
<pre>{{Excerpt|Science|Branches of science}}</pre>
{{Excerpt|Science|Branches of science}}
{{Sources-talk}}

===Table only===
<pre>{{Excerpt|Science|Branches of science|only=table}}</pre>
{{Excerpt|Science|Branches of science|only=table}}

===File only===
<pre>{{Excerpt|Science|19th century|only=file|files=2}}</pre>
{{Excerpt|Science|19th century|only=file|files=2}}
{{Clear}}

===List only===
<pre>{{Excerpt|Indian philosophy|Orthodox schools|only=list}}</pre>
{{Excerpt|Indian philosophy|Orthodox schools|only=list}}
{{Sources-talk}}

===Specific fragment===
<pre>{{Excerpt|2020 Republican Party presidential primaries|fragment=declared|this=These tables are}}</pre>
{{Excerpt|2020 Republican Party presidential primaries|fragment=declared|this=These tables are}}
{{Sources-talk}}
{{Sources-talk|group=lower-alpha|title=Notes}}

==See also==
For more detail see wikipedia page [[wikipedia:Template:Excerpt]]

==Template data==
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"article"
			],
			"label": "Article",
			"description": "Title of the article to transclude",
			"example": "Science",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"aliases": [
				"section"
			],
			"label": "Section",
			"description": "Title of the section to transclude",
			"example": "History",
			"type": "string"
		},
		"fragment": {
			"label": "Fragment",
			"description": "Name of the fragment to transclude",
			"example": "definition",
			"type": "string"
		},
		"nohat": {
			"description": "Whether to remove the hatnote",
			"label": "No hatnote",
			"example": "yes",
			"type": "boolean"
		},
		"paragraphs": {
			"label": "Paragraphs",
			"description": "What paragraphs to transclude",
			"example": "1-3,5",
			"type": "string"
		},
		"files": {
			"label": "Files",
			"description": "What files to transclude",
			"example": "1-3,5",
			"type": "string",
			"default": "1"
		},
		"subsections": {
			"label": "Subsections",
			"description": "Whether to transclude the subsections of the requested section",
			"example": "yes",
			"type": "boolean"
		},
		"indicator": {
			"label": "Indicator",
			"description": "Whether to indicate the start and finish of the excerpt",
			"example": "yes",
			"type": "boolean"
		},
		"tag": {
			"description": "Allows use of \"span\" rather than \"div\" for when you don't want a line break before or after the excerpt",
			"default": "div",
			"example": "span",
			"type": "string",
			"label": "Tag"
		},
		"tables": {
			"label": "Tables",
			"description": "Determines whether to transclude tables or not",
			"example": "no",
			"type": "boolean",
			"default": "yes"
		},
		"references": {
			"label": "References",
			"description": "Determines whether to transclude references or not",
			"example": "no",
			"type": "boolean",
			"default": "yes"
		},
		"only": {
			"label": "Only",
			"description": "Reduce the transcluded content to this element only",
			"example": "table",
			"type": "string"
		},
		"this": {
			"label": "This",
			"description": "Change the initial text of the hatnote",
			"example": "This gallery is",
			"type": "string"
		}
	},
	"description": "This template is used for transcluding part of an article into another article.",
	"paramOrder": [
		"1",
		"2",
		"only",
		"fragment",
		"this",
		"nohat",
		"indicator",
		"paragraphs",
		"files",
		"tables",
		"references",
		"subsections",
		"tag"
	]
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories go below this line; interwikis go to Wikidata. -->
[[Category:Wikipedia page-section templates]]
[[Category:Exclude in print]]
}}</includeonly>