MediaWiki API 說明

此頁為自動產生的 MediaWiki API 說明文件頁面。

說明文件與範例:https://www.mediawiki.org/wiki/API

action=parse

main | parse

解析內容併回傳解析器輸出。

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

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

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

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

text

要解析的文字。使用 titlecontentmodel 來控制內容模組。

revid

修訂 ID,用於 {{REVISIONID}} 和相似變數。

類型:整數
summary

解析摘要。

page

解析此頁面的內容。不能與 texttitle 一起使用。

pageid

解析此頁面的內容。覆蓋 page

類型:整數
redirects

page 或者 pageid 被設定成重新導向,則解析它。

類型:布林值(詳細資訊
oldid

解析此修訂的內容。覆蓋 pagepageid

類型:整數
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 分隔):textlanglinkscategoriescategorieshtmllinkstemplatesimagesexternallinkssectionsreviddisplaytitleheadhtmlmodulesjsconfigvarsencodedjsconfigvarsindicatorsiwlinkswikitextpropertieslimitreportdatalimitreporthtmlparsetreeparsewarningsheaditems
預設值: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时,将textsectiontitle解析为添加新段落至页面。

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

sectiontitle

sectionnew时新段落标题。

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

disablepp
已停用。

請改用disablelimitreport

類型:布林值(詳細資訊
disablelimitreport

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

類型:布林值(詳細資訊
disableeditsection

從解析輸出內容省略編輯段落連結。

類型:布林值(詳細資訊
disabletidy
已停用。

不要在解析輸出裡執行 HTML 內容清理(例如使用 tidy 軟體工具)

類型:布林值(詳細資訊
disablestylededuplication

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

類型:布林值(詳細資訊
generatexml
已停用。

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

類型:布林值(詳細資訊
preview

在預覽模式下解析。

類型:布林值(詳細資訊
sectionpreview

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

類型:布林值(詳細資訊
disabletoc

在輸出裡忽略目錄。

類型:布林值(詳細資訊
useskin

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

單值:colognebluemodernmonobookmoztwvector
contentformat

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

單值:text/x-wikitext/javascriptapplication/jsontext/csstext/plain
contentmodel

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

單值:wikitextjavascriptjsoncsstext