Расширение:TextExtracts

Это расширение поставляется с MediaWiki 1.34 и выше. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.

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

Справка по расширениям MediaWiki

TextExtracts Статус релиза: стабильно
Реализация	API
Описание	Provides API with plain-text or limited HTML extracts of page content
Автор(ы)	Max Semenik (MaxSemобсуждение)
Политика совместимости	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	>= 1.41
Изменения в БД	Нет
Лицензия	GNU General Public License 2.0 или позднее
Скачать	Скачать расширение Git [?]: скачать текущую версию исходника репозиторий (Phabricator · GitHub) история изменений список разработчиков (GitHub) code review
Параметры $wgExtractsExtendOpenSearchXml $wgExtractsRemoveClasses
Используемые хуки ApiOpenSearchSuggest
Ежеквартальные загрузки	161 (Ranked 55th)
Использование общедоступными вики	2,046 (Ranked 189th)
Переведите расширение TextExtracts, если оно доступно на translatewiki.net
Проблемы	Открытые задачи · Сообщить об ошибке

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.

Установка

• Скачайте и распакуйте файл(ы) в папку с названием TextExtracts в вашей папке extensions/.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts
• Добавьте следующий код в конце вашего файла LocalSettings.php :

  wfLoadExtension( 'TextExtracts' );
  

•  Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Для использующих MediaWiki 1.26 или более ранние версии:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension(). Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.26 и более ранние), вместо wfLoadExtension( 'TextExtracts' );, вам необходимо использовать:

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

Настройки конфигурации

• $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 Этот модуль не может быть использован в качестве генератора.
Префикс	ex
Необходимые права	нет
Только POST?	Нет
Генерируемая справка	Текущее

---

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]

Another example

api.php?action=query&prop=extracts&exchars=100&explaintext&titles=Earth [попробуйте в ApiSandbox]

Результат
{ "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. Расширение:Всплывающие окна .

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

ЧЗВ

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

См. также

• Extension:InterwikiExtracts
• Page Content Service