Довідка API Медіавікі

Це автоматично генерована сторінка документації API Медіавікі.

Документація та приклади: https://www.mediawiki.org/wiki/API

action=parse

(mainparse)
  • Цей модуль вимагає прав на читання.
  • Джерело: MediaWiki
  • Ліцензія: GPL-2.0+

Аналізує вміст і видає парсер виходу.

Див. різні prop-модулі action=query, щоб отримати інформацію з поточної версії сторінки.

Є декілька способів вказати текст для аналізу:

  1. Вказати сторінку або версію, використавши page, pageid або oldid.
  2. Вказати безпосередньо, використавши text, title і contentmodel.
  3. Вказати лише підсумок аналізу. prop повинен мати порожнє значення.
Параметри:
title

Назва сторінки, якій належить текст. Якщо пропущена, має бути вказано contentmodel, а як назву буде вжито API.

text

Текст для аналізу. Використати title або contentmodel для контролю моделі вмісту.

summary

Підсумок для аналізу.

page

Аналізувати вміст цієї сторінки. Не можна використати разом з text і title.

pageid

Аналізувати вміст цієї сторінки. Перевизначає page.

Тип: ціле число
redirects

Якщо page або pageid вказані як перенаправлення, виправити це.

Тип: логічний (деталі)
oldid

Аналізувати вміст цієї версії. Перевизначає page та pageid.

Тип: ціле число
prop

Яку інформацію отримати?

text
Дає текст-аналіз вікітексту.
langlinks
Дає мовні посилання в аналізованому вікітексті.
categories
Дає категорії в аналізованому вікітексті.
categorieshtml
Дає HTML-версію категорій.
links
Дає зовнішні посилання в аналізованому вікітексті.
templates
Дає шаблони в аналізованому вікітексті.
images
Дає зображення в аналізованому вікітексті.
externallinks
Дає зовнішні посилання в аналізованому вікітексті.
sections
Дає розділи в аналізованому вікітексті.
revid
Додає ідентифікатор версії аналізованої сторінки.
displaytitle
Додає заголовок аналізованого вікітексту.
headitems
Дає елементи для вставки в <head> сторінки.
headhtml
Дає проаналізований <head> сторінки.
modules
Дає модулі ResourceLoader, використані на сторінці. Чи jsconfigvars, чи encodedjsconfigvars має бути запитано разом з modules.
jsconfigvars
Дає змінні конфігурації JavaScript, притаманні для сторінки.
encodedjsconfigvars
Дає змінні конфігурації JavaScript, притаманні для сторінки, як рядок JSON.
indicators
Дає HTML індикаторів стану сторінки, використаних на сторінці.
iwlinks
Дає інтервікі-посилання в аналізованому вікітексті.
wikitext
Дає вихідний вікітекст, який було аналізовано.
properties
Дає різні властивості, визначені в аналізованому вікітексті.
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. Дійсне лише у разі використання з text.

Тип: логічний (деталі)
effectivelanglinks

Включає мовні посилання, додані розширеннями (для використання з prop=langlinks).

Тип: логічний (деталі)
section

Видає вміст лише розділу з цим номером або при new створенні нового розділу.

new розділ відзначається лише при вказанні тексту text.

sectiontitle

Заголовок нового розділу, коли section має значення new.

На відміну від редагування сторінки, це не повертається до summary, якщо пропустити чи лишити порожнім.

disablepp
Застарілий.

Use disablelimitreport instead.

Тип: логічний (деталі)
disablelimitreport

Пропустити звіт препроцесора («NewPP limit report») на виході аналізу.

Тип: логічний (деталі)
disableeditsection

Пропустити посилання на редагування розділів на виході аналізу.

Тип: логічний (деталі)
disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Тип: логічний (деталі)
generatexml
Застарілий.

Генерувати синтаксичне дерево XML (передбачає модель вмісту wikitext; замінено на prop=parsetree).

Тип: логічний (деталі)
preview

Аналізувати у режимі попереднього перегляду.

Тип: логічний (деталі)
sectionpreview

Аналізувати у режимі попереднього перегляду розділу (також вмикає попередній перегляд).

Тип: логічний (деталі)
disabletoc

Пропустити зміст на виході.

Тип: логічний (деталі)
contentformat

Формат серіалізації вмісту, використаний у вхідному тексті. Дійсний лише при використанні разом з text.

Одне значення: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

Модель вмісту вхідного тексту. Якщо пропущено, має бути вказано title, і за замовчуванням буде модель вказаного заголовка. Дійсне лише при використанні з text.

Одне значення: wikitext, javascript, json, css, text
Приклади:
Аналізувати сторінку.
api.php?action=parse&page=Project:Sandbox
Аналізувати вікітекст.
api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext
Аналізувати вікітекст, вказуючи назву сторінки.
api.php?action=parse&text={{PAGENAME}}&title=Test
Аналізувати опис.
api.php?action=parse&summary=Some+[[link]]&prop=