 | This template is used onapproximately 13,000 pages and changes may be widely noticed. Test changes in the template's/sandbox or/testcases subpages, or in your ownuser subpage. Consider discussing changes on thetalk page before implementing them. |
 | This template usesLua: |
This template is used for reusing parts of pages in other pages. This practice has variousadvantages and disadvantages.
This template extends the capabilities of the built-innormal transclusion andlabeled section transclusion.
{{Excerpt|Page title}} – Transclude the lead section (example){{Excerpt|Page title|Section title}} – Transclude a specific section, excluding any subsections (example)There is one required parameter, and numerous optional ones for configuring the excerpt:
Source identification
|1= – Name of the article or page to transclude.Required. Aliases:|article= or|page=.|2= – Name of the section or tag to transclude. Optional; if omitted, transcludes the lead section (content above the first section header). Aliases:|section= or|fragment=.Transclusion config
Transcludable content is defined as one of severalelement types:file,list,paragraph,reference,subsection,table, ortemplate. Config parameters specify whichelement type to transclude, and in some cases,how many andwhich items of that type to transclude. All config parameters are optional; if omitted, all items of all element types are transcluded from the source page identified by the two unnamed parameters. Some element types support conditional item transclusion by specifying an item number range (1-3) or comma series (1, 2, 5); these types include: files, lists, paragraphs, and tables.
There are ten optional transclusion configuration parameters:
|only= – Element types to transclude. Values:file(s),list(s),table(s),template(s),paragraph(s). Default: all element types.|files= –Files to transclude. Default: all files. Same basic syntax as|paragraphs=, but see§ Details.|onlyfreefiles=no – Enables transclusion ofnon-free files. Default: exclude non-free content.|links=no – Unlink allwikilinks and render as plain text.|lists= – Lists (bulleted,numbered) to transclude. Default: all lists. Same syntax as for|paragraphs=.|paragraphs= –Paragraphs to transclude. Default: all paragraphs.|references=no – Exclude allreferences between<ref>...</ref> tags.|subsections=yes – Includesubsections of the transcluded section. Default: only content above the first subsection header.|tables= –Tables to transclude. Default: all tables. Same basic syntax as|paragraphs=, but see§ Details.|templates= –Templates to transclude. By default all templates are transcluded, except those blacklisted atModule:Excerpt/config. See§ Details for how to specify a specific template or templates for inclusion or exclusion.Style and extra features
These optional parameters alter the way transcluded items are displayed:
|bold=yes – Preservebold text.|briefdates=yes – Abbreviate birth and death information to (YYYY-YYYY) format|displaytitle= – Change the text of the link in the hatnote. For example,add italics, subscripts, etc.|hat=no – Hide thehatnote "This section is an excerpt from..."|inline=yes – Remove the<div> tags around the excerpt, to use it inside other text, or to add references or other content after itwith no paragraph break between them. Also hides the hatnote; to reestablish it, use{{transclusion notice}} above the Excerpt invocation.|quote=yes – Wrap the excerpt with<blockquote> tags.|this= – Change the initial text of the hatnote. For example, if the transcluded content is a gallery, you can set|this=This gallery is so that the hatnote reads "This gallery is an excerpt from..."|1= or|article= or|page=|files=0 is set). Also, templates listed atModule:Excerpt/config will not be transcluded (unless requested explicitly with|templates=, see below).|2= or|section= or|fragment=<section> tag to transclude (example). In the case of a section tag, the section must be marked with<section begin="Name of the fragment" /> and<section end="Name of the fragment" /> in the page to be transcluded. Notice that this template provides other ways of targeting specific fragments of a page without having to resort to section tags.|only=|only= is an exclusionary param, and excludes all other types of elements, except the one you name, so that for example, specifying|only=paragraphs excludes all lists, tables, templates, and so on. Param values can be in the singular (e.g.,|only=paragraph) or plural (e.g.,|only=paragraphs) and mean different things: in the singular, only the first item of that element type is transcluded; in the plural, all items are.|only=file – Transclude only the first file (but no lists, paragraphs, tables, etc.)|only=files – Transclude all files (but nothing else)|only=list – Transclude only the first list, exclude all other element types|only=lists – Transclude all lists (but nothing else)|only=table – Transclude only the first table, exclude all other element types. Does not transclude table templates, use|templates= for that.|only=tables – Transclude all tables (but nothing else) (example)|only=template – Transclude only the first template (excluding templates blacklisted atModule:Excerpt/config, as well as all other element types)|only=templates – Transclude all templates (excluding blacklisted templates), (but nothing else)|only=paragraph – Transclude only the first paragraph, exclude all other element types|only=paragraphs – Transclude all paragraphs (but nothing else)|files=|files=0 – Transclude no files|files=A.jpg – Transclude the file named 'A.jpg'|files=A.jpg, B.png, C.gif – Transclude the files named 'A.jpg', 'B.png' and 'C.gif'|files=.+%.png – Transclude all PNG files|files=-A.jpg – Transclude all files except the one named 'A.jpg'|files=-A.jpg, B.png, C.gif – Transclude all files except the ones named 'A.jpg', 'B.png' and 'C.gif'|files=-.+%.png – Transclude all non-PNG files|paragraphs=|paragraphs=0 – Transclude no paragraphs|paragraphs=1 – Transclude the first paragraph|paragraphs=2 – Transclude the second paragraph|paragraphs=1,3 – Transclude the first and third paragraphs|paragraphs=1-3 – Transclude the first, second and third paragraphs|paragraphs=1-3,5 – Transclude the first, second, third and fifth paragraphs|paragraphs=-1 – Transclude all paragraphs except the first|paragraphs=-2 – Transclude all paragraphs except the second|paragraphs=-1,3 – Transclude all paragraphs except the first and third|paragraphs=-1-3 – Transclude all paragraphs except the first, second and third|paragraphs=-1-3,5 – Transclude all paragraphs except the first, second, third and fifth|subsections=yes|tables=|tables=Stats2020 – Transclude the table with id 'Stats2020'|tables=Stats2020, Stats2019, Stats2018 – Transclude the tables with ids 'Stats2020', 'Stats2019' and 'Stats2018'|tables=-Stats2020 – Transclude all tables except the one with id 'Stats2020'|tables=-Stats2020, Stats2019, Stats2018 – Transclude all tables except the ones with ids 'Stats2020', 'Stats2019' and 'Stats2018'|templates=|templates=-Ocean – Add the template 'Ocean' to the blacklist|templates=-Ocean, Nature – Add the templates 'Ocean' and 'Nature' to the blacklist|templates=Infobox person – Ignore the blacklist and transclude the template 'Infobox person'|templates=Infobox person, Ocean – Ignore the blacklist and transclude the templates 'Infobox person' and 'Ocean'|templates=.* – Ignore the blacklist and transclude all templatesFor simple cases of transcluding sections of articles, the {{#section}}, {{#section-x}}, and {{#section-h}} (abbreviated {{#lst}}, {{#lstx}}, and {{#lsth}})) parser functions can be used instead of this template. {{#lsth:article|fragmentname}} will transclude the section of "article" with the header "fragmentname", and {{#lsth:article}} will transclude the lead section of "article". Excerpting only specific paragraphs can be done by marking up the source article with<section begin=fragmentname/>...<section end=fragmentname/> tags and using {{#lst:article|fragmentname}} to transclude those fragments, which is equivalent to using the|fragment=fragmentname parameter with this template. {{#lsth:article|fragmentname}} can also be used to transclude everythingbut those fragments.
The text will not be trimmed of excess whitespace, there will not be a header (equivalent to|hat=no, and all files, templates, tables, references, and subsections will be included unless the source article is marked up with<section begin=fragmentname/>...<section end=fragmentname/>,<noinclude>...</noinclude>, or<onlyinclude>...</onlyinclude> tags.Self links will appear in bold.
It can happen that the source you want to excerpt contains footnotes in adifferent citation style than your article, and excerpting the source would cause a citation style mismatch, which is contrary to the guideline onciting sources. Sometimes, excerpt can still be used, while avoiding a mismatch in style, by the use of params|references=no and|inline=yes.
If the source you want to excerpt has multiple ref-tags interspersed throughout the source, and they need to display exactly in those locations in order to maintain fullverifiability, then this source might not be a good candidate for transclusion via the{{excerpt}} template, andcopying the content from the source into the article might be a better choice.
However, you can still use the Excerpt template, if the source page you want to excerpt meetseither of these conditions:
In either case, use params|references=no to strip the ref-tags from the transcluded content, and|inline=yes to define the excerpt as aninline display element in order to§ Suppress line breaks between paragraphs, and then manually append a copy of all the citations in the source immediately after the excerpt tag ending curly braces in the target article, with no intervening line breaks, white space, or other characters between the tag and the appended references. The copied references will have to be manually converted fromshort footnote-style to full, inline citation-style, or vice-versa, to match the citation style of the target.Note: citations are not creative content, andattribution is not needed for copying them.
It is advised to seek consensus before attempting this layout change.
If there are few shortened footnotes, a new subsection can be added to the "References" section to allow{{sfn}} to link to the correct citations. Here is one approach, where the{{sfn}} citations list in the excerpted article "SCBA" is titled "Works cited":
==Transcludedsection=={{excerpt|SCBA}}==References=={{reflist}}===FromSCBA==={{excerpt|SCBA|Workscited|hat=0}}{{sfn}} footnotes will now link to the citations created in the excerpted subsection.
To prevent the possibility of collisions betweennamed references in the transcluding and excerpted pages which would otherwise generate aduplicate key error, all ref names in the excerpted content are altered by prefixing the name with the pagename of the excerpted page. Thus, if the ref on pageMyArticle looks like<ref name="Jones-2024">, then when excerpted byTargetPage it will be changed to<ref name="MyArticle Jones-2024">, in order to avoid a collision with a possible "Jones-2024" ref already on the target page.
When a very general article uses excerpts from more specific articles, which in turn use excerpts from even more specific articles, then atree structure emerges, called an "Excerpt tree".
Here you can navigate the main excerpt trees on the English Wikipedia. It's useful for editors interested in expanding or improving them. To navigate the trees, click the following button(S):
Sometimes, a passage will almost fit for a transclusion, but not quite. In these cases, you can edit the source page to add<noinclude>...</noinclude> tags around content you don't want in the excerpt and<includeonly>...</includeonly> tags around content you want only in the excerpt.
For instance, the pageCOVID-19 misinformation begins with "TheCOVID-19 pandemic has resulted inmisinformation...". However, when excerpting this lead to the misinformation section ofCOVID-19 pandemic, we don't need to specify which pandemic we're referring to. Therefore, the codeThe <noinclude>[[COVID-19 pandemic]]</noinclude><includeonly>pandemic</includeonly> has resulted in [[misinformation]] can be used at the misinformation page, so that it will appear at the pandemic page as "The pandemic has resulted inmisinformation...".
For pages with a high volume of edits, it may be a good idea to leave a hidden comment explaining why the tags are there, so that no one will betempted to remove them, like so:The <noinclude>[[COVID-19 pandemic]]</noinclude><!--These tags are used to refine the excerpt at [[COVID-19 pandemic]]--><includeonly>pandemic</includeonly> has resulted in [[misinformation]]
Please note that when the</noinclude> tag is wrapped into a new line, a character next to it would be interpreted as a line beginning. This can lead to some formatting problems. For example, when a</noinclude> at line beginning is succeeded by awhitespace character, the page engine would translate this as aleading space that renders the subsequent paragraph incode block andmonospaced font with preserved formatting. For this reason, no spaces should separate the</noinclude> tag from the text it precedes.
A section is often asummary in aparent article of a more detailed page about a subtopic located in achild page; these are generally linked withTemplate:Main in the parent. Sometimes it's convenient to replace the content of such a summary section in the parent with an excerpt of the child page lead (after merging any valuable content of the section into the child page). In such cases, an efficient way to proceed is:
| IMPORTANT: In step four, include thefull edit summary as shown to comply with Wikipedia'scopyright policy. If you forget to do this at the time of the original edit, follow the instructions onRepairing insufficient attribution to create a dummy edit with the required edit summary. |
If you want to merge two excerpted paragraphs from a source into one longer one in your article, use two excerpts instead of one, and change the display mode toinline. So, for example, instead of this :
{{excerpt|Ocean color|paragraphs=2-3|file=no}} // (example taken fromOcean#Color)you could code:
{{excerpt|Ocean color|paragraphs=2|file=no|inline=yes}}{{excerpt|Ocean color|paragraphs=3|file=no|inline=yes}}and this will remove theline break between the two paragraphs, so they will render as one paragraph.
By default, an{{excerpt}} generates an HTMLdiv-tag, which is ablock-level display element, so contiguous excerpts are normally separate block elements with line breaks between them. This can be overridden through use of param|inline=yes, which suppresses the div-tag, and results in aninline display element instead. In this case, just as with running text on adjacent lines ofwikicode, no line break is generated between them.This technique can also be adapted to§ change citation style or use different references.
Excerpting content from a source page section into a target may causelink rot and other undesirable effects in the target if the heading or source content changes unexpectedly. Editors of the source page are generally unaware that editing the source can have side effects elsewhere. This situation can be mitigated by adding ahidden text message at the source page section being excerpted:
<!-- Note: Content in this section is {{excerpt}}ed by "PageName#SectionName". See TM:HIDDENEXCERPTADVICE. -->This alerts editors of the source file that part or all of the content in the area below the message is excerpted onto another page, so the editor can take target page side effects into account during their edit. Changing the heading is analogous toMOS:HIDDENLINKADVICE, which describes how to avoid undesirable side effects when a section heading change may lead to a broken redirect.
What to do
If you are about to edit a section that contains a hidden excerpt advice message, what should you do?
The use of{{Excerpt}} has the following advantages:
It also has the following disadvantages:
If an error is detected, an error message will appear in the article in place of the expected transcluded content:
This template is used for transcluding part of an article into another article.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Article | 1articlepage | Name of the article or page to transclude
| Page name | required |
| Section | 2sectionfragment | Name of the section or <section> tag to transclude
| String | optional |
| Only | only | Transclude only this kind of element
| String | optional |
| Paragraphs | paragraphsparagraph | Paragraphs to transclude
| String | optional |
| Files | filesfile | Files to transclude
| String | optional |
| Tables | tablestable | Tables to transclude
| String | optional |
| Lists | listslist | Lists to transclude
| String | optional |
| Templates | templatestemplate | Templates to transclude
| String | optional |
| References | references | Whether to transclude the references
| Boolean | optional |
| Subsections | subsections | Whether to transclude the subsections of the requested section
| Boolean | optional |
| Hatnote | hat | Whether to include the hatnote
| Boolean | optional |
| Bold | bold | Whether to preserve bold text
| Boolean | optional |
| Wikilinks | links | Whether to preserve wikilinks
| Boolean | optional |
| Quote | quote | Wraps the excerpt in <blockquote> tags
| Boolean | optional |
| This | this | Change the initial text of the hatnote
| String | optional |
| Display title | displaytitle | Change the text of the link in the hatnote | String | optional |
| Inline | inline | Remove the hatnote and <div> tags around the excerpt, to use it inside other text
| Boolean | optional |
| Only free files | onlyfreefiles | Enable transclusion of non-free files
| Boolean | optional |
| Brief dates | briefdates | Abbreviate birth and death information to (YYYY-YYYY) format
| Boolean | optional |
| Class | class | Additional CSS class
| String | optional |