MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- This module requires read rights.
- Source: MediaWiki
- Licence: GPL-2.0-or-later
Parses content and returns parser output.
See the various prop-modules of action=query to get information from the current version of a page.
There are several ways to specify the text to parse:
- Specify a page or revision, using page, pageid, or oldid.
- Specify content explicitly, using text, title, revid, and contentmodel.
- Specify only a summary to parse. prop should be given an empty value.
- title
Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.
- text
Text to parse. Use title or contentmodel to control the content model.
- revid
Revision ID, for
{{REVISIONID}}and similar variables.- Type: integer
- summary
Summary to parse.
- page
Parse the content of this page. Cannot be used together with text and title.
- pageid
Parse the content of this page. Overrides page.
- Type: integer
- redirects
If page or pageid is set to a redirect, resolve it.
- Type: boolean (details)
- oldid
Parse the content of this revision. Overrides page and pageid.
- Type: integer
- prop
Which pieces of information to get:
- text
- Gives the parsed text of the wikitext.
- langlinks
- Gives the language links in the parsed wikitext.
- categories
- Gives the categories in the parsed wikitext.
- categorieshtml
- Gives the HTML version of the categories.
- links
- Gives the internal links in the parsed wikitext.
- templates
- Gives the templates in the parsed wikitext.
- images
- Gives the images in the parsed wikitext.
- externallinks
- Gives the external links in the parsed wikitext.
- sections
- Gives the sections in the parsed wikitext.
- revid
- Adds the revision ID of the parsed page.
- displaytitle
- Adds the title of the parsed wikitext.
- subtitle
- Adds the page subtitle for the parsed page.
- headhtml
- Gives parsed doctype, opening
<html>,<head>element and opening<body>of the page. - modules
- Gives the ResourceLoader modules used on the page. To load, use
mw.loader.using(). Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules. - jsconfigvars
- Gives the JavaScript configuration variables specific to the page. To apply, use
mw.config.set(). - encodedjsconfigvars
- Gives the JavaScript configuration variables specific to the page as a JSON string.
- indicators
- Gives the HTML of page status indicators used on the page.
- iwlinks
- Gives interwiki links in the parsed wikitext.
- wikitext
- Gives the original wikitext that was parsed.
- properties
- Gives various properties defined in the parsed wikitext.
- limitreportdata
- Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.
- limitreporthtml
- Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
- parsetree
- The XML parse tree of revision content (requires content model
wikitext) - parsewarnings
- Gives the warnings that occurred while parsing content (as wikitext).
- parsewarningshtml
- Gives the warnings that occurred while parsing content (as HTML).
- headitems
- Deprecated. Gives items to put in the
<head>of the page.
- Values (separate with | or alternative): categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, parsewarningshtml, properties, revid, sections, subtitle, templates, text, wikitext, headitems
- Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
CSS class to use to wrap the parser output.
- Default: mw-parser-output
- pst
Do a pre-save transform on the input before parsing it. Only valid when used with text.
- Type: boolean (details)
- onlypst
Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.
- Type: boolean (details)
- effectivelanglinks
- Deprecated.
Includes language links supplied by extensions (for use with prop=langlinks).
- Type: boolean (details)
- section
Only parse the content of the section with this identifier.
When new, parse text and sectiontitle as if adding a new section to the page.
new is allowed only when specifying text.
- sectiontitle
New section title when section is new.
Unlike page editing, this does not fall back to summary when omitted or empty.
- disablepp
- Deprecated.
Use disablelimitreport instead.
- Type: boolean (details)
- disablelimitreport
Omit the limit report ("NewPP limit report") from the parser output.
- Type: boolean (details)
- disableeditsection
Omit edit section links from the parser output.
- Type: boolean (details)
- disablestylededuplication
Do not deduplicate inline stylesheets in the parser output.
- Type: boolean (details)
- showstrategykeys
Whether to include internal merge strategy information in jsconfigvars.
- Type: boolean (details)
- generatexml
- Deprecated.
Generate XML parse tree (requires content model
wikitext; replaced by prop=parsetree).- Type: boolean (details)
- preview
Parse in preview mode.
- Type: boolean (details)
- sectionpreview
Parse in section preview mode (enables preview mode too).
- Type: boolean (details)
- disabletoc
Omit table of contents in output.
- Type: boolean (details)
- useskin
Apply the selected skin to the parser output. May affect the following properties: text, langlinks, headitems, modules, jsconfigvars, indicators.
- One of the following values: apioutput, citizen, fallback
- contentformat
Content serialisation format used for the input text. Only valid when used with text.
- 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
- contentmodel
Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.
- One of the following values: Scribunto, css, javascript, json, sanitized-css, text, unknown, wikitext
- Parse a page.
- api.php?action=parse&page=Project:Sandbox [open in sandbox]
- Parse wikitext.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [open in sandbox]
- Parse wikitext, specifying the page title.
- api.php?action=parse&text={{PAGENAME}}&title=Test [open in sandbox]
- Parse a summary.
- api.php?action=parse&summary=Some+[[link]]&prop= [open in sandbox]