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/Special:MyLanguage/API:Main_page
action=parse
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
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:
- Especificar uma página ou revisão, usando page, pageid ou oldid.
- Especificar o conteúdo de forma explícita, usando text, title, revid e contentmodel.
- Especificar só um resumo a analisar. prop deve receber o valor vazio.
- 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.
- revid
Identificador da revisão, para
{{REVISIONID}}e variáveis semelhantes.- Tipo: inteiro
- 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: booliano (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 resultante do texto wiki.
- langlinks
- Fornece as hiperligações interlínguas do texto wiki analisado.
- categories
- Fornece as categorias do texto wiki analisado.
- categorieshtml
- Fornece a versão HTML das categorias.
- links
- Fornece as hiperligações internas do texto wiki analisado.
- templates
- Fornece as predefinições do texto wiki analisado.
- images
- Fornece as imagens do texto wiki analisado.
- externallinks
- Fornece as hiperligações externas do texto wiki analisado.
- sections
- Fornece as secções do texto wiki analisado.
- revid
- Adiciona o identificador de revisão da página analisada.
- displaytitle
- Adiciona o título do texto wiki analisado.
- subtitle
- Adiciona o subtítulo de página da página a que foi feita a análise sintática.
- headhtml
- Fornece o tipo analisado do documento, abrindo
<html>, o elemento<head>e o<body>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 as hiperligações interwikis do texto wiki analisado.
- wikitext
- Fornece o texto wiki original 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
- Fornece os avisos gerados durante a análise sintática do conteúdo (como texto wiki).
- parsewarningshtml
- Fornece os avisos gerados durante a análise sintática do conteúdo (como HTML).
- headitems
- Obsoleto. Fornece os elementos a colocar no
<head>da página.
- Valores (separados com | ou alternativas): 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
- Valor por omissão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
A classe CSS a utilizar para envolver o resultado do analisador sintático.
- Valor por omissão: mw-parser-output
- parsoid
Gerar HTML conforme à especificação MediaWiki DOM usando o Parsoid.
- Tipo: booliano (detalhes)
- pst
Fazer uma transformação anterior à gravação do texto de entrada, antes de analisá-lo. Só é válido quando usado com texto.
- Tipo: booliano (detalhes)
- onlypst
Fazer uma transformação anterior à gravação (PST, pre-save transform) do 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: booliano (detalhes)
- effectivelanglinks
- Obsoleto.
Inclui hiperligações interlínguas fornecidas por extensões (para ser usado com prop=langlinks).
- Tipo: booliano (detalhes)
- section
Fazer a análise sintática só do conteúdo da secção com este identificador.
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: booliano (detalhes)
- disablelimitreport
Omitir o relatório de limites ("NewPP limit report") do resultado de saída do analisador sintático.
- Tipo: booliano (detalhes)
- disableeditsection
Omitir as hiperligações para edição da secção no resultado da análise sintática.
- Tipo: booliano (detalhes)
- disablestylededuplication
Não desduplicar as folhas de estilo internas (etiquetas <style>) na saída do analisador sintático.
- Tipo: booliano (detalhes)
- showstrategykeys
Incluir, ou não, informação da estratégia interna de fusão em jsconfigvars.
- Tipo: booliano (detalhes)
- generatexml
- Obsoleto.
Gerar a árvore de análise XML (requer o modelo de conteúdo
wikitext; substituído por prop=parsetree).- Tipo: booliano (detalhes)
- preview
Executar a análise em modo de antevisão.
- Tipo: booliano (detalhes)
- sectionpreview
Executar a análise em modo de antevisão (também ativa o modo de antevisão).
- Tipo: booliano (detalhes)
- disabletoc
Omitir a tabela de conteúdo no resultado.
- Tipo: booliano (detalhes)
- useskin
Aplicar o tema selecionado ao resultado do analisador sintático. Pode afetar as seguintes propriedades: text, langlinks, headitems, modules, jsconfigvars e indicators.
- Um dos seguintes valores: apioutput, fallback, minerva, vector, vector-2022
- 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: 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 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: GadgetDefinition, Scribunto, css, javascript, json, sanitized-css, text, unknown, wikitext
- mobileformat
Devolver o resultado da análise sintática numa forma adequada para dispositivos móveis.
- Tipo: booliano (detalhes)
- 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 wiki.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na página de testes]
- Fazer a análise sintática do texto 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]