Template:Transclude random excerpt/doc

From The League Wiki
Jump to navigation Jump to search

Transclude random 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 random excerpt | 1= | 2= | paragraphs= | files= | fileargs= | more= | errors= }}

The template accepts any number of page names as unnamed parameters. One of them is selected randomly, and the page with that title 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 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.
  • A link to the article itself such as more=(more); the default is no link. Short cut: more= produces Read more...
  • errors= to allow Lua error messages to appear in the output
  • showall= to show all articles simultaneously
  • list= to show a list of articles

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

{{#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 based on this TemplateData.

TemplateData for Transclude random excerpt

<templatedata> { "description": "Transclude random excerpt transcludes the lead of a randomly chosen article as an excerpt", "params": { "1": { "label": "1", "description": "The name of a page which may be transcluded", "type": "string", "required": true, "example": "Aviation, 1=Aviation", "default": "empty" }, "2": { "label": "2", "description": "The name of another page which may be transcluded. Similarly for optional parameters 3, 4, ...", "type": "string", "required": false, "example": "Egypt, 2=Egypt", "default": "empty" }, "paragraphs": { "label": "Paragraphs", "description": "Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max", "type": "string", "required": false, "example": "paragraphs=1,3-5", "default": "all paragraphs" }, "files": { "label": "Files", "description": "Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max", "type": "string", "required": false, "example": "files=1,3-5", "default": "no files" }, "fileargs": { "label": "FileArgs", "description": "Arguments to pass to File:", "type": "string", "required": false, "example": "fileargs=left", "default": "no arguments" }, "more": { "label": "More", "description": "Text for trailing link to the entire article. Note: more= with no value produces the standard text: Read more...", "type": "string", "required": false, "example": "more=(more)", "default": "no link" }, "errors": { "label": "Errors", "description": "Allow Lua error messages to appear in the output?", "type": "boolean", "required": false, "example": "errors=true", "default": "false" }, "showall": { "label": "ShowAll", "description": "Show all excerpts simultaneously?", "type": "string", "required": false,

"example": "showall=

",

"default": "no arguments" }, "list": { "label": "List", "description": "Show a list of excerpts?", "type": "string", "required": false, "example": "list=List of articles", "default": "no list" } }, "format": "inline" } </templatedata>


Retrieved from "https://lcnwiki.xyz/index.php?title=Template:Transclude_random_excerpt/doc&oldid=1927"