MediaWiki API 帮助
这是自动生成的MediaWiki API文档页面。
文档和例子:https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- 此模块需要读取权限。
- 来源:MediaWiki
- 许可协议:GPL-2.0-or-later
解析内容并返回解析器输出。
参见action=query的各种prop-module以从页面的当前版本获得信息。
这里有几种方法可以指定解析的文本:
- 指定一个页面或修订,使用page、pageid或oldid。
- 明确指定内容,使用text、title、revid和contentmodel。
- 只指定一段摘要解析。prop应提供一个空值。
- title
文本属于的页面标题。如果省略,contentmodel就必须被指定,且API将作为标题使用。
- text
要解析的文本。使用title或contentmodel以控制内容模型。
- revid
修订版本ID,用于
{{REVISIONID}}
和类似变体。- 类型:整数
- summary
要解析的摘要。
- page
解析此页的内容。不能与text和title一起使用。
- pageid
解析此页的内容。覆盖page。
- 类型:整数
- redirects
如果page或pageid被设置为一个重定向,则解析它。
- 类型:布尔型 (详情)
- oldid
解析该修订版本的内容。覆盖page和pageid。
- 类型:整数
- prop
要获取的信息束:
- text
- 提供wikitext中的被解析文本。
- langlinks
- 提供被解析的wikitext中的语言链接。
- categories
- 提供被解析的wikitext中的分类。
- categorieshtml
- 提供HTML版本分类。
- links
- 提供被解析的wikitext中的内部链接。
- templates
- 提供被解析的wikitext中的模板。
- images
- 提供被解析的wikitext中的图片。
- externallinks
- 提供被解析的wikitext中的外部链接。
- sections
- 提供被解析的wikitext中的段落。
- revid
- 添加被解析页面的修订ID。
- displaytitle
- 为被解析的wikitext添加标题。
- subtitle
- 为解析的页面添加页面副标题。
- headhtml
- 给出页面的已解析的 doctype、开启的
<html>
、<head>
元素和开启的<body>
。 - modules
- 提供在页面中使用的ResourceLoader模块。要加载,请使用
mw.loader.using()
。无论jsconfigvars还是encodedjsconfigvars都必须与modules共同被请求。 - jsconfigvars
- 针对页面提供JavaScript配置变量。要应用,请使用
mw.config.set()
。 - encodedjsconfigvars
- 针对页面提供JavaScript配置变量为一个JSON字符串。
- indicators
- 提供页面上使用的页面状态指示器的HTML。
- iwlinks
- 提供被解析的wikitext中的跨wiki链接。
- wikitext
- 提供被解析的原始wikitext。
- properties
- 提供多种定义在被解析的wikitext中的属性。
- limitreportdata
- 以结构化的方式提供限制报告。如果disablelimitreport被设定则不提供数据。
- limitreporthtml
- 提供限制报告的HTML版本。当disablelimitreport被设置时不会提供数据。
- parsetree
- 修订内容的XML解析树(需要内容模型
wikitext
) - parsewarnings
- 给出解析内容时发生的警告(作为wikitext)。
- parsewarningshtml
- 给出解析内容时发生的警告(作为 HTML)。
- headitems
- 已弃用。提供项目以插入至页面的
<head>
。
- 值(以|或替代物分隔):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
- 默认:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
要用于包裹解析输出的CSS类。
- 默认:mw-parser-output
- pst
在解析输入前,对输入做一次保存前变换处理。仅当使用文本时有效。
- 类型:布尔型 (详情)
- onlypst
在输入内容中执行预保存转换(PST),但不解析它。在PST被应用后返回相同的wikitext。只当与text一起使用时有效。
- 类型:布尔型 (详情)
- effectivelanglinks
- 已弃用。
包含由扩展提供的语言链接(用于与prop=langlinks一起使用)。
- 类型:布尔型 (详情)
- section
只解析此标识符对应章节的内容。
当new时,将text和sectiontitle解析为添加新章节至页面。
new章节只当指定text时允许。
- sectiontitle
当section为new时新段落标题。
不像页面编辑,当省略或为空时将不会备选为summary。
- disablepp
- 已弃用。
请改用disablelimitreport。
- 类型:布尔型 (详情)
- disablelimitreport
从解析器输出中省略限制报告(“NewPP limit report”)。
- 类型:布尔型 (详情)
- disableeditsection
从解析器输出中省略编辑段落链接。
- 类型:布尔型 (详情)
- disablestylededuplication
不要在解析器输出中删除重复的行内样式表。
- 类型:布尔型 (详情)
- showstrategykeys
是否在jsconfigvars中包含内部合并策略信息。
- 类型:布尔型 (详情)
- generatexml
- 已弃用。
生成XML解析树(需要内容模型
wikitext
;被prop=parsetree所取代)。- 类型:布尔型 (详情)
- preview
在预览模式下解析。
- 类型:布尔型 (详情)
- sectionpreview
在段落预览模式下解析(同时要启用预览模式)。
- 类型:布尔型 (详情)
- disabletoc
在输出中省略目录。
- 类型:布尔型 (详情)
- useskin
为解析器输出应用选择的皮肤。会影响以下属性:text、langlinks、headitems、modules、jsconfigvars和indicators。
- 以下值中的一个:apioutput、citizen、fallback、vector、vector-2022
- contentformat
用于输入文本的内容序列化格式。只当与text一起使用时有效。
- 以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown
- contentmodel
输入文本的内容模型。如果省略,title必须指定,并且默认将为指定标题的模型。只当与text一起使用时有效。
- 以下值中的一个:Campaign、GadgetDefinition、JsonSchema、MassMessageListContent、Scribunto、css、javascript、json、sanitized-css、smw/schema、text、unknown、wikitext
- templatesandboxprefix
模板沙盒前缀,与Special:TemplateSandbox一样。
- 通过|或替代物隔开各值。
- 值的最大值为50(允许更高上限的客户端为500)。
- templatesandboxtitle
解析使用templatesandboxtext代替此处命名的页面内容的页面。
- templatesandboxtext
解析使用此页面内容代替由templatesandboxtitle命名页面的页面。
- templatesandboxcontentmodel
templatesandboxtext的内容模型。
- 以下值中的一个:Campaign、GadgetDefinition、JsonSchema、MassMessageListContent、Scribunto、css、javascript、json、sanitized-css、smw/schema、text、unknown、wikitext
- templatesandboxcontentformat
templatesandboxtext的内容格式。
- 以下值中的一个:application/json、application/octet-stream、application/unknown、application/x-binary、text/css、text/javascript、text/plain、text/unknown、text/x-wiki、unknown/unknown