Jump to content

Template:Excerpt

From mediawiki.org
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..."
  • displaytitle — Change the text of the link in the hatnote. For example to add italics, subscripts, etc.
  • 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 a section with an excerpt

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:

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

Excerpt trees

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 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.

Examples

Lead section

{{Excerpt|Lorem ipsum}}
This is an image.
This is another image.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.[1]

Specific section

{{Excerpt|Lorem ipsum|Section}}

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

Files only

{{Excerpt|Lorem ipsum|only=files|hat=no}}
This is an image.
This is another image.

Infobox only

{{Excerpt|Extension:CategoryLockdown|only=templates|templates=Extension|this=This infobox is}}
MediaWiki extensions manual
Excerpt
Release status: stable
Implementation User rights
Description Restrict permissions by category and group
Author(s) Sophivorustalk
MediaWiki
Database changes No
License No license specified
Download
Example [1]
Translate the Excerpt extension if it is available at translatewiki.net

No infobox

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

The CategoryLockdown extension allows admins to restrict permissions by category and group.

Portal

{{Excerpt|Lorem ipsum|files=1|references=no|hat=no|more=yes}}
This is an image.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

See also

Template data

Transclude any part of any page

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Page1

Page to transclude

Example
Science
Page namerequired
Section2

Section to transclude

Example
History
Stringoptional
Hatnotehat

Hide the hatnote

Example
0
Booleanoptional
Thisthis

Initial text of the hatnote

Example
This gallery is
Stringoptional
Read moremore

Append a 'Read more' link

Example
1
Booleanoptional
Boldbold

Keep bold text

Example
1
Booleanoptional
Quotequote

Wrap the excerpt with <blockquote> tags

Example
1
Booleanoptional
Inlineinline

Wrap the excerpt with <span> tags to use it inside other text

Example
1
Booleanoptional
Referencesreferences

Remove all references

Example
0
Booleanoptional
Subsectionssubsections

Include subsections of the transcluded section

Example
1
Booleanoptional
Fragmentfragment

Name of the fragment to transclude

Example
Name of the fragment
Booleanoptional
Onlyonly

Elements to transclude

Example
tables
Stringoptional
Paragraphsparagraphs

Paragraphs to transclude

Example
1-3,5
Stringoptional
Filesfiles

Files to transclude

Example
A.jpg, B.png
Stringoptional
Tablestables

Tables to transclude

Example
Stats2020
Stringoptional
Listslists

Lists to transclude

Example
1-3,5
Stringoptional
Templatestemplates

Templates to transclude

Example
Infobox
Stringoptional
Edit parameter translations