Nápověda k MediaWiki API
Toto je automaticky generovaná dokumentační stránka k MediaWiki API.
Dokumentace a příklady: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- Tento modul vyžaduje oprávnění ke čtení.
- Zdroj: MediaWiki
- Licence: GPL-2.0-or-later
Parsuje obsah a vráti výstup parsera.
Na získanie informácií z aktuálnej verzie stránky pozri rôzne prop-moduly action=query.
Text na parsovanie možno zadať niekoľkými spôsobmi:
- Zadaním stránky alebo revízie pomocou page, pageid alebo oldid.
- Explicitným zadaním obsahu pomocou text, title, revid a contentmodel.
- Zadaním iba zhrnutia na parsovanie. prop by mal dostať prázdnu hodnotu.
- title
Názov stránky, ku ktorej text patrí. Ak je vynechaný, musí byť zadaný contentmodel a ako názov sa použije API.
- text
Text na parsovanie. Na určenie modelu obsahu použite title alebo contentmodel.
- revid
ID revízie pre
{{REVISIONID}}a podobné premenné.- Typ: celé číslo
- summary
Shrnutí, které se má parsovat.
- page
Parsovať obsah tejto stránky. Nemožno použiť spolu s text a title.
- pageid
Parsovať obsah tejto stránky. Má prednosť pred page.
- Typ: celé číslo
- redirects
Ak je page alebo pageid nastavené na presmerovanie, vyriešiť ho.
- Typ: logická hodnota (boolean) (podrobnosti)
- oldid
Parsovať obsah tejto revízie. Má prednosť pred page a pageid.
- Typ: celé číslo
- prop
Ktoré informácie získať:
- text
- Vráti parsovaný text wikitextu.
- langlinks
- Vráti jazykové odkazy v parsovanom wikitexte.
- categories
- Vráti kategórie v parsovanom wikitexte.
- categorieshtml
- Vráti HTML verziu kategórií.
- links
- Vráti interné odkazy v parsovanom wikitexte.
- templates
- Vráti šablóny v parsovanom wikitexte.
- images
- Vráti obrázky v parsovanom wikitexte.
- externallinks
- Vráti externé odkazy v parsovanom wikitexte.
- sections
- Zastaralý. prop=sections je zastarané. Namiesto toho použite prop=tocdata.Vráti sekcie v parsovanom wikitexte.
- tocdata
- Poskytuje informace o obsahu v analyzovaném wikitextu.
- revid
- Pridá ID revízie parsovanej stránky.
- displaytitle
- Přidává název parsovaného wikitextu.
- subtitle
- Pridá podnadpis parsovanej stránky.
- headhtml
- Vráti parsovaný doctype, otvárací
<html>, element<head>a otvárací<body>stránky. - modules
- Vráti moduly ResourceLoader použité na stránke. Na načítanie použite
mw.loader.using(). Spolu s modules sa musí vyžiadať buď jsconfigvars, alebo encodedjsconfigvars. - jsconfigvars
- Vráti konfiguračné premenné JavaScriptu špecifické pre stránku. Na použitie zavolajte
mw.config.set(). - encodedjsconfigvars
- Vráti konfiguračné premenné JavaScriptu špecifické pre stránku ako reťazec JSON.
- indicators
- Vráti HTML indikátorov stavu stránky použitých na stránke.
- iwlinks
- Vráti interwiki odkazy v parsovanom wikitexte.
- wikitext
- Vráti pôvodný wikitext, ktorý bol parsovaný.
- properties
- Vráti rôzne vlastnosti definované v parsovanom wikitexte.
- limitreportdata
- Vráti report limitov v štruktúrovanej podobe. Nevráti žiadne dáta, keď je nastavené disablelimitreport.
- limitreporthtml
- Vráti HTML verziu reportu limitov. Nevráti žiadne dáta, keď je nastavené disablelimitreport.
- parsetree
- XML strom parsovania obsahu revízie (vyžaduje model obsahu
wikitext) - parsewarnings
- Vráti upozornenia, ktoré sa vyskytli pri parsovaní obsahu (ako wikitext).
- parsewarningshtml
- Vráti upozornenia, ktoré sa vyskytli pri parsovaní obsahu (ako HTML).
- headitems
- Zastaralý. prop=headitems je zastarané od MediaWiki 1.28. Pri vytváraní nových HTML dokumentov použite prop=headhtml, alebo pri aktualizácii dokumentu na strane klienta prop=modules|jsconfigvars.Vráti položky, ktoré sa majú vložiť do
<head>stránky.
- Hodnoty (oddělené | nebo alternativou.): categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, parsewarningshtml, properties, revid, subtitle, templates, text, tocdata, wikitext, headitems, sections
- Predvolené: text|langlinks|categories|links|templates|images|externallinks|sections|tocdata|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
CSS trieda, ktorá sa má použiť na obalenie výstupu parsera.
- Predvolené: mw-parser-output
- usearticle
Použiť hook ArticleParserOptions na zabezpečenie toho, aby sa použité možnosti zhodovali s tými, ktoré sa používajú pri zobrazeniach stránok článkov
- Typ: logická hodnota (boolean) (podrobnosti)
- parsoid
- Zastaralý.
Vygenerovať HTML v súlade so špecifikáciou MediaWiki DOM pomocou Parsoidu. Nahradené parser=parsoid.
- Typ: logická hodnota (boolean) (podrobnosti)
- parser
Ktorý parser wikitextu použiť:
- parsoid
- Vygenerovať HTML v súlade so špecifikáciou MediaWiki DOM pomocou Parsoidu.
- default
- Vygenerovať HTML pomocou predvoleného parsera tejto wiki.
- legacy
- Vygenerovať HTML pomocou staršieho (legacy) parsera.
- Jedna z následujících hodnot: default, legacy, parsoid
- Predvolené: default
- pst
Vykonať transformáciu pred uložením (pre-save transform) na vstupe pred jeho parsovaním. Platné iba pri použití s textom.
- Typ: logická hodnota (boolean) (podrobnosti)
- onlypst
Vykonať transformáciu pred uložením (PST) na vstupe, ale neparsovať ho. Vráti rovnaký wikitext po aplikovaní PST. Platné iba pri použití s text.
- Typ: logická hodnota (boolean) (podrobnosti)
- effectivelanglinks
- Zastaralý.
Zahŕňa jazykové odkazy poskytnuté rozšíreniami (na použitie s prop=langlinks).
- Typ: logická hodnota (boolean) (podrobnosti)
- section
Parsovať iba obsah sekcie s týmto identifikátorom.
Pri hodnote new parsovať text a sectiontitle, ako pri pridávaní novej sekcie na stránku.
new je povolené iba pri zadaní text.
- sectiontitle
Nadpis novej sekcie, keď je section nastavené na new.
Na rozdiel od úprav stránky sa pri vynechaní alebo prázdnej hodnote nepoužije summary.
- disablepp
- Zastaralý.
Namiesto toho použite disablelimitreport.
- Typ: logická hodnota (boolean) (podrobnosti)
- disablelimitreport
Vynechať report limitov („NewPP limit report“) z výstupu parsera.
- Typ: logická hodnota (boolean) (podrobnosti)
- disableeditsection
Vynechať odkazy na úpravu sekcií z výstupu parsera.
- Typ: logická hodnota (boolean) (podrobnosti)
- disablestylededuplication
Neodstraňovat duplicitní in-line styly ve výstupu parseru.
- Typ: logická hodnota (boolean) (podrobnosti)
- showstrategykeys
Či zahrnúť interné informácie o stratégii zlučovania do jsconfigvars.
- Typ: logická hodnota (boolean) (podrobnosti)
- generatexml
- Zastaralý.
Vygenerovať XML strom parsovania (vyžaduje model obsahu
wikitext; nahradené prop=parsetree).- Typ: logická hodnota (boolean) (podrobnosti)
- preview
Parsovat v režimu náhledu.
- Typ: logická hodnota (boolean) (podrobnosti)
- sectionpreview
Parsovať v režime náhľadu sekcie (zapne aj režim náhľadu).
- Typ: logická hodnota (boolean) (podrobnosti)
- disabletoc
Vynechať obsah (table of contents) vo výstupe.
- Typ: logická hodnota (boolean) (podrobnosti)
- useskin
Použiť vybranú tému vzhľadu na výstup parsera. Môže ovplyvniť nasledujúce vlastnosti: text, langlinks, headitems, modules, jsconfigvars, indicators.
- Jedna z následujících hodnot: apioutput, authentication-popup, fallback, json, monobook, timeless, vector, vector-2022
- contentformat
Serializačný formát obsahu použitý pre vstupný text. Platné iba pri použití s text.
- Jedna z následujících hodnot: application/json, application/octet-stream, application/unknown, application/vue+xml, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- contentmodel
Model obsahu vstupného textu. Ak je vynechaný, musí byť zadaný title a predvoleným bude model zadaného názvu. Platné iba pri použití s text.
- Jedna z následujících hodnot: css, javascript, json, text, unknown, vue, wikitext
- Parsovat stránku.
- api.php?action=parse&page=Project:Sandbox [otevřít v pískovišti]
- Parsovat wikitext.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [otevřít v pískovišti]
- Parsovať wikitext so zadaním názvu stránky.
- api.php?action=parse&text={{PAGENAME}}&title=Test [otevřít v pískovišti]
- Parsovat shrnutí.
- api.php?action=parse&summary=Some+[[link]]&prop= [otevřít v pískovišti]