Axuda da API de MediaWiki
Esta é unha páxina de documentación da API de MediaWiki xerada automaticamente.
Documentación e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=parse
- Este módulo precisa permisos de lectura.
- Fonte: MediaWiki
- Licenza: GPL-2.0-or-later
Fai a análise sintáctica do contido e devolve o resultado da análise.
Consulta os distintos módulos de action=query para obter información sobre a versión actual dunha páxina.
Hai varias formas de especificar o texto a analizar:
- Especificando unha páxina ou revisión, usando page, pageid ou oldid.
- Especificando o contido explicitamente, usando text, title, revid e contentmodel.
- Especificando só un resumo a analizar. prop debe ter un valor baleiro.
- title
Título da páxina á que pertence o texto. Se non se indica, debe especificarse contentmodel, e API usarase como o título.
- text
Texto a analizar. Use title ou contentmodel para controlar o modelo de contido.
- revid
ID de revisión, para
{{REVISIONID}}e variables similares.- Tipo: número enteiro
- summary
Resumo a analizar.
- page
Analizar o contido desta páxina. Non pode usarse de forma conxunta con text e title.
- pageid
Analizar o contido desta páxina. Ignora page.
- Tipo: número enteiro
- redirects
Se page ou pageid apuntar a unha redirección, resólvea.
- Tipo: booleano (detalles)
- oldid
Analizar o contido desta revisión. Ignora page e pageid.
- Tipo: número enteiro
- prop
Que información obter:
- text
- Devolve o texto analizado do texto wiki.
- langlinks
- Devolve as interwikis do texto analizado.
- categories
- Devolve as categoría do texto analizado.
- categorieshtml
- Devolve a versión HTML das categorías.
- links
- Devolve as ligazóns internas do texto wiki analizado.
- templates
- Devolve os modelos do texto wiki analizado.
- images
- Devolve as imaxes do texto wiki analizado.
- externallinks
- Devolve as ligazóns externas no texto wiki analizado.
- sections
- Devolve as seccións do texto wiki analizado.
- revid
- Engade o identificador de edición do texto wiki analizado.
- displaytitle
- Engade o título do texto wiki analizado.
- subtitle
- Engade o subtítulo da páxina analizada.
- headhtml
- Devolve o tipo de documento analizado, os elementos
<html>e<head>iniciais e a etiqueta inicial<body>da páxina. - modules
- Devolve os módulos ResourceLoader usados na páxina. Para cargar, use
mw.loader.using(). jsconfigvars ou encodedjsconfigvars deben ser solicitados xunto con modules. - jsconfigvars
- Devolve as variables específicas de configuración JavaScript da páxina. Para aplicalo, use
mw.config.set(). - encodedjsconfigvars
- Devolve as variables específicas de configuración JavaScript da páxina como unha cadea de texto JSON.
- indicators
- Devolve o HTML dos indicadores de estado de páxina usados na páxina.
- iwlinks
- Devolve as ligazóns interwiki do texto wiki analizado.
- wikitext
- Devolve o texto wiki orixinal que foi analizado.
- properties
- Obter varias propiedades definidas no texto wiki analizado.
- limitreportdata
- Devolve o informe de límite de forma estruturada. Non devolve datos cando disablelimitreport está fixado.
- limitreporthtml
- Devolve a versión HTML do informe de límite. Non devolve datos cando disablelimitreport está fixado.
- parsetree
- Árbores de análise XML do contido da revisión (precisa o modelo de contido
wikitext) - parsewarnings
- Devolve os avisos que ocorreron ó analizar o contido (como texto wiki).
- parsewarningshtml
- Devolve os avisos que ocorreron ó analizar o contido (como HTML).
- headitems
- Obsoleto. Devolve os elementos a poñer na etiqueta
<head>da páxina.
- Valores (separados con | ou outros): 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
- Por defecto: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
Clase CSS a usar para formatar a saída do analizador sintáctico.
- Por defecto: mw-parser-output
- parsoid
Xerar HTML conforme á especificación DOM de MediaWiki usando Parsoid.
- Tipo: booleano (detalles)
- pst
Fai unha transformación antes de gardar a entrada antes de analizala. Válida unicamente para usar con texto.
- Tipo: booleano (detalles)
- onlypst
Facer unha transformación antes de gardar (PST) a entrada, pero sen analizala. Devolve o mesmo wikitexto, despois de que a PST foi aplicada. Só válida cando se usa con text.
- Tipo: booleano (detalles)
- effectivelanglinks
- Obsoleto.
Inclúe ligazóns de idioma proporcionadas polas extensións (para usar con prop=langlinks).
- Tipo: booleano (detalles)
- section
Analizar unicamente o contido da sección con este identificador.
Cando toma o valor new, analiza text e sectiontitle como se fose a engadir unha nova sección á páxina.
new só se permite cando se especifica text.
- sectiontitle
Novo título de sección cando section é new.
A diferenza da edición de páxinas, non se oculta no summary cando se omite ou está baleiro.
- disablepp
- Obsoleto.
Use disablelimitreport no seu lugar.
- Tipo: booleano (detalles)
- disablelimitreport
Omitir o informe de límite ("Informe de límite NewPP") da saída do analizador.
- Tipo: booleano (detalles)
- disableeditsection
Omitir as ligazóns de edición de sección da saída do analizador.
- Tipo: booleano (detalles)
- disablestylededuplication
Non deduplicar as follas de estilo en liña na saída do analizador.
- Tipo: booleano (detalles)
- showstrategykeys
Indica se debe incluír información sobre a estratexia de fusión interna en jsconfigvars.
- Tipo: booleano (detalles)
- generatexml
- Obsoleto.
Xenerar unha árbore de análise XML (necesita o modelo de contido
wikitext; substituído por prop=parsetree).- Tipo: booleano (detalles)
- preview
Analizar en modo vista previa.
- Tipo: booleano (detalles)
- sectionpreview
Analizar en modo vista previa de sección (activa tamén o modo de vista previa).
- Tipo: booleano (detalles)
- disabletoc
Omitir o índice na saída.
- Tipo: booleano (detalles)
- useskin
Aplicar o tema seleccionado á saída do analizador. Pode afectar ás seguintes propiedades: text, langlinks, headitems, modules, jsconfigvars, indicators.
- Un valor dos seguintes valores: apioutput, cologneblue, fallback, minerva, modern, monobook, timeless, vector, vector-2022
- contentformat
Formato de serialización do contido usado para o texto de entrada. Só válido cando se usa con text.
- Un valor dos seguintes valores: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- contentmodel
Modelo de contido do texto de entrada. Se se omite, debe especificarse title, e o valor por defecto será o modelo do título especificado. Só válido cando se usa con text.
- Un valor dos seguintes valores: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext
- mobileformat
Devolver a análise de saída nun formato axeitado para dispositivos móbiles.
- Tipo: booleano (detalles)
- templatesandboxprefix
Prefixo da zona de probas dos módulos, como con Special:TemplateSandbox.
- Separe os valores con | ou outros.
- O número máximo de valores é 50 (500 para os clientes aos que se lles permiten límites máis altos).
- templatesandboxtitle
Analizar a páxina usando templatesandboxtext no lugar dos contidos da páxina nomeada aquí.
- templatesandboxtext
Analizar a páxina usando o contido desta páxina no canto da páxina nomeada por templatesandboxtitle.
- templatesandboxcontentmodel
Modelo de contido de templatesandboxtext.
- Un valor dos seguintes valores: GadgetDefinition, JsonSchema, MassMessageListContent, Scribunto, SecurePoll, css, javascript, json, sanitized-css, text, unknown, wikitext
- templatesandboxcontentformat
Formato de contido de templatesandboxtext.
- Un valor dos seguintes valores: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- Analizar unha páxina.
- api.php?action=parse&page=Project:Sandbox [abrir na zona de probas]
- Analizar o texto wiki.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na zona de probas]
- Analizar o texto wiki, especificando o título da páxina.
- api.php?action=parse&text={{PAGENAME}}&title=Test [abrir na zona de probas]
- Analizar un resumo.
- api.php?action=parse&summary=Some+[[link]]&prop= [abrir na zona de probas]