Template:Excerpt/id

From Linux Web Expert

Revision as of 18:52, 22 March 2024 by imported>FuzzyBot (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


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.

Basic usage

  • {{Excerpt|Page title}}Transclude the lead section (example)
  • {{Excerpt|Page title|Section title}}Transclude a specific section, excluding any subsections (example)

Parameters

  • 1Title of the page to transclude. Only required parameter. By default the lead section will be transcluded (example).
  • 2Title 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.
  • onlyElements to transclude (example). By default all elements are transcluded.
    • only=file or only=filesTransclude only files
    • only=list or only=listsTransclude only lists
    • only=table or only=tablesTransclude only tables
    • only=template or only=templatesTransclude only templates
    • only=paragraph or only=paragraphsTransclude only paragraphs
  • paragraphsParagraphs to transclude. By default all paragraphs are transcluded.
    • paragraphs=0Transclude no paragraphs
    • paragraphs=1Transclude the first paragraph
    • paragraphs=2Transclude the second paragraph
    • paragraphs=1,3Transclude the first and third paragraphs
    • paragraphs=1-3Transclude the first, second and third paragraphs
    • paragraphs=1-3,5Transclude the first, second, third and fifth paragraphs
    • paragraphs=-1Transclude all paragraphs except the first
    • paragraphs=-2Transclude all paragraphs except the second
    • paragraphs=-1,3Transclude all paragraphs except the first and third
    • paragraphs=-1-3Transclude all paragraphs except the first, second and third
    • paragraphs=-1-3,5Transclude all paragraphs except the first, second, third and fifth
  • listsLists to transclude. By default all lists are transcluded. Same syntax as when transcluding paragraphs.
  • filesFiles to transclude. By default all files are transcluded. Same syntax as when transcluding paragraphs, but also:
    • files=A.jpgTransclude the file named 'A.jpg'
    • files=A.jpg, B.png, C.gifTransclude the files named 'A.jpg', 'B.png' and 'C.gif'
    • files=.+%.pngTransclude all PNG files
    • files=-A.jpgTransclude all files except the one named 'A.jpg'
    • files=-A.jpg, B.png, C.gifTransclude all files except the ones named 'A.jpg', 'B.png' and 'C.gif'
    • files=-.+%.pngTransclude all non-PNG files
  • tablesTables to transclude. By default all tables are transcluded. Same syntax as when transcluding paragraphs, but also:
    • tables=Stats2020Transclude the table with id 'Stats2020'
    • tables=Stats2020, Stats2019, Stats2018Transclude the tables with ids 'Stats2020', 'Stats2019' and 'Stats2018'
    • tables=-Stats2020Transclude all tables except the one with id 'Stats2020'
    • tables=-Stats2020, Stats2019, Stats2018Transclude all tables except the ones with ids 'Stats2020', 'Stats2019' and 'Stats2018'
  • templatesTemplates to transclude. By default all templates are transcluded. Same syntax as when transcluding paragraphs, but also:
    • templates=InfoboxTransclude the template 'Infobox'
    • templates=Infobox, Navbox, ChartTransclude the template 'Infobox', 'Navbox' and 'Chart'
    • templates=-InfoboxTransclude all templates except 'Infobox'
    • templates=-Infobox, Navbox, ChartTransclude all templates except 'Infobox', 'Navbox' and 'Chart'
  • thisChange 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..."
  • displaytitleChange the text of the link in the hatnote. For example to add italics, subscripts, etc.
  • hat=noHide the hatnote "This section is an excerpt from..."
  • more=yesShow a "Read more..." link at the end
  • bold=yesKeep bold text.
  • quote=yesWrap the excerpt with ‎<blockquote> tags.
  • inline=yesRemove the hatnote and ‎<div> tags around the excerpt, to use it inside other text.
  • references=noRemove all references.
  • subsections=yesInclude 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
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.
  1. Copy the text of the section and append it to the lead of the page about the subtopic.
  1. Consolidate and adjust the combined lead using common sense.
  1. Save the changes in the child article with an edit summary like: Copied content from [[Page]]; see that article's history for attribution.
  1. Back in the section, delete all content and replace it with an excerpt of the page about the subtopic.
  1. Save the changes in the section with an edit summary like: Move content to [[page about the subtopic]] and leave an excerpt.

Excerpt trees

File:Excerpt tree.png
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}}
Page 'Lorem ipsum' not found

Specific section

{{Excerpt|Lorem ipsum|Section}}
Page 'Lorem ipsum' not found

Files only

{{Excerpt|Lorem ipsum|only=files|hat=no}}
Page 'Lorem ipsum' not found

Infobox only

{{Excerpt|Extension:CategoryLockdown|only=templates|templates=Extension|this=This infobox is}}
Ekstensi MediaWiki
Excerpt
Status rilis stabil
Implementasi Hak pengguna
Deskripsi Restrict permissions by category and group
Perancang awal Sophivorustalk
MediaWiki
Perubahan basis data Tidak
Lisensi Tidak ada lisensi yang ditetapkan
Unduh
Contoh [1]
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Terjemahkan ekstensi Excerpt jika tersedia di 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}}
Page 'Lorem ipsum' not found

See also

Template data

<templatedata>{"paramOrder":["1","2","hat","this","more","bold","quote","inline","references","subsections","fragment","only","paragraphs","files","tables","lists","templates"],"description":"Transclude any part of any page","params":{"references":{"suggested":false,"type":"boolean","required":false,"label":"References","example":"0","description":"Remove all references"},"fragment":{"suggested":false,"type":"boolean","required":false,"label":"Fragment","example":"Name of the fragment","description":"Name of the fragment to transclude"},"templates":{"suggested":false,"type":"string","required":false,"label":"Templates","example":"Infobox","description":"Templates to transclude"},"bold":{"suggested":false,"type":"boolean","required":false,"label":"Bold","example":"1","description":"Keep bold text"},"this":{"suggested":false,"type":"string","required":false,"label":"This","example":"This gallery is","description":"Initial text of the hatnote"},"hat":{"suggested":false,"type":"boolean","required":false,"label":"Hatnote","example":"0","description":"Hide the hatnote"},"more":{"suggested":false,"type":"boolean","required":false,"label":"Read more","example":"1","description":"Append a 'Read more' link"},"tables":{"suggested":false,"type":"string","required":false,"label":"Tables","example":"Stats2020","description":"Tables to transclude"},"inline":{"suggested":false,"type":"boolean","required":false,"label":"Inline","example":"1","description":"Wrap the excerpt with tags to use it inside other text"},"lists":{"suggested":false,"type":"string","required":false,"label":"Lists","example":"1-3,5","description":"Lists to transclude"},"paragraphs":{"suggested":false,"type":"string","required":false,"label":"Paragraphs","example":"1-3,5","description":"Paragraphs to transclude"},"subsections":{"suggested":false,"type":"boolean","required":false,"label":"Subsections","example":"1","description":"Include subsections of the transcluded section"},"files":{"suggested":false,"type":"string","required":false,"label":"Files","example":"A.jpg, B.png","description":"Files to transclude"},"only":{"suggested":false,"type":"string","required":false,"label":"Only","example":"tables","description":"Elements to transclude"},"quote":{"suggested":false,"type":"boolean","required":false,"label":"Quote","example":"1","description":"Wrap the excerpt with

tags"},"1":{"suggested":false,"type":"wiki-page-name","required":true,"label":"Page","example":"Science","description":"Page to transclude"},"2":{"suggested":false,"type":"string","required":false,"label":"Section","example":"History","description":"Section to transclude"}}}</templatedata>Edit parameter translations