Справка MediaWiki API

Это автоматически сгенерированная страница документации MediaWiki API.

Документация и примеры: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=parse

(main | parse)
  • Этот модуль требует прав на чтение.
  • Источник: MediaWiki
  • Лицензия: GPL-2.0-or-later

Парсит содержимое и возвращает результат парсинга.

См. различные prop-модули action=query для получения информации о текущей версии страницы.

Есть несколько способов указать текст для парсинга:

  1. Указать страницу или версию, используя page, pageid или oldid.
  2. Явно указать содержимое, используя text, title и contentmodel.
  3. Указать описание правки. Параметру prop должно быть присвоено пустое значение.
Определённые параметры:
Other general parameters are available.
title

Название страницы, которой принадлежит текст. Если опущено, должен быть указан параметр contentmodel, и в качестве заголовка будет использовано API.

text

Распарсиваемый текст. Используйте title или contentmodel для управления моделью содержимого.

revid

Номер версии, для {{REVISIONID}} и аналогичных переменных.

Тип: целочисленное значение
summary

Анализируемое описание правки.

page

Распарсить содержимое этой страницы. Не может быть использовано совместно с text и title.

pageid

Анализировать содержимое этой страницы. Переопределяет page.

Тип: целочисленное значение
redirects

Если значением page или pageid указано перенаправление, разрешить его.

Type: boolean (details)
oldid

Распарсить содержимое этой версии. Переопределяет page и pageid.

Тип: целочисленное значение
prop

Какую информацию включить:

text
Возвращает текст распарсенного вики-текста.
langlinks
Возвращает языковые ссылки из распарсенного вики-текста.
categories
Возвращает категории из распарсенного вики-текста.
categorieshtml
Возвращает HTML-версию категорий.
links
Возвращает внутренние ссылки из распарсенного вики-текста.
templates
Возвращает шаблоны из распарсенного вики-текста.
images
Возвращает изображения из распарсенного вики-текста.
externallinks
Возвращает внешние ссылки из распарсенного вики-текста.
sections
Возвращает разделы из распарсенного вики-текста.
revid
Добавляет идентификатор версии распарсенной страницы.
displaytitle
Добавляет название распарсенного вики-текста.
subtitle
Добавляет подзаголовок страницы для распарсенной страницы.
headhtml
Возвращает распарсенный тип документа, начальный <html>, элемент <head> и открывающий <body>.
modules
Возвращает использованные на странице модули ResourceLoader. Для загрузки, используйте mw.loader.using(). Одновременно с modules должно быть запрошено либо jsconfigvars, либо encodedjsconfigvars.
jsconfigvars
Возвращает переменные JavaScript с данными настроек для этой страницы. Для их применения используйте mw.config.set().
encodedjsconfigvars
Возвращает переменные JavaScript с данными настроек для этой страницы в виде JSON-строки.
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, sections, subtitle, templates, text, wikitext, headitems
По умолчанию: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

CSS-класс, используемый для оборачивания вывода парсера.

По умолчанию: mw-parser-output
parsoid

Создать HTML, соответствующий спецификации MediaWiki DOM spec, используя Parsoid.

Type: boolean (details)
pst

Выполнить преобразование перед записью правки (PST) до того, как начать парсировать текст. Доступно только когда используется с текстом.

Type: boolean (details)
onlypst

Выполнить преобразование перед записью правки (PST) входных данных, но не парсить их. Возвращает тот же вики-текст после применения PST. Доступно только при применении с text.

Type: boolean (details)
effectivelanglinks
Устарело.

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

Type: boolean (details)
section

Распарсить содержимое только раздела с этим идентификатором.

Если задан new, распарсить text и sectiontitle так, как будто добавлен новый раздел на страницу.

new доступен только при заданном text.

sectiontitle

Название нового раздела, когда section имеет значение new.

В отличие от редактирования страницы, оно не примет значение параметра summary, если опустить его или оставить пустым.

disablepp
Устарело.

Вместо этого используйте disablelimitreport.

Type: boolean (details)
disablelimitreport

Опустить отчёт о лимите («NewPP limit report») из результата парсинга.

Type: boolean (details)
disableeditsection

Опустить ссылки на редактирование разделов из результата парсинга.

Type: boolean (details)
disablestylededuplication

Не редуплицировать встроенные таблицы стилей в выходе парсера.

Type: boolean (details)
showstrategykeys

Включать ли информацию о внутренней стратегии объединения в jsconfigvars.

Type: boolean (details)
generatexml
Устарело.

Создать дерево парсинга XML (требуется модель содержимого wikitext, замещено prop=parsetree).

Type: boolean (details)
preview

Проанализировать в режиме предросмотра.

Type: boolean (details)
sectionpreview

Распарсить в режиме предпросмотра раздела (также активирует режим предпросмотра).

Type: boolean (details)
disabletoc

Не включать в вывод содержание.

Type: boolean (details)
useskin

Применить выбранную тему оформления к результату работы парсера. Может затронуть следующие свойства: text, langlinks, headitems, modules, jsconfigvars, indicators.

Одно из следующих значений: apioutput, cologneblue, contenttranslation, fallback, minerva, modern, monobook, timeless, 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.

Одно из следующих значений: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext
mobileformat

Вернуть выходные данные синтаксического анализа в формате, подходящем для мобильных устройств.

Type: boolean (details)
templatesandboxprefix

Префикс песочницы шаблонов, например, Special:TemplateSandbox.

Разделяйте значения с помощью | или альтернативного разделителя.
Максимальное количество значений — 50 (500 для клиентов, которым разрешены более высокие лимиты).
templatesandboxtitle

Parse the page using templatesandboxtext in place of the contents of the page named here.

templatesandboxtext

Parse the page using this page content in place of the page named by templatesandboxtitle.

templatesandboxcontentmodel

Модель содержимого templatesandboxtext.

Одно из следующих значений: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, 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
Примеры:
Парсинг страницы.
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= [открыть в песочнице]
Ист æрцыд "https://os.wikipedia.org/wiki/Сæрмагонд:ApiHelp"-æй