Template:Excerpt/doc:修订间差异

勤求古训,博采众方
删除的内容 添加的内容
无编辑摘要
无编辑摘要
第1行: 第1行:
{{Uses Lua|Module:Excerpt}}
{{Uses Lua|Module:Excerpt}}
此模板用于在其他页面中重用部分页面。这种做法有几个优点:
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
* <code><nowiki>{{Excerpt|Page title}}</nowiki></code> — 嵌入前导部分
* <code><nowiki>{{Excerpt|Page title|Section title}}</nowiki></code> — 包含特定部分,不包括任何小节


This template extends the capabilities of the built-in [[<tvar name=1>Special:MyLanguage/Transclusion</tvar>|normal transclusion]].


== Usage ==
=== 参数 ===


* <code>1</code> — 要嵌入的页面的标题。'''这是唯一必需的参数'''。默认情况下,前导部分将被嵌入
=== Basic usage ===
* <code>2</code> — 要嵌入的章节的标题或要嵌入的‎<section>标签的名称。请注意,此模板提供了其他方法来定位页面的特定元素,而无需求助于章节标签。
* <code><nowiki>{{Excerpt|Page title}}</nowiki></code> — Transclude the lead section ([[<tvar name=1>#Lead section</tvar>|example]])
* <code>only</code> — 要嵌入的元素。 默认情况下,所有元素都被嵌入。
* <code><nowiki>{{Excerpt|Page title|Section title}}</nowiki></code> — Transclude a specific section, excluding any subsections ([[<tvar name=1>#Specific section</tvar>|example]])


=== Parameters ===

* <code>1</code> — Title of the page to transclude. '''Only required parameter.''' By default the lead section will be transcluded ([[<tvar name=1>#Lead section</tvar>|example]]).
* <code>2</code> — 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>{{tag|section|open}}</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.
* <code>only</code> — Elements to transclude ([[<tvar name=1>#Files only</tvar>|example]]). By default all elements are transcluded.
** <code>only=file</code> or <code>only=files</code> — Transclude only files
** <code>only=file</code> or <code>only=files</code> — Transclude only files
** <code>only=list</code> or <code>only=lists</code> — Transclude only lists
** <code>only=list</code> or <code>only=lists</code> — Transclude only lists

2022年8月17日 (三) 23:52的版本

此模板用于在其他页面中重用部分页面。这种做法有几个优点:

  • 通过避免必须多次更新的重复内容来减少维护
  • 通过鼓励编辑合并相关内容而不是在不同的开发阶段拥有多个版本来提高内容质量
  • 通过将贡献者引导到一个地方而不是并行工作来促进协作

用法

基本用法

  • {{Excerpt|Page title}} — 嵌入前导部分
  • {{Excerpt|Page title|Section title}} — 包含特定部分,不包括任何小节


参数

  • 1 — 要嵌入的页面的标题。这是唯一必需的参数。默认情况下,前导部分将被嵌入
  • 2 — 要嵌入的章节的标题或要嵌入的‎<section>标签的名称。请注意,此模板提供了其他方法来定位页面的特定元素,而无需求助于章节标签。
  • only — 要嵌入的元素。 默认情况下,所有元素都被嵌入。
    • 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

See also