MediaWiki API 幫助

這是自動生成的MediaWiki API文檔頁面。

文檔和例子:https://www.mediawiki.org/wiki/API:Main_page/zh

action=parse

main | parse
  • 此模塊需要讀取權限。
  • 來源:MediaWiki
  • 許可協議:GPL-2.0+

解析內容并返回解析器輸出。

參見action=query的各種prop-module以從頁面的當前版本獲得信息。

這里有幾種方法可以指定解析的文本:

  1. 指定一個頁面或修訂,使用pagepageidoldid
  2. 明確指定內容,使用texttitlecontentmodel
  3. 只指定一段摘要解析。prop應提供一個空值。
參數:
title

文本屬于的頁面標題。如果省略,contentmodel就必須被指定,且API將作為標題使用。

text

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

summary

所要解析的摘要。

page

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

pageid

解析此頁的內容。覆蓋page

類型:整數
redirects

如果pagepageid被設置為一個重定向,則解析它。

類型:布爾值(詳細信息
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文本添加標題。
headitems
提供項目以插入至頁面的<head>
headhtml
提供頁面的被解析<head>
modules
提供在頁面中使用的ResourceLoader模塊。無論jsconfigvars還是encodedjsconfigvars都必須與modules共同被請求。
jsconfigvars
針對頁面提供JavaScript配置變量。
encodedjsconfigvars
針對頁面提供JavaScript配置變量為一個JSON字符串。
indicators
提供頁面上使用的頁面狀態指示器的HTML。
iwlinks
在被解析的wiki文本中提供跨wiki鏈接。
wikitext
提供被解析的原始wiki文本。
properties
提供多種定義在被解析的wiki文本中的屬性。
limitreportdata
以結構化的方式提供限制報告。如果disablelimitreport被設定則不提供數據。
limitreporthtml
提供限制報告的HTML版本。當disablelimitreport被設置時不會提供數據。
parsetree
修訂內容的XML解析樹(需要內容模型wikitext
值(以|分隔):text、langlinks、categories、categorieshtml、links、templates、images、externallinks、sections、revid、displaytitle、headitems、headhtml、modules、jsconfigvars、encodedjsconfigvars、indicators、iwlinks、wikitext、properties、limitreportdata、limitreporthtml、parsetree
默認:text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
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)。

類型:布爾值(詳細信息
generatexml
不推薦使用。

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

類型:布爾值(詳細信息
preview

在預覽模式下解析。

類型:布爾值(詳細信息
sectionpreview

在段落預覽模式下解析(同時要啟用預覽模式)。

類型:布爾值(詳細信息
disabletoc

在輸出中省略目錄。

類型:布爾值(詳細信息
contentformat

用于輸入文本的內容序列化格式。只當與text一起使用時有效。

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

輸入文本的內容模型。如果省略,title必須指定,并且默認將為指定標題的模型。只當與text一起使用時有效。

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