Template:Excerpt/doc

This is a documentation subpage for Template:Excerpt.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Excerpt

This template uses TemplateStyles:

Template:Excerpt/styles.css

This template is used for reusing parts of pages in other pages. This practice has the following 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

It also has the following disadvantages:

Impediment to editing as you have to go to the sub article to make changes to the main article
Reduces accuracy as an excerpt of one article is not always a perfect fit into a new article (but see #Refinement using inclusion control)
Decreases visibility as changes to the sub article will not appear on the watchlist of editors of the main article

This template extends the capabilities of the built-in normal transclusion and labeled section transclusion.

Usage

Basic usage

{{Excerpt|Page title}} — Transclude the lead section (example)
{{Excerpt|Page title|Section title}} — Transclude a specific section, excluding any subsections (example)

Parameters

1 or article — Required. Title of the page to transclude. By default the lead section is transcluded (example). If the page contains an infobox, the image and caption of the infobox will be transcluded but not the infobox. Also, templates listed at Module:Excerpt/config will not be transcluded.
2 or section — Title of the section to transclude (example).
fragment — Name of the fragment to transclude (example). Must be marked with <section begin=Name of the fragment/> and <section end=Name of the fragment/> in the transcluded page. Notice that this template provides other ways of targeting specific fragments of a page without having to resort to section tags.
only — Elements to transclude. By default all elements are transcluded (except templates blacklisted at Module:Excerpt/config)
- only=file or only=files — Transclude only files (example)
- only=list or only=lists — Transclude only lists
- only=table or only=tables — Transclude only tables (example)
- only=template or only=templates — Transclude only templates
- only=paragraph or only=paragraphs — Transclude only paragraphs
paragraphs — Paragraphs to transclude. By default all paragraphs are transcluded.
- 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
lists — Lists to transclude. By default all lists are transcluded. Same syntax as when transcluding paragraphs.
files — Files to transclude. By default all files are transcluded. Same syntax as when transcluding paragraphs, but also:
- 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
tables — Tables to transclude. By default all tables are transcluded. Same syntax as when transcluding paragraphs, but also:
- 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 to transclude. By default all templates are transcluded (except templates blacklisted at Module:Excerpt/config). Same syntax as when transcluding paragraphs, but also:
- templates=Infobox — Transclude the template 'Infobox'
- templates=Infobox, Navbox, Chart — Transclude the template 'Infobox', 'Navbox' and 'Chart'
- templates=-Infobox — Transclude all templates except 'Infobox'
- templates=-Infobox, Navbox, Chart — Transclude all templates except 'Infobox', 'Navbox' and 'Chart'
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..." (example).
hat=no — Hide the hatnote "This section is an excerpt from..."
bold=yes — Preserve bold text.
quote=yes — Wrap the excerpt with <blockquote> tags.
inline=yes — Wrap the excerpt with <span> tags to use it inside other text.
indicator=yes — Show a vertical bar along the excerpt to indicate where it starts and where it ends.
references=no — Remove all references.
subsections=yes — 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

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 any valuable content of the section into the subpage). In such cases, 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 [[Page]].
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 [[Subpage]] and leave an excerpt.

Refinement using inclusion control

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 page COVID-19 misinformation begins The COVID-19 pandemic has resulted in misinformation.... However, when excerpting this lead to the misinformation section of COVID-19 pandemic, we don't need to specify which pandemic we're referring to. Therefore, the code The <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 in misinformation....

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 be tempted to remove them.

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 a whitespace character, the page engine would translate this as a leading space that renders the subsequent paragraph in code block and monospaced font with preserved formatting. For this reason, no spaces should separate the </noinclude> tag from the text it precedes.

Compared to #section

For 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 everything but those fragments.

The text will not be trimmed of excess whitespace, there will not be a header (equivalent to |nohat=yes, 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.

Excerpt trees

When a very general article (like Philosophy) uses excerpts from more specific articles (like Ethics, Metaphysics, Logic, etc), which in turn use excerpts from even more specific articles (like Ontology, Causality, etc), then a tree structure emerges, called an "Excerpt tree".

In this section 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):

See the excerpt trees

Template data

This template is used for transcluding part of an article into another article.

Template parameters
Parameter		Description	Type	Status
Article	`1` `article`	Title of the article to transclude Example Science	Page name	required
Section	`2` `section`	Title of the section to transclude Example History	String	optional
Only	`only`	Reduce the transcluded content to this element only Example table	String	optional
Fragment	`fragment`	Name of the fragment to transclude Example definition	String	optional
This	`this`	Change the initial text of the hatnote Example This gallery is	String	optional
No hatnote	`nohat`	Whether to remove the hatnote Example yes	Boolean	optional
Indicator	`indicator`	Whether to indicate the start and finish of the excerpt Example yes	Boolean	optional
Paragraphs	`paragraphs`	What paragraphs to transclude Example 1-3,5	String	optional
Files	`files`	What files to transclude Default 1 Example 1-3,5	String	optional
Tables	`tables`	Determines whether to transclude tables or not Default yes Example no	Boolean	optional
References	`references`	Determines whether to transclude references or not Default yes Example no	Boolean	optional
Subsections	`subsections`	Whether to transclude the subsections of the requested section Example yes	Boolean	optional
Tag	`tag`	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	String	optional