API:Parsing wikitext

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki API documentation.
Language: English  • Deutsch • español • 日本語
MediaWiki API

Quick overview:

v · d · e

These API modules allow calling the parser for preprocessing and rendering.

Retrieving just the raw source wikitext can be done through prop=revisions.

expandtemplates[edit | edit source]

MediaWiki version: = 1.12

Returns preprocessed wikitext (comments stripped, templates expanded, etc.)

Parameters[edit | edit source]

  • text: Wikitext to preprocess
  • title: Act like the wikitext is on the page specified (default: API)
    • This only really matters when parsing links to the page itself or links to subpages, or when using magic words like {{PAGENAME}}.

Example[edit | edit source]

Expand wikitext {{Project:Sandbox}}

api.php?action=expandtemplates&text=%7B%7BProject:Sandbox%7D%7D
Result
The following content has been placed in a collapsed box for improved usability.
<?xml version="1.0" encoding="utf-8"?>
<api>
  <expandtemplates>
{|style=&quot;background:transparent;border:1px dotted #000000;padding:2px;margin:2px;&quot;
|-
|
''Welcome to the '''Wikipedia Sandbox'''! This page allows you to carry out experiments. To edit, click
&lt;span class=&quot;plainlinks&quot;&gt;'''[http://en.wikipedia.org/w/index.php?title=API&amp;action=edit here]'''&lt;/span&gt;
or '''edit this page''' above (or the views section for obscure browsers),
make your changes and click the '''Save page''' button when finished. Content will '''not''' stay permanently;
this page is '''automatically cleaned''' every 12 hours,
although it tends to be overwritten by other testing users much faster than that.''

''Please do not place copyrighted, offensive, or libelous content in the sandbox(es).
If you have any questions regarding [[Wikipedia]], please see [[Wikipedia:Questions]]. Thanks!''

:''This page is a virtual sandbox on Wikipedia. For uses of sandboxes, see the article [[sandbox]].

''You may also use the templates''
&lt;font style=&quot;font-size: 12px;&quot;&gt;
[[Template:X1|X1]], [[Template:X2|X2]], [[Template:X3|X3]], [[Template:X4|X4]], [[Template:X5|X5]],
[[Template:X6|X6]], [[Template:X7|X7]], [[Template:X8|X8]], and [[Template:X9|X9]]&lt;/font&gt;
for experimental purposes.&lt;br /&gt;

''Try other sandboxes:'' &lt;span style=&quot;font-size: 12px;&quot;&gt;
[[Wikipedia:Sandbox|Main Sandbox]] |
[[Wikipedia:Tutorial (Editing)/sandbox|Tutorial Sandbox 1]] |
[[Wikipedia:Tutorial (Formatting)/sandbox|Tutorial Sandbox 2]] |
[[Wikipedia:Tutorial (Wikipedia links)/sandbox|Tutorial Sandbox 3]] |
[[Wikipedia:Tutorial (Related site links)/sandbox|Tutorial Sandbox 4]] |
[[Wikipedia:Tutorial (External links)/sandbox|Tutorial Sandbox 5]]&lt;/span&gt;&lt;br /&gt;
''For a sandbox of your own, [[Wikipedia:User page#How do I create a user subpage?|create a user subpage]].''
|
{|style=&quot;background:transparent;&quot;
|-
|
&lt;table class=&quot;noprint Template-Shortcut&quot;
style=&quot;float:right;margin:.5em 0;border:1px solid #999;background:#fff;padding:3px;&quot;&gt;
&lt;th class=&quot;noprint&quot; align=&quot;center&quot; valign=&quot;top&quot;&gt;
&lt;small&gt;[[Wikipedia:Shortcut|Shortcuts]]:&lt;br /&gt;
[[WP:SB]]&lt;br /&gt;
[[WP:SAND]]&lt;br /&gt;
[[WP:SANDBOX]]&lt;br /&gt;
[[WP:TEST]]&lt;/small&gt;
&lt;/th&gt;
&lt;/table&gt;
|-
|
&lt;div style=&quot;background:#eeeeee;border:1px solid black;padding:5px;font-size:small;text-align:center;white-space:nowrap;&quot;&gt;
More info:&lt;br&gt;
[[Wikipedia:Introduction|Introduction to Wikipedia]]&lt;br&gt;
[[Wikipedia:About the Sandbox|About the Sandbox]]&lt;br&gt;
[[Wikipedia:Tutorial|Editing tutorial]]
&lt;/div&gt;
|}
|}
&lt;/sub&gt;

This is a test</expandtemplates>
</api>
The above content has been placed in a collapsed box for improved usability.

Possible errors[edit | edit source]

None.

parse[edit | edit source]

MediaWiki version: = 1.12

Returns parsed wikitext

Parameters[edit | edit source]

  • disablepp – Disable the PP Report from the parser output. Type: bool
  • oldid – Parse the content of this revision. Overrides page and pageid. Type: string
  • onlypst – Only do a pre-save transform (PST) on the input, don't parse it. Type: bool
    Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used. Type: bool
  • page – Parse the content of this page. Cannot be used together with text and title. Type: string
  • pageid – Parse the content of this page. Overrides page. Type: string
  • prop – Which pieces of information to get. A pipe character | separated list containing one or more of the following options:
    • text – Gives the parsed text of the wikitext.
    • langlinks – Gives the langlinks the parsed wikitext.
    • categories – Gives the categories of the parsed wikitext.
    • categorieshtml – Gives the html version of the categories.
    • languageshtml – Gives the html version of the languagelinks.
    • 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 (TOC, table of contents).
    • revid – If page was used, specify the ID of the revision parsed.
    • displaytitle – Adds the title of the parsed wikitext.
    • headitems – Gives items to put in the <head> of the page.
    • headhtml – Gives parsed <head> of the page.
    • iwlinks – Gives interwiki links in the parsed wikitext.
NOTE: Section tree is only generated if there are more than 4 sections, if the __TOC__ keyword is present, or if sections is explicitly requested and the page contains headings/sub-headings (overrides __NOTOC__).
Type: string
  • pst – Do a pre-save transform (PST) on the input before parsing it (makes {{subst:}} work properly, expands tildes to signatures, etc.). Ignored if page, pageid or oldid is used. Type: bool
  • redirects – If the page parameter is set to a redirect, resolve it. Type: bool
  • section – Only retrieve the content of this section number. Type: string
  • sections – Retrieve the page's TOC (if any exists). Type: string
  • summary – Summary to parse. Type: string
  • text – Wikitext to parse. Type: string
  • title – Act like the wikitext is on this page (default: API). Type: string
    This only really matters when parsing links to the page itself or subpages, or when using magic words like {{PAGENAME}}.
  • uselang – The language code ("en" for English, "fr" for French, etc.) of the language in which the text or the page should be parsed. Type: string
    This is useful for language-dependent content, such as generated by the {{LangSwitch}} template at the Commons, or generally by things dependent on {{int:Lang}}. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.

Example[edit | edit source]

Parse wikitext [[foo]] [[API:Query|bar]] [http://www.example.com/ baz]

api.php?action=parse&text=%5B%5Bfoo%5D%5D%20%5B%5BAPI:Query|bar%5D%5D%20%5Bhttp://www.example.com/%20baz%5D
Result
The following content has been placed in a collapsed box for improved usability. 
<?xml version="1.0" encoding="utf-8"?>
<api>
  <parse>
    <text>&lt;p&gt;&lt;a href=&quot;/wiki/Foo&quot; title=&quot;Foo&quot;&gt;foo&lt;/a&gt; &lt;a href=&quot;/w/index.php?title=API:Query&amp;amp;action=edit&amp;amp;redlink=1&quot; class=&quot;new&quot; title=&quot;API:Query (page does not exist)&quot;&gt;bar&lt;/a&gt; &lt;a href=&quot;http://www.example.com/&quot; class=&quot;external text&quot; title=&quot;http://www.example.com/&quot; rel=&quot;nofollow&quot;&gt;baz&lt;/a&gt;
&lt;/p&gt;</text>
    <langlinks />
    <categories />
    <links>
      <pl ns="0" exists="">Foo</pl>
      <pl ns="0">API:Query</pl>
    </links>
    <templates />
    <images />
    <externallinks>
      <el>http://www.example.com/</el>
    </externallinks>
    <sections />
  </parse>
</api>
The above content has been placed in a collapsed box for improved usability.

Possible errors[edit | edit source]

  • missingrev – There is no revision ID oldid
  • missingtitle – The page you specified doesn't exist
  • nosuchpageid – There is no page with ID $1
  • nosuchsection – There is no section sectionnumber in page
  • params – The page parameter cannot be used together with the text and title parameters
  • permissiondenied – You don't have permission to view deleted revisions
  • readapidenied – You need read permission to use this module

Note: missingtitle is returned only for syntactically invalid page titles (eg. empty). Trying to fetching a missing page will return the rendered HTML of the "page missing" notice, not an error. However, you can check the revid attribute of <param>, which will always be 0 for missing pages.

Retrieved from "http://www.mediawiki.org/w/index.php?title=API:Parsing_wikitext&oldid=759588"