跳至內容

模板:Transclude lead excerpt/doc

維基百科,自由的百科全書

Transclude lead excerpt transcludes the lead of an article as an excerpt. It is designed for use in portals, stand-alone lists and outlines. It returns the text of the named article up to but excluding the first header, after removing:

  • initial templates such as infoboxes, hatnotes and article improvement tags
  • noinclude sections
  • references and footnotes
  • images, unless specifically retained

It is also used to share the lead section between the pages of a multi-page glossary.

Usage

[編輯]
{{Transclude lead excerpt | 1= | paragraphs= | files= | fileargs= | errors= }}

Parameters

[編輯]

The template requires one parameter: the name of the page to be transcluded. Include a namespace where necessary. There are no other positional parameters, but there are some optional named parameters:

  • A list of paragraphs such as paragraphs=1,3-5; the default is all paragraphs.
  • A list of file (image) numbers such as files=1; the default is no images. Non-free images are removed.
  • Arguments to pass to File: such as fileargs=left to move images to the left; the default is none.
  • errors= to allow Lua error messages to appear in the output

paragraphs= and files= each accept a comma-separated list containing numbers and/or number ranges in the format min-max. Alternatively, files= can accept the name of a single image, e.g. files=My image file.jpg.


Miscellaneous options

[編輯]
  • |more=no – to suppress link to the article at the end of the excerpt. |more=custom text to customize the link text at the end of the excerpt. Default is "Full article...".
  • keepSubsections=1 will cause Article#Section to retain any subsections of that section
  • keepRefs=1 will keep references for display in a {{reflist}} or similar
  • nobold=1 will cause bold text to be displayed in normal font

Page options

[編輯]

Each page to be transcluded may be specified either plain or as a wikilink, possibly piped. Links to sections also work, and extract the named section rather than the lead. Examples: Article; Article#Section; [[Article]]; [[Article#Section|A section of an article]]. (Any piped text will be ignored.)

Any of the above formats may be followed by option(s) separated by pipes, e.g. Article|paragraphs=2. Such options override any global options for the given page only. Note that the characters | and = have special meaning within calls to templates but can be escaped using {{!}} and {{=}} respectively. Examples: Article#Section{{!}}files{{=}}2; [[Article|Some page]]{{!}}files{{=}}3,4{{!}}more{{=}}Click here. (= need not be escaped if the parameter is explicitly numbered, e.g. 1=Article{{!}}files=2).

Special characters such as pipes within page options must be doubly escaped, replacing their double braces by {{((}} and {{))}}. For example, to set display Custom image.jpg on the left with a custom caption, set fileargs to left|Custom caption using Article{{!}}files{{=}}Custom image.jpg{{!}}fileargs{{=}}left{{((}}!{{))}}Custom caption. To add a wikilink within a caption, escape the link brackets and any pipe twice using {{!((}}, {{))!}} and possibly {{!}}, e.g. Caption with {{((}}!(({{))}}Pipe (computer science){{((}}!{{))}}piped{{((}}))!{{))}} link. This text can be achieved more simply using {{Doubly escaped wikilink}}, e.g. Caption with {{Doubly escaped wikilink|Pipe (computer science)|piped}} link.

See also

[編輯]

Similar templates also using Module:Excerpt:

The templates were discussed at Use of direct transclusion in portals and the newer portal transclusion templates.

  • {{Excerpt}}: template designed for excerpt transclusion in articles

TemplateData

[編輯]
以下是該模板的模板資料,適用於視覺化編輯器等工具。

Transclude lead excerpt模板資料

Transclude lead excerpt transcludes the lead of an article as an excerpt

模板參數

此模板以參數行內格式為優先。

參數描述類型狀態
11

The name of the page to be transcluded

預設
empty
範例
Aviation, 1=Aviation
字串必填
Paragraphsparagraphs

Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max

預設
all paragraphs
範例
paragraphs=1,3-5
字串非必填
Filesfiles

Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max

預設
no files
範例
files=1,3-5
字串非必填
FileArgsfileargs

Arguments to pass to File:

預設
no arguments
範例
fileargs=left
字串非必填
Moremore

Text for trailing link to the entire article. Note: more= with no value produces the standard text: Read more...

預設
no link
範例
more=(more)
字串非必填
Errorserrors

Allow Lua error messages to appear in the output?

預設
false
範例
errors=true
布林值非必填