قالب:Transclude linked excerpt/sandbox

Template documentation[view] [edit] [history] [purge]

Transclude linked excerpt transcludes the lead of an article as an excerpt. It is designed for use in portals. It returns the text of an 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

Usage

{{Transclude linked excerpt | 1= | section= | sectiononly= | paragraphs= | files= | fileargs= | errors= }}

Parameters

The template accepts one page name as an unnamed parameter. Wikilinks are collected from that page, or a section of it. One wikilink is selected randomly, and its destination is transcluded. (If the selected page is invalid, the template will choose again.) Include a namespace where necessary. There are no other positional parameters, but there are some optional named parameters:

  • A section name such as section=Featured articles; the default is to collect wikilinks from all sections.
    • A flag sectiononly=yes to exclude subsections.
  • 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
  • showall= to show all articles simultaneously
  • list= to show a list of articles قالب:Warnsign

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.

showall= shows all articles simultaneously. This option is intended for a subpage aimed at editors as well as readers. Using this template on a subpage with <noinclude>|showall=</noinclude> and transcluding the subpage on a main page will show all excerpts on the subpage but only one on the main page, without repeating the template and its arguments.


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

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

This is the بيانات القالب documentation for this template used by المحرر المرئي وأدوات أخرى.

See the monthly error report for this template.

TemplateData for Transclude linked excerpt

Transclude linked excerpt transcludes the lead of a randomly chosen article as an excerpt

وسائط القالب

هذا القالب يفضل التنسيق بنفس السطر للوسائط.

وسيطوصفنوعحالة
11

The name of a page containing wikilinks to articles which may be transcluded

غيابي
empty
مثال
Aviation, 1=Aviation
نصمطلوب
sectionsection

Limits wikilink collection to one section of the page

غيابي
empty
مثال
section=Featured articles
نصاختياري
sectiononlysectiononly

Excludes subsections of the selected section

غيابي
false
مثال
sectiononly=yes
بوليانياختياري
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
بوليانياختياري
ShowAllshowall

Show all excerpts simultaneously?

غيابي
no arguments
مثال
showall={{clear}}{{hr}}
نصاختياري
Listlist

Show a list of excerpts?

غيابي
no list
مثال
list=List of articles
نصاختياري