API:Expandtemplates

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki action API documentation.
MediaWiki APIsAPI:Main page

MediaWiki action API

v · d · e


This module expands all templates in the wikitext.

Parameters[edit]

  • text: Wikitext to convert. Type: string
  • title: Title of page. (Default: API)
  • revid: Revision ID, for {{REVISIONID}} and similar variables. Type: integer 1.25+
  • prop: Which pieces of information to get. Note: if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format. 1.24+
    • wikitext: The expanded wikitext.
    • categories: Any categories present in the input that are not represented in the wikitext output.
    • properties: Page properties defined by expanded magic words in the wikitext. 1.25+
    • volatile: Whether the output is volatile and should not be reused elsewhere within the page.
    • ttl: The maximum time after which caches of the result should be invalidated.
    • modules: Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules. 1.26+
    • jsconfigvars: Gives the JavaScript configuration variables specific to the page. 1.26+
    • encodedjsconfigvars: Gives the JavaScript configuration variables specific to the page as a JSON string. 1.26+
    • parsetree: The XML parse tree of the input.
  • includecomments: Whether to include HTML comments in the output. Type: bool 1.18+
  • generatexml: Generate XML parse tree (replaced by prop=parsetree) Type: bool 1.13+ (deprecated in 1.24)

Error Codes[edit]

In addition to the usual stuff:

Code Info
missingrev There is no revision ID revid

Example[edit]

Expand the Project:Sandbox template.

See also[edit]

action=expandtemplates

(main | expandtemplates)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Expands all templates within wikitext.

Parameters:
title

Title of page.

Default: API
text

Wikitext to convert.

This parameter is required.
revid

Revision ID, for {{REVISIONID}} and similar variables.

Type: integer
prop

Which pieces of information to get.

Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.

wikitext
The expanded wikitext.
categories
Any categories present in the input that are not represented in the wikitext output.
properties
Page properties defined by expanded magic words in the wikitext.
volatile
Whether the output is volatile and should not be reused elsewhere within the page.
ttl
The maximum time after which caches of the result should be invalidated.
modules
Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
parsetree
The XML parse tree of the input.
Values (separate with | or alternative): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
includecomments

Whether to include HTML comments in the output.

Type: boolean (details)
generatexml
Deprecated.

Generate XML parse tree (replaced by prop=parsetree).

Type: boolean (details)
templatesandboxprefix

Template sandbox prefix, as with Special:TemplateSandbox.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
templatesandboxtitle

Parse the page using templatesandboxtext in place of the contents of the page named here.

templatesandboxtext

Parse the page using this page content in place of the page named by templatesandboxtitle.

templatesandboxcontentmodel

Content model of templatesandboxtext.

One of the following values: GadgetDefinition, SecurePoll, MassMessageListContent, JsonSchema, wikitext, javascript, json, css, text, flow-board, Scribunto
templatesandboxcontentformat

Content format of templatesandboxtext.

One of the following values: application/json, text/x-wiki, text/javascript, text/css, text/plain
Example:
Expand the wikitext {{Project:Sandbox}}.
api.php?action=expandtemplates&text={{Project:Sandbox}} [open in sandbox]