MediaWiki API 帮助

这是自动生成的MediaWiki API文档页面。

文档和例子:-{R|https://www.mediawiki.org/wiki/API:Main_page/zh}-

action=parse

main | parse

解析内容并返回解析器输出。

参见action=query的各种prop-module以从页面的当前版本获得信息。

这里有几种方法可以指定解析的文本:

  1. 指定一个页面或修订,使用pagepageidoldid
  2. 明确指定内容,使用texttitlerevidcontentmodel
  3. 只指定一段摘要解析。prop应提供一个空值。
参数:
title

文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。

text

要解析的文本。使用titlecontentmodel以控制内容模型。

revid

修订版本ID,用于{{REVISIONID}}和类似变体。

Type: integer
summary

要解析的摘要。

page

解析此页的内容。不能与texttitle一起使用。

pageid

解析此页的内容。覆盖page

Type: integer
redirects

如果pagepageid被设置为一个重定向,则解析它。

Type: boolean (details)
oldid

解析该修订版本的内容。覆盖pagepageid

Type: integer
prop

要获取的信息束:

text
提供wiki文本中的被解析文本。
langlinks
提供被解析的wiki文本中的语言链接。
categories
提供被解析的wiki文本中的分类。
categorieshtml
提供HTML版本分类。
links
提供被解析的wiki文本中的内部链接。
templates
提供被解析的wiki文本中的模板。
images
提供被解析的wiki文本中的图片。
externallinks
提供被解析的wiki文本中的外部链接。
sections
提供被解析的wiki文本中的段落。
revid
添加被解析页面的修订ID。
displaytitle
为被解析的wiki文本添加标题。
headhtml
提供页面的被解析<head>
modules
提供在页面中使用的ResourceLoader模块。要加载,请使用mw.loader.using()。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。
jsconfigvars
针对页面提供JavaScript配置变量。要应用,请使用mw.config.set()
encodedjsconfigvars
针对页面提供JavaScript配置变量为一个JSON字符串。
indicators
提供页面上使用的页面状态指示器的HTML。
iwlinks
提供被解析的wiki文本中的跨wiki链接。
wikitext
提供被解析的原始wiki文本。
properties
提供多种定义在被解析的wiki文本中的属性。
limitreportdata
以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
limitreporthtml
提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
parsetree
修订内容的XML解析树(需要内容模型wikitext
parsewarnings
在解析内容时提供发生的警告
headitems
已弃用。提供项目以插入至页面的<head>
值(以|替代物分隔):categories、categorieshtml、displaytitle、encodedjsconfigvars、externallinks、headhtml、images、indicators、iwlinks、jsconfigvars、langlinks、limitreportdata、limitreporthtml、links、modules、parsetree、parsewarnings、properties、revid、sections、templates、text、wikitext、headitems
Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

要用于包裹解析输出的CSS类。

Default: mw-parser-output
pst

在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。

Type: boolean (details)
onlypst

在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wiki文本。只当与text一起使用时有效。

Type: boolean (details)
effectivelanglinks
已弃用。

包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。

Type: boolean (details)
section

只解析此段数的内容。

new时,将textsectiontitle解析为添加新段落至页面。

new段落只当指定text时允许。

sectiontitle

sectionnew时新段落标题。

不像页面编辑,当省略或为空时将不会备选为summary

disablepp
已弃用。

请改用disablelimitreport

Type: boolean (details)
disablelimitreport

从解析器输出中省略限制报告(“NewPP limit report”)。

Type: boolean (details)
disableeditsection

从解析器输出中省略编辑段落链接。

Type: boolean (details)
disablestylededuplication

不要在解析器输出中删除重复的行内样式表。

Type: boolean (details)
generatexml
已弃用。

生成XML解析树(需要内容模型wikitext;被prop=parsetree所取代)。

Type: boolean (details)
preview

在预览模式下解析。

Type: boolean (details)
sectionpreview

在段落预览模式下解析(同时要启用预览模式)。

Type: boolean (details)
disabletoc

在输出中省略目录。

Type: boolean (details)
useskin

为解析器输出应用选择的皮肤。会影响以下属性:langlinksheaditemsmodulesjsconfigvarsindicators

以下值中的一个:chameleon、monobook、timeless、vector
contentformat

用于输入文本的内容序列化格式。只当与text一起使用时有效。

以下值中的一个:application/json、text/css、text/javascript、text/plain、text/x-wiki
contentmodel

输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。

以下值中的一个:css、javascript、json、text、wikitext