Extensión:TextExtracts

This extension is under code stewardship review and not actively maintained. (T256505) No new feature requests will be considered during this period.

Manual de extensiones de MediaWiki

TextExtracts Estado de la versión: estable
Implementación	API
Descripción	Provides API with plain-text or limited HTML extracts of page content
Autor(es)	Max Semenik (MaxSemdiscusión)
Política de compatibilidad	Se publican nuevas instantáneas junto con MediaWiki. La rama maestra no es retrocompatible.
Cambios en la base de datos	No
Parámetros $wgExtractsRemoveClasses $wgExtractsExtendOpenSearchXml $wgExtractsExtendRestSearch
Ganchos utilizados ApiOpenSearchSuggest SearchResultProvideDescription
Licencia	Licencia Pública General de GNU 2.0 o posterior
Descargar	Descargar la extensión. Git [?]: Explorar el repositorio (Phabricator · GitHub) revisión de código historial de cambios Download source tarball
Traduce la extensión TextExtracts si está disponible en translatewiki.net
Incidentes	Tareas abiertas · Reportar un error

The TextExtracts extension provides an API which allows retrieval of plain-text or limited HTML (HTML with content for some CSS classes removed) extracts of page content.

Instalación

Esta extensión viene con MediaWiki 1.34 y versiones posteriores, así que no necesitas descargarla. Las instrucciones de configuración restantes aún deben seguirse.

• Descarga y mueve la carpeta TextExtracts extraída a tu directorio extensions/.
  Los desarrolladores y contribuidores de código deberían instalar la extensión desde Git en su lugar, usando:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts
  

• Añade el siguiente código en la parte final de tu archivo LocalSettings.php :

  wfLoadExtension( 'TextExtracts' );
  

• Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Preferencias de configuración

• $wgExtractsRemoveClasses is an array of <tag>, <tag>.class, .<class>, #<id> which will be excluded from extraction.

• For example, $wgExtractsRemoveClasses[] = 'dl'; removes indented text, often used for non-templated hatnotes that are not desired in summaries.

• extension.json defines the defaults, of which the class "noexcerpt" is one - this may be added to any template to exclude it.

• $wgExtractsExtendOpenSearchXml defines whether TextExtracts should provide its extracts to the Opensearch API module.

The default is false.

API

extracts
Returns plain-text or limited HTML extracts of the given pages Este módulo no puede ser utilizado como de generador.
Prefijo	ex
Derechos requeridos	Ninguno
¿Correo sólo?	No
Ayuda generada	Actual

prop=extracts (ex)

(main | query | extracts)

• This module requires read rights.
• Source: TextExtracts
• License: GPL-2.0-or-later

Returns plain-text or limited HTML extracts of the given pages.

• https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:TextExtracts#API

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]

Otro ejemplo

api.php?action=query&prop=extracts&exchars=100&explaintext&titles=Earth [Prueba en ApiSandbox]

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. Extensión: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).

Véase también

• Extension:InterwikiExtracts
• Page Content Service
• API:Consigue los contenidos de una página