MediaWiki API hulp
Dit is een automatisch aangemaakte documentatiepagina over de API van MediaWiki.
Documentatie en voorbeelden: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- Voor deze module zijn leesrechten nodig.
- Bron: MediaWiki
- Licentie: GPL-2.0-or-later
Ontleedt inhoud en retourneert parseruitvoer.
Zie de verschillende prop-modules van action=query om informatie op te halen uit de huidige versie van een pagina.
Er zijn verschillende manieren om de te parsen tekst op te geven:
- Geef een pagina of versie op met page, pageid of oldid.
- Geef de inhoud expliciet op met text, title, revid en contentmodel.
- Geef alleen een samenvatting op om te parsen. prop moet een lege waarde krijgen.
- title
Titel van de pagina waartoe de tekst behoort. Indien weggelaten moet contentmodel worden opgegeven en wordt API als titel gebruikt.
- text
De te parsen tekst. Gebruik title of contentmodel om het inhoudsmodel te bepalen.
- revid
Versie-ID, voor
{{REVISIONID}}en soortgelijke variabelen.- Type: integer
- summary
De te ontleden samenvatting.
- page
De inhoud van deze pagina ontleden. Kan niet samen met text en title worden gebruikt.
- pageid
De inhoud van deze pagina ontleden. Overschrijft page.
- Type: integer
- redirects
Als page or pageid is ingesteld op een doorverwijzing, los deze dan op.
- Type: booleaans (details)
- oldid
De inhoud van deze versie ontleden. Overschrijft page en pageid.
- Type: integer
- prop
Welke gegevens opgevraagd moeten worden:
- text
- Geeft de geparsete tekst van de wikitekst.
- langlinks
- Geeft de taalkoppelingen in de geparsete wikitekst.
- categories
- Geeft de categorieën in de geparsete wikitekst.
- categorieshtml
- Geeft de HTML-versie van de categorieën.
- links
- Geeft de interne koppelingen in de geparsete wikitekst.
- templates
- Geeft de sjablonen in de geparsete wikitekst.
- images
- Geeft de afbeeldingen in de geparsete wikitekst.
- externallinks
- Geeft de externe koppelingen in de geparsete wikitekst.
- sections
- Geeft de secties in de geparsete wikitekst.
- revid
- Voegt de versie-ID van de geparsete pagina toe.
- displaytitle
- Voegt de titel van de geparsete pagina toe.
- subtitle
- Voegt de paginasubtitel van de geparsete pagina toe.
- headhtml
- Geeft van de pagina het geparsete doctype, de openende elementen
<html>en<head>, en de openende<body>. - modules
- Geeft de ResourceLoader-modules die op de pagina worden gebruikt. Gebruik
mw.loader.using()om te laden. Of Jsconfigvars of encodedjsconfigvars moet samen met modules worden aangevraagd. - jsconfigvars
- Geeft de JavaScript-configuratievariabelen die specifiek zijn voor de pagina. Gebruik
mw.config.set()om toe te passen. - encodedjsconfigvars
- Geeft de JavaScript-configuratievariabelen die specifiek zijn voor de pagina als een JSON-tekenreeks.
- indicators
- Geeft de HTML van de paginastatusindicatoren die op de pagina worden gebruikt.
- iwlinks
- Geeft interwiki-koppelingen in de geparsete wikitekst.
- wikitext
- Geeft de originele wikitekst die is geparset.
- properties
- Geeft verschillende eigenschappen die gedefinieerd zijn in de geparsete wikitekst.
- limitreportdata
- Geeft het limietrapport op een gestructureerde manier. Geeft geen gegevens wanneer disablelimitreport is ingesteld.
- limitreporthtml
- Geeft de HTML-versie van het limietrapport. Geeft geen gegevens wanneer disablelimitreport is ingesteld.
- parsetree
- De XML-ontleedboom van de versie-inhoud (vereist inhoudsmodel
wikitext) - parsewarnings
- Geeft de waarschuwingen weer die zijn opgetreden tijdens het parsen van de inhoud (als wikitekst).
- parsewarningshtml
- Geeft de waarschuwingen weer die zijn opgetreden tijdens het parsen van inhoud (als HTML).
- headitems
- Verouderd. Geeft items die in het
<head>-gedeelte van de pagina moeten worden geplaatst.
- Waarden (gescheiden met | of alternatief): 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
- Standaard: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
CSS-klasse om de parseruitvoer in te wikkelen.
- Standaard: mw-parser-output
- usearticle
Gebruik de hook ArticleParserOptions om ervoor te zorgen dat de gebruikte opties overeenkomen met de opties die worden gebruikt voor de weergave van artikelpagina’s
- Type: booleaans (details)
- parsoid
Genereert HTML die voldoet aan de MediaWiki DOM-specificatie met behulp van Parsoid.
- Type: booleaans (details)
- pst
Vóór het opslaan een transformatie op de invoer uitvoeren voordat deze geparset wordt. Alleen geldig bij gebruik met tekst.
- Type: booleaans (details)
- onlypst
Vóór het opslaan een transformatie (PST) op de invoer uitvoeren, maar deze niet parsen. Retourneert dezelfde wikitext, nadat een PST is toegepast. Alleen geldig bij gebruik met text.
- Type: booleaans (details)
- effectivelanglinks
- Verouderd.
Bevat taalkoppelingen die door uitbreidingen worden geleverd (voor gebruik met prop=langlinks).
- Type: booleaans (details)
- section
Alleen de inhoud van de sectie met deze identificatiecode parsen.
Indien new, dan worden text en sectiontitle geparset alsof er een nieuwe sectie aan de pagina wordt toegevoegd.
new is alleen toegestaan bij opgave van text.
- sectiontitle
Titel van de nieuwe sectie wanneer section new is.
Anders dan bij het bewerken van pagina’s wordt hier bij weglaten of een lege waarde niet teruggevallen op summary.
- disablepp
- Verouderd.
Gebruik in plaats daarvan disablelimitreport.
- Type: booleaans (details)
- disablelimitreport
Het limietrapport (“NewPP limit report”) weglaten uit de parseruitvoer.
- Type: booleaans (details)
- disableeditsection
De bewerkingssectiekoppelingen uit de parseruitvoer weglaten.
- Type: booleaans (details)
- disablestylededuplication
Geïntegreerde stijlbladen niet ontdubbelen in de parseruitvoer.
- Type: booleaans (details)
- showstrategykeys
Of interne samenvoegstrategie-informatie in jsconfigvars moet worden opgenomen.
- Type: booleaans (details)
- generatexml
- Verouderd.
Genereer een XML-ontleedboom (vereist inhoudsmodel
wikitext; vervangen door prop=parsetree).- Type: booleaans (details)
- preview
In voorbeeldmodus parsen.
- Type: booleaans (details)
- sectionpreview
In sectievoorbeeldmodus parsen (schakelt ook voorbeeldmodus in).
- Type: booleaans (details)
- disabletoc
Inhoudsopgave in de uitvoer weglaten.
- Type: booleaans (details)
- useskin
De geselecteerde vormgeving toepassen op de parseruitvoer. Kan de volgende eigenschappen beïnvloeden: text, langlinks, headitems, modules, jsconfigvars, indicators.
- Een van de volgende waarden: apioutput, authentication-popup, cologneblue, fallback, json, minerva, modern, monobook, timeless, vector, vector-2022
- contentformat
Inhoudsserialisatieformaat dat wordt gebruikt voor de invoertekst. Alleen geldig bij gebruik met text.
- Een van de volgende waarden: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- contentmodel
Inhoudsmodel van de invoertekst. Indien weggelaten moet title worden opgegeven; dan wordt standaard het model van de opgegeven titel gebruikt. Alleen geldig bij gebruik met text.
- Een van de volgende waarden: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext
- mobileformat
Verwerkte uitvoer retourneren in een formaat dat geschikt is voor mobiele apparaten.
- Type: booleaans (details)
- templatesandboxprefix
Voorvoegsel voor de sjabloonzandbak, zoals bij Special:TemplateSandbox.
- Scheid waarden met | of een alternatief.
- Maximumaantal waarden is 50 (of 500 voor cliënten waaraan hogere limieten zijn toegestaan).
- templatesandboxtitle
Verwerkt de pagina met behulp van templatesandboxtext in plaats van de inhoud van de hier genoemde pagina.
- templatesandboxtext
Verwerkt de pagina met behulp van deze pagina-inhoud in plaats van de door templatesandboxtitle genoemde pagina.
- templatesandboxcontentmodel
Inhoudsmodel vantemplatesandboxtext.
- Een van de volgende waarden: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext
- templatesandboxcontentformat
Inhoudsindeling van templatesandboxtext.
- Een van de volgende waarden: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- Een pagina verwerken.
- api.php?action=parse&page=Project:Sandbox [in de sandbox openen]
- Wikitekst verwerken.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [in de sandbox openen]
- Wikitekst verwerken, waarbij de paginatitel opgeven is.
- api.php?action=parse&text={{PAGENAME}}&title=Test [in de sandbox openen]
- Een samenvatting verwerken.
- api.php?action=parse&summary=Some+[[link]]&prop= [in de sandbox openen]