Extension:TextExtracts

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.

• Download and move the extracted TextExtracts folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cdextensions/
  gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'TextExtracts' );
  

• Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

• $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.

{
"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)..."
}
}
}
}

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.

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).

• Extension:InterwikiExtracts
• Page Content Service
• API:Get the contents of a page

• Stable extensions
• API extensions
• GPL licensed extensions
• Extensions in Wikimedia version control
• ApiOpenSearchSuggest extensions
• SearchResultProvideDescription extensions
• All extensions
• Extensions bundled with MediaWiki 1.34
• Extensions used on Wikimedia
• Extensions included in BlueSpice
• Extensions included in Canasta
• Extensions available as Debian packages
• Extensions included in Fandom
• Extensions included in Miraheze
• Extensions included in MyWikis
• Extensions included in ProWiki
• Extensions included in wiki.gg
• Extensions included in WikiForge

• Extensions without an image
• Extensions with release branches compatibility policy