Template:Transclude list item excerpt/doc

Template page

Transclude list item 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 list item excerpt | 1= | section= | sectiononly= | paragraphs= | files= | fileargs= | errors= }}

Parameters

The template accepts one page name as an unnamed parameter. Wikilinked list items are collected from that page, or a section of it. One such item 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 red-outlined triangle containing exclamation point Coding not compatible with mobile versions of OODA WIKI causing display and accessibility problems

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. {{#section:Template:Transclude lead excerpt/doc|Miscellaneous options}}

Page options

{{#section-h:Template:Transclude lead excerpt/doc|Page options}}

See also

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Transclude list item excerpt

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11

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

Default
empty
Example
Outline of forestry, 1=Outline of forestry
Stringrequired
sectionsection

Limits wikilink collection to one section of the page

Default
empty
Example
section=Harvesting
Stringoptional
sectiononlysectiononly

Excludes subsections of the selected section

Default
false
Example
sectiononly=yes
Booleanoptional
Paragraphsparagraphs

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

Default
all paragraphs
Example
paragraphs=1,3-5
Stringoptional
Filesfiles

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

Default
no files
Example
files=1,3-5
Stringoptional
FileArgsfileargs

Arguments to pass to File:

Default
no arguments
Example
fileargs=left
Stringoptional
Moremore

Text for trailing link to the entire article. Note: more=no suppresses the link.

Default
no link
Example
more=(more)
Stringoptional
Errorserrors

Allow Lua error messages to appear in the output?

Default
false
Example
errors=true
Booleanoptional
ShowAllshowall

Show all excerpts simultaneously?

Default
no arguments
Example
showall={{clear}}{{hr}}
Stringoptional
Listlist

Show a list of excerpts?

Default
no list
Example
list=List of articles
Stringoptional