Johanna: 1 revision imported

2025-10-10T14:20:44Z

1 revision imported

← Older revision	Revision as of 14:20, 10 October 2025
(No difference)

MediaWiki>FuzzyBot: Updating to match new version of source page

2025-03-11T12:10:09Z

Updating to match new version of source page

New page

<noinclude>
<languages />
</noinclude><includeonly>{{#invoke:Excerpt|main}}</includeonly><noinclude>
{{Documentation|content=

{{Lua|Module:Excerpt}}
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 [[Special:MyLanguage/Transclusion|normal 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> — Title of the page to transclude. '''Only required parameter.''' By default the lead section will be transcluded ([[#Lead section|example]]).
* <code>2</code> — Title of the section to transclude ([[#Specific section|example]]) or name of the [[Special:MyLanguage/Extension:Labeled Section Transclusion#How it works|{{tag|section|open}} tag]] to transclude. Notice that this template provides other ways of targeting specific elements 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
** <code>only=list</code> or <code>only=lists</code> — Transclude only lists
** <code>only=table</code> or <code>only=tables</code> — Transclude only tables
** <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..."
* <code>displaytitle</code> — Change the text of the link in the hatnote. For example to add italics, subscripts, etc.
* <code>hat=no</code> — Hide the hatnote "This section is an excerpt from..."
* <code>more=yes</code> — Show a "Read more..." link at the end
* <code>bold=yes</code> — Keep bold text.
* <code>quote=yes</code> — Wrap the excerpt with {{tag|blockquote|open}} tags.
* <code>inline=yes</code> — Remove the hatnote and {{tag|div|open}} tags around the excerpt, to use it inside other text.
* <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 a section with an excerpt ===
[[File:How to excerpt.webm|thumb|How to replace a section with an excerpt.]]

A section is often a summary of a more precise page dealing with a subtopic.
Sometimes it's convenient to replace the content of such a section with an excerpt of the page about the subtopic, after merging the original content of the section (if any) into the page about the subtopic.
This improves both the page about the subtopic and the section, reduces maintenance, drives contributors to collaborate, etc.

An efficient way to proceed is:

# Open the section for editing in one tab, and the page about the subtopic in another.
# Copy the text of the section and append it to the lead of the page about the subtopic.
# Consolidate and adjust the combined lead using common sense.
# Save the changes in the child article with an edit summary like: Copied content from <nowiki>[[Page]]</nowiki>; see that article's history for attribution.
# Back in the section, delete all content and replace it with an excerpt of the page about the subtopic.
# Save the changes in the section with an edit summary like: Move content to <nowiki>[[page about the subtopic]]</nowiki> and leave an excerpt.

== Excerpt trees ==
[[File:Excerpt tree.png|thumb|Visual representation of an imaginary excerpt tree.]]

When a very general article uses excerpts from more specific articles, which in turn use excerpts from even more specific articles, then a [[w:Tree structure|tree structure]] emerges, called an "Excerpt tree".

Below you can navigate the main excerpt trees on this wiki.
It's useful for editors interested in expanding or improving them.

{{Excerpt tree|
* [[Architecture Repository]]
* [[Platform Engineering Team]]
}}

== Examples ==

=== Lead section ===
<pre>{{Excerpt|Lorem ipsum}}</pre>
{{Excerpt|Lorem ipsum}}
{{Reflist}}
{{Clear}}

=== Specific section ===
<pre>{{Excerpt|Lorem ipsum|Section}}</pre>
{{Excerpt|Lorem ipsum|Section}}

=== Files only ===
<pre>{{Excerpt|Lorem ipsum|only=files|hat=no}}</pre>
{{Excerpt|Lorem ipsum|only=files|hat=no}}
{{Clear}}

=== Infobox only ===
<pre>{{Excerpt|Extension:CategoryLockdown|only=templates|templates=Extension|this=This infobox is}}</pre>
{{Excerpt|Extension:CategoryLockdown|only=templates|templates=Extension|this=This infobox is}}
{{Clear}}

=== No infobox ===
<pre>{{Excerpt|Extension:CategoryLockdown|templates=-Extension}}</pre>
{{Excerpt|Extension:CategoryLockdown|templates=-Extension}}

=== Portal ===
<pre>{{Excerpt|Lorem ipsum|files=1|references=no|hat=no|more=yes}}</pre>
{{Excerpt|Lorem ipsum|files=1|references=no|hat=no|more=yes}}
{{Clear}}

== See also ==
* [[Module:Transcluder]] <sup>{{ll|Module:Transcluder/doc|[doc]}}</sup>
* [[Module:Excerpt]]
* [[Module:Excerpt/config]]
* [[c:Data:I18n/Module:Excerpt.tab]]

== Template data ==
{{#invoke:TNT|doc|Excerpt}}

}}
</noinclude>

Template:Excerpt/en - Revision history

Johanna: 1 revision imported

MediaWiki>FuzzyBot: Updating to match new version of source page