Template:Excerpt/doc

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 [[<tvar name=1>Special:MyLanguage/Transclusion</tvar>|normal transclusion]].

Usage

Basic usage

• {{Excerpt|Page title}} — Transclude the lead section ([[<tvar name=1>#Lead section</tvar>|example]])
• {{Excerpt|Page title|Section title}} — Transclude a specific section, excluding any subsections ([[<tvar name=1>#Specific section</tvar>|example]])

Parameters

• 1 — Title of the page to transclude. Only required parameter. By default the lead section will be transcluded ([[<tvar name=1>#Lead section</tvar>|example]]).
• 2 — Title of the section to transclude ([[<tvar name=1>#Specific section</tvar>|example]]) or name of the [[<tvar name=2>Special:MyLanguage/Extension:Labeled Section Transclusion#How it works</tvar>|<tvar name=3><section></tvar> 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 ([[<tvar name=1>#Files only</tvar>|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 '<tvar name=1>A.jpg</tvar>'
  • files=A.jpg, B.png, C.gif — Transclude the files named '<tvar name=1>A.jpg</tvar>', '<tvar name=2>B.png</tvar>' and '<tvar name=3>C.gif</tvar>'
  • files=.+%.png — Transclude all PNG files
  • files=-A.jpg — Transclude all files except the one named '<tvar name=1>A.jpg</tvar>'
  • files=-A.jpg, B.png, C.gif — Transclude all files except the ones named '<tvar name=1>A.jpg</tvar>', '<tvar name=2>B.png</tvar>' and '<tvar name=3>C.gif</tvar>'
  • 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 '<tvar name=1>Stats2020</tvar>'
  • tables=Stats2020, Stats2019, Stats2018 — Transclude the tables with ids '<tvar name=1>Stats2020</tvar>', '<tvar name=2>Stats2019</tvar>' and '<tvar name=3>Stats2018</tvar>'
  • tables=-Stats2020 — Transclude all tables except the one with id '<tvar name=1>Stats2020</tvar>'
  • tables=-Stats2020, Stats2019, Stats2018 — Transclude all tables except the ones with ids '<tvar name=1>Stats2020</tvar>', '<tvar name=2>Stats2019</tvar>' and '<tvar name=3>Stats2018</tvar>'
• templates — Templates to transclude. By default all templates are transcluded. Same syntax as when transcluding paragraphs, but also:
  • templates=Infobox — Transclude the template '<tvar name=1>Infobox</tvar>'
  • templates=Infobox, Navbox, Chart — Transclude the template '<tvar name=1>Infobox</tvar>', '<tvar name=2>Navbox</tvar>' and '<tvar name=3>Chart</tvar>'
  • templates=-Infobox — Transclude all templates except '<tvar name=1>Infobox</tvar>'
  • templates=-Infobox, Navbox, Chart — Transclude all templates except '<tvar name=1>Infobox</tvar>', '<tvar name=2>Navbox</tvar>' and '<tvar name=3>Chart</tvar>'
• this — Change the initial text of the hatnote. For example, if the transcluded content is a gallery, you can set <tvar name=1>this=This gallery is</tvar> 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 <tvar name=1><blockquote></tvar> tags.
• inline=yes — Wrap the excerpt with <tvar name=1><span></tvar> tags 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

How to replace a section for an excerpt.

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.

1. Edit both.

1. Copy the text of the section and paste it below the lead section of the subpage.

1. Delete repeated content and adjust using common sense.

1. Save the changes in the subpage with an edit summary like: Bring content from <tvar name=1>[[Page]]</tvar>.

1. Back to the section, delete all content and replace it for an excerpt of the subpage.

1. Save the changes in the section with an edit summary like: Move content to <tvar name=1>[[Subpage]]</tvar> 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