Pomoc API MediaWiki

To jest automatycznie wygenerowana strona dokumentacji API MediaWiki.

Dokumentacja i przykłady: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=parse

(main | parse)
  • Ten moduł wymaga praw odczytu.
  • Źródło: MediaWiki
  • Licencja: GPL-2.0-or-later

Parsuje treść i zwraca wynik pracy parsera.

Zobacz różne moduły prop dla action=query aby pozyskać informacje z obecnej wersji strony.

Istnieje kilka możliwości określenia tekstu do parsowania:

  1. Określ stronę lub wersję przy użyciu page, pageid lub oldid.
  2. Wyraźnie określ treść przy użyciu text, title, revid oraz contentmodel.
  3. Określ tylko podsumowanie do parsowania. Parametr prop powinien zostać pusty.
Parametry:
title

Tytuł strony do której należy tekst. Jeśli pominiesz ten parametr to contentmodel musi zostać podany a API zostanie użyte jako tytuł.

text

Tekst do parsowania. Użyj title lub contentmodel aby kontrolować model zawartości.

revid

ID wersji dla {{REVISIONID}} i podobnych zmiennych.

Typ: liczba całkowita
summary

Powód do sparsowania.

page

Parsuj zawartość tej strony. Nie może być użyte razem z text oraz title.

pageid

Parsuj treść tej strony. Nadpisuje page.

Typ: liczba całkowita
redirects

Jeśli page lub pageid jest ustawione na przekierowanie, rozwiąż je.

Type: boolean (details)
oldid

Parsuj treść tej wersji. Nadpisuje page oraz pageid.

Typ: liczba całkowita
prop

Jakie porcje informacji otrzymać:

text
Przetworzony tekst z wikitekstu.
langlinks
Linki językowe z przetworzonego wikitekstu.
categories
Kategorie z przetworzonego wikitekstu.
categorieshtml
Wersja HTML listy kategorii.
links
Linki wewnętrzne z przetworzonego wikitekstu.
templates
Szablony z przetworzonego wikitekstu.
images
Zdjęcia z przetworzonego wikitekstu.
externallinks
Linki zewnętrzne z przetworzonego wikitekstu.
sections
Sekcje z przetworzonego wikitekstu.
revid
Dodaje ID wersji do sparsowanej strony.
displaytitle
Dodaje tytuł parsowanego wikitekstu.
subtitle
Adds the page subtitle for the parsed page.
headhtml
Podaje sparsowany typ dokumenty, otwarcie <html>, element <head> oraz otwarcie <body> strony.
modules
Podaje moduły ResourceLoadera używane na stronie. Aby je załadować, użyj mw.loader.using(). Parametr jsconfigvars lub encodedjsconfigvars musi zostać pobrany wraz z modules.
jsconfigvars
Podaje zmienne konfiguracyjne JavaScript dla strony. Użyj mw.config.set() aby je zaaplikować.
encodedjsconfigvars
Podaje zmienne konfiguracyjne JavaScript strony jako ciąg JSON.
indicators
Podaje HTML wskaźników statusu strony.
iwlinks
Podaje linki interwiki w sparsowanym wikitekście.
wikitext
Zwróć oryginalny wikitekst, który został sparsowany.
properties
Podaje różne własności zdefiniowane w sparsowanym wikitekście.
limitreportdata
Podaje raport limitu w ustrukturyzowany sposób. Nie zwraca żadnych danych gdy parametr disablelimitreport jest podany.
limitreporthtml
Podaje wersję HTML raportu limitu. Nie podaje żadnych danych gdy parametr disablelimitreport jest podany.
parsetree
Drzewo parsowania XML treści wersji (wymaga modelu zawartości wikitext)
parsewarnings
Podaje ostrzeżenia mające miejsce podczas parsowania zawartości (jako wikitekst).
parsewarningshtml
Gives the warnings that occurred while parsing content (as HTML).
headitems
Przestarzałe. Podaje elementy do umieszczenia w elemencie <head> strony.
Wartości (oddziel za pomocą | lub alternatywy): 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
Domyślnie: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

Klasa CSS do użycia w celu objęcia wyjścia parsera.

Domyślnie: mw-parser-output
pst

Do a pre-save transform on the input before parsing it. Only valid when used with text.

Type: boolean (details)
onlypst

Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.

Type: boolean (details)
effectivelanglinks
Przestarzałe.

Includes language links supplied by extensions (for use with prop=langlinks).

Type: boolean (details)
section

Only parse the content of the section with this identifier.

When new, parse text and sectiontitle as if adding a new section to the page.

new is allowed only when specifying text.

sectiontitle

New section title when section is new.

Unlike page editing, this does not fall back to summary when omitted or empty.

disablepp
Przestarzałe.

Use disablelimitreport instead.

Type: boolean (details)
disablelimitreport

Omit the limit report ("NewPP limit report") from the parser output.

Type: boolean (details)
disableeditsection

Omit edit section links from the parser output.

Type: boolean (details)
disablestylededuplication

Do not deduplicate inline stylesheets in the parser output.

Type: boolean (details)
showstrategykeys

Whether to include internal merge strategy information in jsconfigvars.

Type: boolean (details)
generatexml
Przestarzałe.

Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).

Type: boolean (details)
preview

Parsuj w trybie podglądu.

Type: boolean (details)
sectionpreview

Parse in section preview mode (enables preview mode too).

Type: boolean (details)
disabletoc

Pomiń spis treści na wyjściu.

Type: boolean (details)
useskin

Apply the selected skin to the parser output. May affect the following properties: text, langlinks, headitems, modules, jsconfigvars, indicators.

Jedna z następujących wartości: almanach, apioutput, fallback, timeless, vector, vector-2022
contentformat

Content serialization format used for the input text. Only valid when used with text.

Jedna z następujących wartości: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
contentmodel

Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.

Jedna z następujących wartości: GadgetDefinition, GeoJSON, GeoJson, Scribunto, css, javascript, json, text, unknown, wikitext
Przykłady:
Przeanalizuj stronę.
api.php?action=parse&page=Project:Sandbox [otwórz w brudnopisie]
Parsuj wikitekst.
api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [otwórz w brudnopisie]
Parse wikitext, specifying the page title.
api.php?action=parse&text={{PAGENAME}}&title=Test [otwórz w brudnopisie]
Parsuj powód.
api.php?action=parse&summary=Some+[[link]]&prop= [otwórz w brudnopisie]
Źródło: „https://almanach.historyczny.org/wiki/Specjalna:ApiHelp”