MediaWiki API 帮助
这是一个自动生成的 MediaWiki API 文档页面。
文档和示例: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- 此模块需要读取权限。
- 来源: MediaWiki
- 许可:
解析内容并返回解析器输出。
请查看 action=query 的各种 prop-modules,以获取页面当前版本的信息。
有几种方法可以指定要解析的文本
- 使用 page、pageid 或 oldid 指定页面或修订版本。
- 使用 text、title、revid 和 contentmodel 显式指定内容。
- 仅指定要解析的摘要。prop 应给定一个空值。
- title
文本所属页面的标题。 如果省略,则必须指定 contentmodel,并且 将用作标题。
- text
要解析的文本。 使用 title 或 contentmodel 来控制内容模型。
- revid
修订ID,用于
{{REVISIONID}}及类似变量。- 类型:integer
- summary
要解析的摘要。
- page
解析此页面的内容。 不能与 text 和 title 一起使用。
- pageid
解析此页面的内容。 覆盖 page。
- 类型:integer
- redirects
如果 page 或 pageid 设置为重定向,则解析它。
- 类型:布尔值(详情)
- oldid
解析此修订版本的内容。 覆盖 page 和 pageid。
- 类型:integer
- prop
要获取哪些信息
- text
- 给出维基文本的解析文本。
- langlinks
- 给出已解析维基文本中的语言链接。
- categories
- 给出已解析维基文本中的分类。
- categorieshtml
- 给出分类的 HTML 版本。
- links
- 给出已解析维基文本中的内部链接。
- templates
- 给出已解析维基文本中的模板。
- images
- 给出已解析维基文本中的图像。
- externallinks
- 给出已解析维基文本中的外部链接。
- sections
- 已弃用。给出已解析维基文本中的章节。
- tocdata
- 给出已解析维基文本中的目录信息。
- revid
- 添加已解析页面的修订 ID。
- displaytitle
- 添加已解析维基文本的标题。
- subtitle
- 添加已解析页面的页面副标题。
- headhtml
- 给出解析的文档类型、opening
<html>、<head>元素和页面的 opening<body>。 - modules
- 给出页面上使用的 ResourceLoader 模块。 要加载,请使用
mw.loader.using()。 jsconfigvars 或 encodedjsconfigvars 必须与 modules 一起请求。 - jsconfigvars
- 给出特定于页面的 JavaScript 配置变量。 要应用,请使用
mw.config.set()。 - encodedjsconfigvars
- 以JSON字符串形式提供特定于页面的JavaScript配置变量。
- indicators
- 给出页面上使用的页面状态指示器的 HTML。
- iwlinks
- 给出已解析维基文本中的跨维基链接。
- wikitext
- 给出已解析的原始维基文本。
- properties
- 给出已解析维基文本中定义的各种属性。
- limitreportdata
- 以结构化方式给出限制报告。 当设置 disablelimitreport 时,不提供任何数据。
- limitreporthtml
- 给出限制报告的 HTML 版本。 当设置 disablelimitreport 时,不提供任何数据。
- parsetree
- 修订版本内容的 XML 解析树(需要内容模型
wikitext) - parsewarnings
- 给出解析内容(作为维基文本)时发生的警告。
- parsewarningshtml
- 给出解析内容(作为 HTML)时发生的警告。
- headitems
- 已弃用。 给出要放在页面的
<head>中的项目。
- 值(用 | 或 替代 分隔):categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, parsewarningshtml, properties, revid, subtitle, templates, text, tocdata, wikitext, headitems, sections
- 默认值:text|langlinks|categories|links|templates|images|externallinks|sections|tocdata|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
用于包装解析器输出的 CSS 类。
- 默认值:mw-parser-output
- usearticle
使用 ArticleParserOptions 钩子以确保使用的选项与用于文章页面视图的选项匹配
- 类型:布尔值(详情)
- parsoid
- 已弃用。
使用 Parsoid 生成符合 MediaWiki DOM 规范的 HTML。 已被 parser=parsoid 替换。
- 类型:布尔值(详情)
- parser
使用哪个维基文本解析器。
- parsoid
- 使用 Parsoid 生成符合 MediaWiki DOM 规范的 HTML。
- default
- 使用此维基的默认解析器生成 HTML。
- legacy
- 使用旧版解析器生成 HTML。
- 以下值之一:default, legacy, parsoid
- 默认:default
- pst
在解析输入之前对其进行预保存转换。 仅在使用文本时有效。
- 类型:布尔值(详情)
- onlypst
对输入执行预保存转换 (PST),但不解析它。 返回在应用 PST 之后相同的维基文本。 仅在使用 text 时有效。
- 类型:布尔值(详情)
- effectivelanglinks
- 已弃用。
包括扩展程序提供的语言链接(用于 prop=langlinks)。
- 类型:布尔值(详情)
- section
仅解析具有此标识符的章节的内容。
当 new 时,解析 text 和 sectiontitle,就像将新章节添加到页面一样。
仅当指定 text 时才允许使用 new。
- sectiontitle
当 section 为 new 时的新的章节标题。
与页面编辑不同,当省略或为空时,它不会回退到 summary。
- disablepp
- 已弃用。
请改用 disablelimitreport。
- 类型:布尔值(详情)
- disablelimitreport
从解析器输出中省略限制报告(“NewPP 限制报告”)。
- 类型:布尔值(详情)
- disableeditsection
从解析器输出中省略编辑章节链接。
- 类型:布尔值(详情)
- disablestylededuplication
不要在解析器输出中删除内联样式表的重复项。
- 类型:布尔值(详情)
- showstrategykeys
是否在jsconfigvars中包含内部合并策略信息。
- 类型:布尔值(详情)
- generatexml
- 已弃用。
生成 XML 解析树(需要内容模型
wikitext;已被 prop=parsetree 替换)。- 类型:布尔值(详情)
- preview
在预览模式下解析。
- 类型:布尔值(详情)
- sectionpreview
在章节预览模式下解析(也启用预览模式)。
- 类型:布尔值(详情)
- disabletoc
在输出中省略目录。
- 类型:布尔值(详情)
- useskin
将选定的皮肤应用于解析器输出。可能会影响以下属性:text、langlinks、headitems、modules、jsconfigvars、indicators。
- 以下值之一:apioutput, authentication-popup, cologneblue, fallback, json, minerva, modern, monobook, timeless, vector, vector-2022
- contentformat
用于输入文本的内容序列化格式。 仅在使用文本时有效。
- 以下值之一:application/json, application/octet-stream, application/unknown, application/vue+xml, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- contentmodel
输入文本的内容模型。 如果省略,则必须指定标题,默认值将是指定标题的模型。 仅在使用文本时有效。
- 以下值之一:GadgetDefinition, Graph.JsonConfig, Json.JsonConfig, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, vue, wikitext
- mobileformat
以适合移动设备使用的格式返回解析输出。
- 类型:布尔值(详情)
- templatesandboxprefix
模板沙盒前缀,如同。
- 用 | 或 其他方式分隔值。
- 最多值数量为 50(对于允许更高限制的客户端为 500)。
- templatesandboxtitle
解析页面时,将templatesandboxtext替换此处命名的页面内容。
- templatesandboxtext
解析页面时,将此页面内容替换templatesandboxtitle命名的页面内容。
- templatesandboxcontentmodel
templatesandboxtext的内容模型。
- 以下值之一:GadgetDefinition, Graph.JsonConfig, Json.JsonConfig, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, vue, wikitext
- templatesandboxcontentformat
templatesandboxtext的内容格式。
- 以下值之一:application/json, application/octet-stream, application/unknown, application/vue+xml, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown