Довідка API MediaWiki
Це автоматично генерована сторінка документації API MediaWiki.
Документація та приклади: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- Цей модуль вимагає прав на читання.
- Джерело: MediaWiki
- Ліцензія: GPL-2.0-or-later
Аналізує вміст і видає парсер виходу.
Див. різні prop-модулі action=query, щоб отримати інформацію з поточної версії сторінки.
Є декілька способів вказати текст для аналізу:
- Вказати сторінку або версію, використавши page, pageid або oldid.
- Вказати безпосередньо, використавши text, title і contentmodel.
- Вказати лише підсумок аналізу. prop повинен мати порожнє значення.
- title
Назва сторінки, якій належить текст. Якщо пропущена, має бути вказано contentmodel, а як назву буде вжито API.
- text
Текст для аналізу. Використати title або contentmodel для контролю моделі вмісту.
- revid
Ідентифікатор версії, для
{{REVISIONID}}та подібних змінних.- Тип: ціле число
- 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
- Додає заголовок аналізованого вікітексту.
- subtitle
- Додає субтитри до проаналізованої сторінки.
- headhtml
- Дає проаналізований тип документа, початковий
<html>, елемент<head>та початковий<body>сторінки. - modules
- Дає модулі ResourceLoader, використані на сторінці. Щоб завантажити, використовуйте
mw.loader.using(). Чи jsconfigvars, чи encodedjsconfigvars має бути запитано разом з modules. - jsconfigvars
- Дає змінні конфігурації JavaScript, притаманні для сторінки. Щоб застосувати, використайте
mw.config.set(). - encodedjsconfigvars
- Дає змінні конфігурації JavaScript, притаманні для сторінки, як рядок JSON.
- indicators
- Дає HTML індикаторів стану сторінки, використаних на сторінці.
- iwlinks
- Дає інтервікі-посилання в аналізованому вікітексті.
- wikitext
- Дає вихідний вікітекст, який було аналізовано.
- properties
- Дає різні властивості, визначені в аналізованому вікітексті.
- limitreportdata
- Дає звіт по обмеженнях у структурованому вигляді. Не видає даних, якщо встановлено disablelimitreport.
- limitreporthtml
- Дає HTML-версію звіту по обмеженнях. Не видає даних, якщо встановлено disablelimitreport.
- parsetree
- Синтаксичне дерево XML вмісту версії (передбачає модель вмісту
wikitext) - parsewarnings
- Виводить попередження, які з'явилися при обробці контенту (як вікітексту).
- parsewarningshtml
- Виводить попередження, які з'явилися при обробці контенту (як вікі-тексту).
- 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
- pst
Зробіть трансформацію вхідних даних перед збереженням і аналізом. Дійсне лише при використанні з текстом.
- Тип: логічний (подробиці)
- onlypst
Зробіть трансформацію вхідних даних перед збереженням (PST), але не аналізуйте. Видає той самий вікітекст, після застосування PST. Дійсне лише у разі використання з text.
- Тип: логічний (подробиці)
- effectivelanglinks
- Застарілий.
Включає мовні посилання, додані розширеннями (для використання з prop=langlinks).
- Тип: логічний (подробиці)
- section
Розібрати вміст лише розділу з цим ідентифікатором.
Якщо new, розібрати text та sectiontitle, як ніби новий розділ додається на сторінку.
new дозволяється лише про вказаному text.
- sectiontitle
Заголовок нового розділу, коли section має значення new.
На відміну від редагування сторінки, це не повертається до summary, якщо пропустити чи лишити порожнім.
- disablepp
- Застарілий.
Використати натомість disablelimitreport.
- Тип: логічний (подробиці)
- disablelimitreport
Пропустити звіт про ліміти («NewPP limit report») на виході аналізу.
- Тип: логічний (подробиці)
- disableeditsection
Пропустити посилання на редагування розділів на виході аналізу.
- Тип: логічний (подробиці)
- disablestylededuplication
Не усувайте дублікати вбудованих таблиць стилів на виході парсера.
- Тип: логічний (подробиці)
- showstrategykeys
Whether to include internal merge strategy information in jsconfigvars.
- Тип: логічний (подробиці)
- generatexml
- Застарілий.
Генерувати синтаксичне дерево XML (передбачає модель вмісту
wikitext; замінено на prop=parsetree).- Тип: логічний (подробиці)
- preview
Аналізувати у режимі попереднього перегляду.
- Тип: логічний (подробиці)
- sectionpreview
Аналізувати у режимі попереднього перегляду розділу (також вмикає попередній перегляд).
- Тип: логічний (подробиці)
- disabletoc
Пропустити зміст на виході.
- Тип: логічний (подробиці)
- useskin
Застосувати вибрану тему оформлення до виводу парсера. Може вплинути на такі властивості: text, langlinks, headitems, modules, jsconfigvars, indicators.
- Одне з наступних значень: apioutput, fallback, 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, css, javascript, json, text, unknown, wikitext
- Аналізувати сторінку.
- 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= [відкрити в пісочниці]