Ajuda da API MediaWiki
Esta é uma página de documentação da API 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
Analisa o conteúdo e retorna a saída do analisador.
Veja os vários módulos de suporte de action=query para obter informações da versão atual de uma página.
Há várias maneiras de especificar o texto para analisar:
- Especifique uma página ou revisão, usando page, pageid, ou oldid.
- Especifica o conteúdo explicitamente, usando text, title, revid e contentmodel.
- Especifique apenas um resumo a analisar. prop deve ter um valor vazio.
- title
Título da página ao qual o texto pertence. Se omitido, contentmodel deve ser especificado e API será usado como título.
- text
Texto para analisar. Use title ou contentmodel para controlar o modelo de conteúdo.
- revid
ID da revisão, para
{{REVISIONID}}
e variáveis similares.- Tipo: inteiro
- summary
Sumário para analisar.
- page
Analisa o conteúdo desta página. Não pode ser usado em conjunto com text e title.
- pageid
Analisa o conteúdo desta página. Sobrepõe page.
- Tipo: inteiro
- redirects
Sepage ou pageid é definido com um redirecionamento, resolva-o.
- Tipo: booleano (detalhes)
- oldid
Analise o conteúdo desta revisão. Substitui page e pageid.
- Tipo: inteiro
- prop
Qual pedaço de informação obter:
- text
- Fornece o texto analisado do texto wiki.
- langlinks
- Fornece os links de idiomas do texto wiki analisado.
- categories
- Fornece as categorias no texto wiki analisado.
- categorieshtml
- Fornece a versão HTML das categorias.
- links
- Fornece os links internos do texto wiki analisado.
- templates
- Fornece a predefinição no texto wiki analisado.
- images
- Fornece as imagens no texto wiki analisado.
- externallinks
- Fornece os links externos no texto wiki analisado.
- sections
- Fornece as seções no texto wiki analisado.
- revid
- Adiciona o ID da 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 do ResourceLoader usados na página. Para carregar, use
mw.loader.using()
. Contudo, jsconfigvars ou encodedjsconfigvars deve ser solicitado conjuntamente com modules. - jsconfigvars
- Fornece as variáveis de configuração JavaScript específicas da página. Para aplicar, use
mw.config.set()
. - encodedjsconfigvars
- Fornece as variáveis de configuração JavaScript específicas da página como uma string JSON.
- indicators
- Fornece o HTML de indicadores de status de página utilizados na página.
- iwlinks
- Fornece links interwiki no texto wiki analisado.
- wikitext
- Fornece o texto wiki original que foi analisado.
- properties
- Fornece várias propriedades definidas no texto wiki analisado.
- limitreportdata
- Fornece o relatório limite de uma forma estruturada. Não informa dado, quandodisablelimitreport está definido.
- limitreporthtml
- Retorna a versão HTML do relatório de limite. Não retorna dados quando disablelimitreport está definido.
- parsetree
- A árvore de análise XML do conteúdo da revisão (requer modelo de conteúdo
wikitext
) - parsewarnings
- Fornece os avisos que ocorreram ao analisar o conteúdo (como wikitexto).
- parsewarningshtml
- Fornece os avisos que ocorreram durante a análise de conteúdo (como HTML).
- headitems
- Obsoleto. Fornece itens para colocar no
<head>
da página.
- Valores (separados com | ou alternativos): 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
- Padrão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
Classe CSS usada para envolver a saída do analisador.
- Padrão: mw-parser-output
- parsoid
Gerar HTML conforme à especificação MediaWiki DOM usando o Parsoid.
- Tipo: booleano (detalhes)
- pst
Faz uma transformação pré-salvar na entrada antes de analisá-la. Apenas válido quando usado com texto.
- Tipo: booleano (detalhes)
- onlypst
Faz uma transformação pré-salvar (PST) na entrada, mas não analisa. Retorna o mesmo texto wiki, depois que um PST foi aplicado. Apenas válido quando usado com text.
- Tipo: booleano (detalhes)
- effectivelanglinks
- Obsoleto.
Inclui links de idiomas fornecidos por extensões (para uso com prop=langlinks).
- Tipo: booleano (detalhes)
- section
Apenas analise o conteúdo deste número de seção.
Quando new, analise text e sectiontitle como se adicionasse uma nova seção a página.
new é permitido somente ao especificar text.
- sectiontitle
Novo título de seção quando section é new.
Ao contrário da edição de páginas Isso não recai sobre summary quando omitido ou vazio.
- disablepp
- Obsoleto.
Use disablelimitreport em vez.
- Tipo: booleano (detalhes)
- disablelimitreport
Omita o relatório de limite ("Relatório de limite NewPP") da saída do analisador.
- Tipo: booleano (detalhes)
- disableeditsection
Omita os links da seção de edição da saída do analisador.
- Tipo: booleano (detalhes)
- disablestylededuplication
Não desduplica as folhas de estilo inline na saída do analisador.
- Tipo: booleano (detalhes)
- showstrategykeys
Incluir, ou não, informação da estratégia interna de fusão em jsconfigvars.
- Tipo: booleano (detalhes)
- generatexml
- Obsoleto.
Gerar XML parse tree (requer modelo de conteúdo
wikitext
, substituído por prop=parsetree).- Tipo: booleano (detalhes)
- preview
Analisar no mode de visualização.
- Tipo: booleano (detalhes)
- sectionpreview
Analise no modo de visualização de seção (também permite o modo de visualização).
- Tipo: booleano (detalhes)
- disabletoc
Omitir tabela de conteúdos na saída.
- Tipo: booleano (detalhes)
- useskin
Aplique a skin selecionada na saída do analisador. Pode afetar as seguintes propriedades: langlinks, headitems, modules, jsconfigvars, indicators.
- Um dos seguintes valores: apioutput, fallback, monobook, timeless, vector, vector-2022
- contentformat
Formato de serialização de conteúdo usado para o texto de entrada. Válido apenas 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 deve ser especificado e o padrão será o modelo do título especificado. Válido apenas quando usado com text.
- Um dos seguintes valores: css, javascript, json, text, unknown, wikitext
- Analisa uma página.
- api.php?action=parse&page=Project:Sandbox [abrir na página de testes]
- Analisa texto wiki.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na página de testes]
- Analisa texto wiki, especificando o título da página.
- api.php?action=parse&text={{PAGENAME}}&title=Test [abrir na página de testes]
- Analisa uma sumário.
- api.php?action=parse&summary=Some+[[link]]&prop= [abrir na página de testes]