Template:Excerpt/doc

此頁面是Template:Excerpt的Template文档。
此頁面可能包含了模板的使用說明、分類和其他内容。

此模板使用Lua语言：

Module:Excerpt（沙盒）

这种模板用于在其他页面中重复使用部分页面。这种做法有以下优点:

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

但它也具有以下缺点 :

因为您必须转到子文章才能对主要文章进行更改。
由于代码生成的问题，一篇文章的摘录格式不能完美地融入一篇新文章，存在段落丢失问题。
对子文章的更改不会出现在主文章的编辑监视列表中。

此模板擴展了內建的一般轉用和帶標籤段落轉用的功能。

用法

基本用法

{{Excerpt|Page title}} — 轉用導言部分 (範例)
{{Excerpt|Page title|Section title}} — 轉用特定段落，不包括任何子段落 (範例)

參數

1 或 article 或 page — 必填。 要轉用的文章或頁面的名稱。預設情況下，轉用的是導言部分 (範例)。如果頁面包含資訊框，則資訊框中的圖像和標題也會被轉用（除非設置了 files=0）。另外，Module:Excerpt/config 中列出的模板將不會被轉用（除非明確請求使用 |templates=，見下文）。
2 或 section 或 fragment — 要轉用的段落名稱 (範例) 或要轉用的 <section> 標籤 (範例)。在被轉用的頁面中，必須使用 <section begin=Name of the fragment/> 和 <section end=Name of the fragment/> 標記。請注意，此模板還提供其他方式來定位頁面的特定片段，而不必使用段落標籤。
only — 要轉用的元素。預設情況下，所有元素都會被轉用（除了在 Module:Excerpt/config 中列入黑名單的模板）。
- only=file — 僅轉用第一個檔案。
- only=files — 僅轉用檔案。
- only=list — 僅轉用第一個清單。
- only=lists — 僅轉用清單。
- only=table — 僅轉用第一個表格。
- only=tables — 僅轉用表格 (範例)。
- only=template — 僅轉用第一個模板。
- only=templates — 僅轉用模板。
- only=paragraph — 僅轉用第一個段落。
- only=paragraphs — 僅轉用段落。
paragraphs — 要轉用的段落。預設情況下，所有段落都會被轉用。
- paragraphs=0 — 不轉用任何段落。
- paragraphs=1 — 轉用第一個段落。
- paragraphs=2 — 轉用第二個段落。
- paragraphs=1,3 — 轉用第一個和第三個段落。
- paragraphs=1-3 — 轉用第一、第二及第三個段落。
- paragraphs=1-3,5 — 轉用第一、第二、第三及第五個段落。
- paragraphs=-1 — 轉用除了第一個以外的所有段落。
- paragraphs=-2 — 轉用除了第二個以外的所有段落。
- paragraphs=-1,3 — 轉用除了第一個和第三個以外的所有段落。
- paragraphs=-1-3 — 轉用除了第一、第二及第三個以外的所有段落。
- paragraphs=-1-3,5 — 轉用除了第一、第二、第三及第五個以外的所有段落。
lists — 要轉用的清單。預設情況下，所有清單都會被轉用。語法與轉用段落相同。
files — 要轉用的檔案。預設情況下，所有檔案都會被轉用。語法與轉用段落相同，但還包括：
- files=A.jpg — 轉用名為「A.jpg」的檔案。
- files=A.jpg, B.png, C.gif — 轉用名為「A.jpg」、「B.png」及「C.gif」的檔案。
- files=.+%.png — 轉用所有 PNG 檔案。
- files=-A.jpg — 轉用除了名為「A.jpg」以外的所有檔案。
- files=-A.jpg, B.png, C.gif — 轉用除了名為「A.jpg」、「B.png」及「C.gif」以外的所有檔案。
- files=-.+%.png — 轉用所有非 PNG 檔案。
tables — 要轉用的表格。預設情況下，所有表格都會被轉用。語法與轉用段落相同，但還包括：
- tables=Stats2020 — 轉用 id 為「Stats2020」的表格。
- tables=Stats2020, Stats2019, Stats2018 — 轉用 id 為「Stats2020」、「Stats2019」及「Stats2018」的表格。
- tables=-Stats2020 — 轉用除了 id 為「Stats2020」的表格以外的所有表格。
- tables=-Stats2020, Stats2019, Stats2018 — 轉用除了 id 為「Stats2020」、「Stats2019」及「Stats2018」的表格以外的所有表格。
templates — 要轉用的模板。預設情況下，所有模板都會被轉用，除了在 Module:Excerpt/config 中列入黑名單的那些。若在以逗號分隔的模板列表前加上連字符，則會將這些模板加入黑名單。
- templates=-Ocean — 將模板 {{Ocean}} 加入黑名單。
- templates=-Ocean, Nature — 將模板 {{Ocean}} 及 {{Nature}} 加入黑名單。
- templates=Infobox person — 忽略黑名單並轉用模板 {{Infobox person}}。
- templates=Infobox person, Ocean — 忽略黑名單並轉用模板 {{Infobox person}} 及 {{Ocean}}。
- templates=.* — 忽略黑名單並轉用所有模板。
this — 更改引言注釋的初始文字。例如，如果轉用的內容是圖庫，您可以設置 this=This gallery is，使得引言注釋顯示 "This gallery is an excerpt from..." (範例)。
displaytitle — 更改引言注釋中連結的文字。例如，添加斜體、下標等。
hat=no — 隱藏頂注「這個部分摘自」。
bold=yes — 保留粗體文字。
links=no — 移除所有維基連結。
quote=yes — 用 <blockquote> 標籤包裹轉用的內容。
dd=yes — 以冒號列表（描述列表）的形式轉用。預設只轉用段落、無頂注。
inline=yes — 移除轉用內容周圍的引言注釋和 <div> 標籤，以便嵌入其他文字中。
onlyfreefiles=no — 允許轉用非自由檔案。
briefdates=yes — 將出生和死亡資訊縮寫為 (YYYY-YYYY) 格式。
references=no — 移除所有參考文獻。
subsections=yes — 包含轉用段落的子段落。請注意，如果從第 3 級段落進行轉用，且被轉用的子段落也是第 3 級，那麼這些子段落將與轉用段落顯示相同的階層，這可能不理想，因此請小心使用。

Replacing Template:Main

How to replace a section for an excerpt.

Sections are often summaries of more precise subpages (generally linked with Template:Main). Sometimes it's convenient to replace the content of such sections for excerpts of the subpages (after merging any valuable content of the section into the subpage). In such cases, 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.

Refinement using inclusion control

Sometimes, a passage will almost fit for a transclusion, but not quite. In these cases, you can edit the source page to add <noinclude>...</noinclude> tags around content you don't want in the excerpt and <includeonly>...</includeonly> tags around content you want only in the excerpt.

For instance, the page COVID-19 misinformation begins The COVID-19 pandemic has resulted in misinformation.... However, when excerpting this lead to the misinformation section of COVID-19 pandemic, we don't need to specify which pandemic we're referring to. Therefore, the code The <noinclude>[[COVID-19 pandemic]]</noinclude><includeonly>pandemic</includeonly> has resulted in [[misinformation]] can be used at the misinformation page, so that it will appear at the pandemic page as The pandemic has resulted in misinformation....

For pages with a high volume of edits, it may be a good idea to leave a hidden comment explaining why the tags are there, so that no one will be tempted to remove them.

Please note that when the </noinclude> tag is wrapped into a new line, a character next to it would be interpreted as a line beginning. This can lead to some formatting problems. For example, when a </noinclude> at line beginning is succeeded by a whitespace character, the page engine would translate this as a leading space that renders the subsequent paragraph in code block and monospaced font with preserved formatting. For this reason, no spaces should separate the </noinclude> tag from the text it precedes.

Compared to #section

For simple cases of transcluding sections of articles, the {{#section}}, {{#section-x}}, and {{#section-h}} (abbreviated {{#lst}}, {{#lstx}}, and {{#lsth}})) parser functions can be used instead of this template. {{#lsth:article|fragmentname}} will transclude the section of "article" with the header "fragmentname", and {{#lsth:article}} will transclude the lead section of "article". Excerpting only specific paragraphs can be done by marking up the source article with <section begin=fragmentname/>...<section end=fragmentname/> tags and using {{#lst:article|fragmentname}} to transclude those fragments, which is equivalent to using the |fragment=fragmentname parameter with this template. {{#lsth:article|fragmentname}} can also be used to transclude everything but those fragments.

The text will not be trimmed of excess whitespace, there will not be a header (equivalent to |hat=no, and all files, templates, tables, references, and subsections will be included unless the source article is marked up with <section begin=fragmentname/>...<section end=fragmentname/>, <noinclude>...</noinclude>, or <onlyinclude>...</onlyinclude> tags. Self links will appear in bold.

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

Here you can navigate the main excerpt trees on the English Wikipedia. It's useful for editors interested in expanding or improving them. To navigate the trees, click the following button^(S):

//zh.wikipedia.org/w/index.php?title=Template:Excerpt/doc&withJS=MediaWiki:ExcerptTree.js#Excerpt_trees

Template data

此模板用于在条目中嵌入指定的另一条目的特定内容。

模板参数
参数		描述	类型	状态
条目	`1` `article` `page`	要纳入的条目名或页面名示例值汉语	页面名称	必需
章节	`2` `section` `fragment`	要纳入的章节名称或<section>标签示例值历史	字符串	可选
仅限	`only`	仅纳入指定的元素类型示例值 table	字符串	可选
段落	`paragraphs` `paragraph`	要纳入的段落示例值 1-3,5	字符串	可选
文件	`files` `file`	要纳入的文件默认值 1 示例值 1-3,5	字符串	可选
表格	`tables` `table`	要纳入的表格示例值 Stats2020	字符串	可选
列表	`lists` `list`	纳入的列表示例值 1	字符串	可选
模板	`templates` `template`	纳入的模板示例值 Infobox person	字符串	可选
参考文献	`references`	是否纳入参考文献示例值 no	布尔	可选
子章节	`subsections`	是否纳入所请求章节的子章节示例值 yes	布尔	可选
Hatnote	`hat`	是否包含hatnote 默认值 yes 示例值 no	布尔	可选
粗体	`bold`	是否保留文字粗体格式默认值 yes 示例值 no	布尔	可选
维基内链	`links`	是否保留内链格式默认值 yes 示例值 no	布尔	可选
冒號列表	`quote`	以冒號列表形式展示此节选默认值 no 示例值 yes	布尔	可选
This	`this`	Change the initial text of the hatnote 示例值 This gallery is	字符串	可选
显示标题	`displaytitle`	Change the text of the link in the hatnote	字符串	可选
内联	`inline`	移除节选中的hatnote和<div>标签，便于放在其他文本之中默认值 no 示例值 yes	布尔	可选
仅自由文件	`onlyfreefiles`	允许纳入非自由文件默认值 no 示例值 yes	布尔	可选
日期简化	`briefdates`	生卒信息简化为YYYY-YYYY格式默认值 no 示例值 yes	布尔	可选
CSS类	`class`	额外CSS类示例值 noprint	字符串	可选

用法