User:Pineappled sun/Sandbox/API:Expandtemplates

From mediawiki.org
MediaWiki version:
1.12

GET request to expand all templates in the wikitext.

API documentation[edit]


action=expandtemplates

(main | expandtemplates)

Expands all templates within wikitext.

Specific parameters:
Other general parameters are available.
title

Title of the page.

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): categories, encodedjsconfigvars, jsconfigvars, modules, parsetree, properties, ttl, volatile, wikitext
includecomments

Whether to include HTML comments in the output.

Type: boolean (details)
showstrategykeys

Whether to include internal merge strategy information in jsconfigvars.

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 clients that are allowed higher limits).
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, Json.JsonConfig, JsonSchema, Map.JsonConfig, MassMessageListContent, NewsletterContent, Scribunto, SecurePoll, Tabular.JsonConfig, css, flow-board, javascript, json, sanitized-css, text, translate-messagebundle, unknown, wikitext
templatesandboxcontentformat

Content format of templatesandboxtext.

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

Example[edit]

Expand the Project:Sandbox template.

GET request[edit]


Response[edit]

Response
{
    "expandtemplates": {
        "wikitext": "\n<table class=\"plainlinks ombox ombox-notice\" role=\"presentation\" style=\"margin:auto;\"><tr><td class=\"mbox-image\">[[File:Sandbox.png|75px|alt=|link=]]</td><td class=\"mbox-text\">Welcome to this [[Wikipedia:About the Sandbox|sandbox page]]. Sandbox pages provide space to experiment with the process of editing Wikipedia pages.<br/>To edit this sandbox, click <span class=\"plainlinks\">'''[//en.wikipedia.org/w/index.php?title=API&action=edit here]'''</span> or the \"Edit\" tab along the top of this page. Then make your changes, and click the \"'''Save page'''\" button when finished. You can click \"'''Show preview'''\" to see a preview of what you are about to save.<br/>If you would like [//en.wikipedia.org/w/index.php?title=Wikipedia:Sandbox&action=edit&oldid=596189391 to start editing a clear sandbox, click here].\n\nAn automated process clears this page regularly, and many other users also use this sandbox for their tests, so anything you place here will '''''not''''' remain indefinitely.\nTo try [[Wikipedia:VisualEditor|VisualEditor]], visit [//en.wikipedia.org/wiki/User:Sandbox?veaction=edit User:Sandbox] or [[mw:VisualEditor:Test]].\n\nPlease [[Wikipedia:Misuse of the sandbox|do not place copyrighted, offensive or libelous content]] in sandboxes.\n\nIf you have registered an account and are logged in, you can [//en.wikipedia.org/w/index.php?title=Special:Mypage/sandbox&action=edit&preload=Template:User_Sandbox/preload find or create your own user sandbox here]. To access your personal sandbox more easily in future, click the \"Sandbox\" link at the very top of the page (next to your user name).\n\n:''For information and resources on the basics needed to comprehend, comment on, and contribute to Wikipedia see, [[Wikipedia:Contributing to Wikipedia|Contributing to Wikipedia]]''.</td></tr></table>\n\n# \n# Numbered list item\n# \n# Numbered list item\n# \n* Numbered list item\n* \n* Bulleted list item<br />\n<br />\n<big><br />\nBig text</big><br />\n'''''Bold text''''''Italic text'''''''\n\nHow do you add bulleted list items underneath a numbered list item?"
    }
}

Possible errors[edit]

Code Info
revwrongpage rREVID is not a revision of title.

See also[edit]