Extension:TextExtracts/fr

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:TextExtracts and the translation is 18% complete.

Other languages:
Deutsch • ‎English • ‎català • ‎dansk • ‎español • ‎français • ‎italiano • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎中文 • ‎日本語 • ‎한국어
Manuel des extensions MediaWiki
OOjs UI icon advanced.svg
TextExtracts
État de la version : stable
Implémentation API
Description Provides API with plain-text or limited HTML extracts of page content
Auteur(s) Max Semenik (MaxSemtalk)
MediaWiki 1.23+
PHP 5.4+
Changements
base de données
Non
Licence GNU General Public License 2.0 or later
Téléchargement
Paramètres
  • $wgExtractsRemoveClasses
  • $wgExtractsExtendOpenSearchXml
Accroches utilisées
OpenSearchXml
ApiOpenSearchSuggest
Traduisez l’extension TextExtracts sur translatewiki.net
Vérifiez la matrice des utilisations et des versions.
Problèmes Tâches ouvertes · Signalez un bug

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

Download

Cette extension peut être récupérée directement depuis Git [?]:

  • Naviguer dans le code
  • Certaines extensions étiquettent les versions stables.
  • Chaque branche correspond à une version antérieure de MediaWiki Il y a aussi une branche master (maître) qui contient la dernière version alpha (elle peut nécessiter une version alpha de MediaWiki)

Décompressez l'instantané et placez le dans le répertoire extensions/TextExtracts/ de votre installation MediaWiki.

Si vous êtes familier de git et si vous avez un accès au shell de votre serveur, vous pouvez aussi obtenir l'extension de la manière suivante:

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

Installation

  • Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé TextExtracts dans votre dossier extensions/.
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
    wfLoadExtension( 'TextExtracts' );
    
  • Yes Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Pour les utilisateurs de MediaWiki 1.24 ou précédents :

Les instructions ci-dessous décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension() Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.24 ou précédent), à la place de wfLoadExtension( 'TextExtracts' );, vous devez utiliser :

require_once "$IP/extensions/TextExtracts/TextExtracts.php";

Configuration settings

  • $wgExtractsRemoveClasses is an array of <tag>, <tag>.class, .<class>, and #<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.
    TextExtracts.php 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




prop=extracts (ex)

(main | query | extracts)

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

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
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, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

Type: integer

Another example



Caveats

There are various things to be aware of when using the API

  • 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

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 global wgExtractsRemoveClasses.


See also