Template:Excerpt/en

Template documentation

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 normal 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 — Title of the page to transclude. Only required parameter. By default the lead section will be transcluded (example).
• 2 — Title of the section to transclude (example) or name of the ‎<section> tag to transclude. Notice that this template provides other ways of targeting specific elements of a page without having to resort to section tags.
• only — Elements to transclude (example). By default all elements are transcluded.
  • only=file or only=files — Transclude only files
  • only=list or only=lists — Transclude only lists
  • only=table or only=tables — Transclude only tables
  • 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. 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..."
• hat=no — Hide the hatnote "This section is an excerpt from..."
• more=yes — Show a "Read more..." link at the end
• bold=yes — Keep bold text.
• quote=yes — Wrap the excerpt with ‎<blockquote> tags.
• inline=yes — Remove the hatnote and ‎<div> tags around the excerpt, to use it inside other text.
• 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 sections for excerpts

File:How to excerpt.webm

Sections are often summaries of more precise subpages. 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:

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

Examples

Lead section

{{Excerpt|Lorem ipsum}}

Specific section

{{Excerpt|Lorem ipsum|Section}}

Files only

{{Excerpt|Lorem ipsum|only=files|hat=no}}

Infobox only

{{Excerpt|Extension:CategoryLockdown|only=templates|templates=Extension|this=This infobox is}}

No infobox

{{Excerpt|Extension:CategoryLockdown|templates=-Extension}}

Portal

{{Excerpt|Lorem ipsum|files=1|references=no|hat=no|more=yes}}

See also

• Module:Transcluder
• Module:Excerpt
• Module:Excerpt/config
• c:Data:I18n/Module:Excerpt.tab

Template data

Transclude any part of any page

Template parameters

Parameter		Description	Type	Status
Page	1	Page to transclude Example Science	Page name	required
Section	2	Section to transclude Example History	String	optional
Hatnote	hat	Hide the hatnote Example 0	Boolean	optional
This	this	Initial text of the hatnote Example This gallery is	String	optional
Read more	more	Append a 'Read more' link Example 1	Boolean	optional
Bold	bold	Keep bold text Example 1	Boolean	optional
Quote	quote	Wrap the excerpt with <blockquote> tags Example 1	Boolean	optional
Inline	inline	Wrap the excerpt with <span> tags to use it inside other text Example 1	Boolean	optional
References	references	Remove all references Example 0	Boolean	optional
Subsections	subsections	Include subsections of the transcluded section Example 1	Boolean	optional
Fragment	fragment	Name of the fragment to transclude Example Name of the fragment	Boolean	optional
Only	only	Elements to transclude Example tables	String	optional
Paragraphs	paragraphs	Paragraphs to transclude Example 1-3,5	String	optional
Files	files	Files to transclude Example A.jpg, B.png	String	optional
Tables	tables	Tables to transclude Example Stats2020	String	optional
Lists	lists	Lists to transclude Example 1-3,5	String	optional
Templates	templates	Templates to transclude Example Infobox	String	optional

Edit parameter translations

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.