Extensão:TextExtracts
Outdated translations are marked like this.
This extension comes with MediaWiki 1.34 and above. Assim, não precisa efetuar o download novamente. No entanto, ainda precisa seguir as outras instruções fornecidas.
This extension is under code stewardship review and not actively maintained (task T256505). No new feature requests will be considered during this period.
| For obtaining summaries in production environments, the Page Content Service is recommended and used by Wikimedia products. |
 Estado de lançamento: estável |
|
|---|---|
| Implementação | API |
| Descrição | Fornece API com texto simples ou extratos de HTML limitados do conteúdo da página |
| Autor(es) | Max Semenik (MaxSemdiscussão) |
| Política de compatibilidade | Lançamentos de capturas de ecrã junto com o MediaWiki. Original não é compatível com versões anteriores. |
| Alterações à base de dados | Não |
| Licença | GNU - Licença Pública Geral 2.0 ou superior |
| Transferência | |
|
|
| Quarterly downloads | 106 (Ranked 54th) |
| Public wikis using | 2,046 (Ranked 189th) |
| Traduza a extensão TextExtracts se ela estiver disponível em translatewiki.net | |
| Problemas | Tarefas em aberto · Reportar um erro |
A extensão TextExtracts fornece uma API que permite obter texto simples ou extratos de HTML limitado (HTML com conteúdo para algumas classes de CSS removidas) do conteúdo de página.
Instalação
- Exporte e coloque o ficheiro, ou ficheiros, num diretório chamado
TextExtracts, na sua pastaextensions/.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts - Acrescente o seguinte código ao fundo do ficheiro $LocalSettings:
wfLoadExtension( 'TextExtracts' );
Pronto – Na página especial Special:Version da sua wiki verifique se a extensão foi instalada.
Definições de Configuração
$wgExtractsRemoveClassesé uma matriz de <tag>, <tag>.class, .<class>, #<id> que irá ser excluída da extração.- Por exemplo,
$wgExtractsRemoveClasses[] = 'dl';remove o texto indentado, normalmente utilizado para "hatnotes" de não modelos que não desejados nos resumos.
- Por exemplo,
- extension.json defines as predefinições, das quais a classe "noexcerpt" é uma - isto poderá ser adicionado a qualquer modelo para excluí-lo.
$wgExtractsExtendOpenSearchXmldefines se "TextExtracts" deverá fornecer os seus extratos para o módulo da API Opensearch. A predefinição é "false".
API
| extracts | |
|---|---|
| Devolve texto simples ou extrações de HTML limitadas das páginas indicadas Este módulo não pode ser utilizado como um $generator. | |
| Prefixo | ex |
| Permissões requeridas | nenhuma |
| Só publicação? | Não |
| Ajuda gerada | Atual |
| A documentação a seguir é a saída de Special: |
prop=extracts (ex)
- This module requires read rights.
- Source: TextExtracts
- License: GPL-2.0-or-later
Returns plain-text or limited HTML extracts of the given pages.
Specific parameters:
Other general parameters are available.
- exchars
How many characters to return. Actual text returned might be slightly longer.
- Type: integer
- The value must be between 1 and 1,200.
- exsentences
How many sentences to return.
- Type: integer
- The value must be between 1 and 10.
- exlimit
How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)
- Type: integer or max
- The value must be between 1 and 20.
- Default: 20
- exintro
Return only content before the first section.
- Type: boolean (details)
- explaintext
Return extracts as plain text instead of limited HTML.
- Type: boolean (details)
- exsectionformat
How to format sections in plaintext mode:
- plain
- No formatting.
- wiki
- Wikitext-style formatting (== like this ==).
- raw
- This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
- One of the following values: plain, raw, wiki
- Default: wiki
- excontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Type: integer
Example:
- Get a 175-character extract
- api.php?action=query&prop=extracts&exchars=175&titles=Therion [open in sandbox]
Outro exemplo
api.php?
| Resultado |
|---|
{
"query": {
"pages": {
"9228": {
"pageid": 9228,
"ns": 0,
"title": "Earth",
"extract": "Earth, also called the world and, less frequently, Gaia, (or Terra in some works of science fiction)..."
}
}
}
}
|
Caveats
There are various things to be aware of when using the API or software that uses the API e.g. Extension:Popups.
- We do not recommend the usage of `exsentences`.
It does not work for HTML extracts and there are many edge cases for which it doesn't exist. For example "Arm. gen. Ing. John Smith was a soldier." will be treated as 4 sentences. We do not plan to fix this.
- Inline images are stripped from the response (even in HTML mode). This means if you are using the Math extension and using formulae in your lead section they may not appear in the summary output.
- In HTML mode we cannot guarantee well formed HTML. Resulting HTML may be invalid or malformed.
- In plaintext mode:
- citations may not be stripped (see phab:T197266)
- if a paragraph ends with an HTML tag e.g. ref tag, new lines may be dropped (see phab:T201946)
- new lines may be dropped after lists phab:T208132
- Articles must begin with the lead paragraph for an extract to be generated. The use of any template, and/or unclosed or empty HTML element may result in no preview for the article. E.g. "<div></div>hello" will give an empty extract.
FAQ
How can I remove content from a page preview/extract?
TextExtracts will strip any element that is marked with the class .noexcerpt.
This is provided by the $wgExtractsRemoveClasses configuration variable (which also defines some other excluded elements).
Consulte também
| Este extensão está a ser utilizado em um ou mais projetos da Wikimedia. Isso provavelmente significa que a extensão é estável e funciona bem o suficiente para ser usada por esses sites de alto tráfego. Procure o nome desta extensão nos arquivos de configuração CommonSettings.php e InitialiseSettings.php da Wikimedia para ver onde está instalado. Uma lista completa das extensões instaladas em um determinado wiki pode ser vista na página Special:Version do wiki. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |