MediaWiki API 說明
此頁為自動產生的 MediaWiki API 說明文件頁面。
說明文件與範例:https://www.mediawiki.org/wiki/API
action=parse
(main | parse)
- 此模組需要讀取權限。
- 来源:MediaWiki
- 许可协议:GPL-2.0+
解析内容并返回解析器输出。
参见action=query的各种prop-module以从页面的当前版本获得信息。
这里有几种方法可以指定解析的文本:
- 指定一个页面或修订,使用page、pageid或oldid。
- 明确指定内容,使用text、title和contentmodel。
- 只指定一段摘要解析。prop应提供一个空值。
- title
文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。
- text
要解析的文本。使用title或contentmodel以控制内容模型。
- revid
Revision ID, for
{{REVISIONID}}
and similar variables.- 类型:整数
- summary
要解析的摘要。
- page
解析此页的内容。不能与text和title一起使用。
- pageid
解析此页的内容。覆盖page。
- 类型:整数
- redirects
如果page或pageid被设置为一个重定向,则解析它。
- 类型:布尔值(详细信息)
- oldid
解析该修订版本的内容。覆盖page和pageid。
- 类型:整数
- 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>
。
- 多值 (以 | 或 alternative 分隔):text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headhtml、modules、jsconfigvars、encodedjsconfigvars、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml、parsetree、parsewarnings、headitems
- 預設值:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
要用于包裹解析输出的CSS类。
- 預設值:mw-parser-output
- pst
在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。
- 类型:布尔值(详细信息)
- onlypst
在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wiki文本。只当与text一起使用时有效。
- 类型:布尔值(详细信息)
- effectivelanglinks
- 已停用。
包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。
- 类型:布尔值(详细信息)
- section
只解析此段数的内容。
当new时,将text和sectiontitle解析为添加新段落至页面。
new段落只当指定text时允许。
- sectiontitle
当section为new时新段落标题。
不像页面编辑,当省略或为空时将不会备选为summary。
- disablepp
- 已停用。
请改用disablelimitreport。
- 类型:布尔值(详细信息)
- disablelimitreport
从解析器输出中省略限制报告(“NewPP limit report”)。
- 类型:布尔值(详细信息)
- disableeditsection
从解析器输出中省略编辑段落链接。
- 类型:布尔值(详细信息)
- disabletidy
不要在解析器输出中运行HTML清理(例如tidy)。
- 类型:布尔值(详细信息)
- generatexml
- 已停用。
生成XML解析树(需要内容模型
wikitext
;被prop=parsetree所取代)。- 类型:布尔值(详细信息)
- preview
在预览模式下解析。
- 类型:布尔值(详细信息)
- sectionpreview
在段落预览模式下解析(同时要启用预览模式)。
- 类型:布尔值(详细信息)
- disabletoc
在输出中省略目录。
- 类型:布尔值(详细信息)
- useskin
为解析器输出应用选择的皮肤。会影响以下属性:langlinks、headitems、modules、jsconfigvars和indicators。
- 單值:cologneblue、modern、monobook、vector
- contentformat
用于输入文本的内容序列化格式。只当与text一起使用时有效。
- 單值:application/json、text/x-wiki、text/javascript、text/css、text/plain
- contentmodel
输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。
- 單值:GadgetDefinition、wikitext、javascript、json、css、text