Ajuda da API do MediaWiki

Esta é uma página de documentação da API do MediaWiki gerada automaticamente.

Documentação e exemplos: https://www.mediawiki.org/wiki/API

action=parse

(main | parse)
  • Este módulo requer direitos de leitura.
  • Fonte: MediaWiki
  • Licença: GPL-2.0+

Faz a análise sintática do conteúdo e devolve o resultado da análise.

Consulte os vários módulos disponíveis no parâmetro prop de action=query para obter informação da versão atual de uma página.

Há várias formas de especificar o texto a analisar:

  1. Especificar uma página ou revisão, usando page, pageid ou oldid.
  2. Especificar o conteúdo de forma explícita, usando text, title e contentmodel.
  3. Especificar só um resumo a analisar. prop deve receber o valor vazio.
Parâmetros:
title

Título da página à qual o texto pertence. Se omitido, é preciso especificar contentmodel e deve usar API como título.

text

Texto a analisar. Usar title ou contentmodel para controlar o modelo de conteúdo.

summary

Resumo a analisar.

page

Analisar o conteúdo desta página. Não pode ser usado em conjunto com text e title.

pageid

Analisar o conteúdo desta página. Tem precedência sobre page.

Tipo: inteiro
redirects

Se page ou pageid estiverem definidos para um redirecionamento, resolvê-lo.

Tipo: booleano (detalhes)
oldid

Analisar o conteúdo desta revisão. Tem precedência sobre page e pageid.

Tipo: inteiro
prop

As informações que devem ser obtidas:

text
Fornece o texto analisado, de um texto com notação wiki.
langlinks
Fornece os links interlínguas do texto analisado.
categories
Fornece as categorias do texto analisado.
categorieshtml
Fornece a versão HTML das categorias.
links
Fornece os links internos do texto analisado.
templates
Fornece as predefinições do texto analisado.
images
Fornece as imagens do texto analisado.
externallinks
Fornece os links externos do texto analisado.
sections
Fornece as secções do texto analisado.
revid
Adiciona o identificador de revisão da página analisada.
displaytitle
Adiciona o título do texto analisado.
headitems
Obsoleto. Fornece os elementos a colocar no <head> da página.
headhtml
Fornece o <head> analisado da página.
modules
Fornece os módulos ResourceLoader usados na página. Para carregá-los, usar mw.loader.using(). Uma das variáveis jsconfigvars ou encodedjsconfigvars tem de ser pedida em conjunto com modules.
jsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página. Para aplicá-las, usar mw.config.set().
encodedjsconfigvars
Fornece as variáveis de configuração JavaScript específicas da página, no formato de uma string JSON.
indicators
Fornece o HTML dos indicadores de estado de página que são usados na página.
iwlinks
Fornece os links interwikis do texto analisado.
wikitext
Fornece o texto original com notação wiki que foi analisado.
properties
Fornece várias propriedades definidas no texto analisado.
limitreportdata
Fornece o relatório de limites de forma estruturada. Não fornece dados quando disablelimitreport está definido.
limitreporthtml
Fornece a versão HTML do relatório de limites. Não fornece dados quando disablelimitreport está definido.
parsetree
A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo wikitext).
parsewarnings
Gives the warnings that occurred while parsing content.
Valores (separados com | ou alternativas): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headitems, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree, parsewarnings
Valor por omissão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
pst

Fazer uma transformação de pré-gravação ao texto de entrada, antes de analisá-lo. Só é válido quando usado com texto.

Tipo: booleano (detalhes)
onlypst

Fazer uma transformação de pré-gravação (PST, pre-save transform) ao texto de entrada, mas não o analisar. Devolve o mesmo texto após aplicação da PST. Só é válido quando usado com text.

Tipo: booleano (detalhes)
effectivelanglinks

Inclui links interlínguas fornecidos por extensões (para ser usado com prop=langlinks).

Tipo: booleano (detalhes)
section

Analisar apenas o conteúdo desta secção.

Quando tiver o valor new, analisar text e sectiontitle como se fosse adicionar uma nova secção à página.

new só é permitido quando se especifica text.

sectiontitle

O novo título da secção quando section tem o valor new.

Ao contrário da edição de páginas, este não toma o valor de summary se for omitido ou estiver vazio.

disablepp
Obsoleto.

Em vez deste, usar disablelimitreport.

Tipo: booleano (detalhes)
disablelimitreport

Omitir o relatório de limites ("NewPP limit report") do resultado de saída do analisador sintático.

Tipo: booleano (detalhes)
disableeditsection

Omitir links para edição da secção no resultado da análise sintática.

Tipo: booleano (detalhes)
disabletidy

Não fazer a limpeza do HTML (isto é, o tidy) no resultado da análise sintática.

Tipo: booleano (detalhes)
generatexml
Obsoleto.

Gerar a árvore de análise XML (requer o modelo de conteúdo wikitext; substituído por prop=parsetree).

Tipo: booleano (detalhes)
preview

Executar a análise em modo de antevisão.

Tipo: booleano (detalhes)
sectionpreview

Executar a análise em modo de antevisão (também ativa o modo de antevisão).

Tipo: booleano (detalhes)
disabletoc

Omitir a tabela de conteúdo no resultado.

Tipo: booleano (detalhes)
contentformat

O formato da seriação de conteúdo, usado para o texto de entrada. Só é válido quando usado com text.

Um dos seguintes valores: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

Modelo de conteúdo do texto de entrada. Se omitido, title tem de ser especificado e o valor por omissão será o modelo do título especificado. Só é válido quando usado com text.

Um dos seguintes valores: wikitext, javascript, json, css, text
Exemplos:
Fazer a análise sintática de uma página.
api.php?action=parse&page=Project:Sandbox [abrir na página de testes]
Fazer a análise sintática do texto com notação wiki.
api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na página de testes]
Fazer a análise sintática do texto com notação wiki, especificando o título da página.
api.php?action=parse&text={{PAGENAME}}&title=Test [abrir na página de testes]
Fazer a análise sintática de um resumo.
api.php?action=parse&summary=Some+[[link]]&prop= [abrir na página de testes]