Template:Excerpt/doc
This is a documentation subpage for Template:Excerpt. It contains usage information, categories and other content that is not part of the original template page. |
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.{{Excerpt|Page title|Section title}}
โ Transclude a specific section, excluding any subsections.
Parameters
1
โ Title of the page to transclude. Only required parameter. By default the lead section will be transcluded.2
โ Title of the section to transclude.fragment
โ Name of the fragment to transclude. 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.only=file
oronly=files
โ Transclude only filesonly=list
oronly=lists
โ Transclude only listsonly=table
oronly=tables
โ Transclude only tablesonly=template
oronly=templates
โ Transclude only templatesonly=paragraph
oronly=paragraphs
โ Transclude only paragraphs
paragraphs
โ Paragraphs to transclude. By default all paragraphs are transcluded.paragraphs=0
โ Transclude no paragraphsparagraphs=1
โ Transclude the first paragraphparagraphs=2
โ Transclude the second paragraphparagraphs=1,3
โ Transclude the first and third paragraphsparagraphs=1-3
โ Transclude the first, second and third paragraphsparagraphs=1-3,5
โ Transclude the first, second, third and fifth paragraphsparagraphs=-1
โ Transclude all paragraphs except the firstparagraphs=-2
โ Transclude all paragraphs except the secondparagraphs=-1,3
โ Transclude all paragraphs except the first and thirdparagraphs=-1-3
โ Transclude all paragraphs except the first, second and thirdparagraphs=-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 filesfiles=-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 setthis=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 endbold=yes
โ Keep bold text.quote=yes
โ Wrap the excerpt with<blockquote>
tags.inline=yes
โ Wrap the excerpt with<span>
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
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:
- 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.
Excerpt trees
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".
In this section you can navigate the main excerpt trees on Appropedia. It's useful for editors interested in expanding or improving them.
See also
Template data
This template is used for transcluding part of an article into another article.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Article | 1 article page | Name of the article or page to transclude
| Page name | required |
Section | 2 section fragment | Name of the section or <section> tag to transclude
| String | optional |
Only | only | Transclude only this kind of element
| String | optional |
Paragraphs | paragraphs paragraph | Paragraphs to transclude
| String | optional |
Files | files file | Files to transclude
| String | optional |
Tables | tables table | Tables to transclude
| String | optional |
Lists | lists list | Lists to transclude
| String | optional |
Templates | templates template | Templates to transclude
| String | optional |
References | references | Whether to transclude the references
| Boolean | optional |
Subsections | subsections | Whether to transclude the subsections of the requested section
| Boolean | optional |
Hatnote | hat | Whether to include the hatnote
| Boolean | optional |
This | this | Change the initial text of the hatnote
| String | optional |
Inline | inline | Remove the hatnote and wrap the excerpt with <span> tags to use it inside other text
| Boolean | optional |
Class | class | Additional CSS class
| String | optional |