Расширение:TextExtracts
This extension comes with MediaWiki 1.34 and above. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.
This extension is under code stewardship review and not actively maintained (задача T256505). No new feature requests will be considered during this period.
| Для получения сводок в производственных средах рекомендуется использовать Page Content Service, который используется продуктами Викимедиа. |
 Статус релиза: стабильно |
|
|---|---|
| Реализация | API |
| Описание | Provides API with plain-text or limited HTML extracts of page content |
| Автор(ы) | Max Semenik (MaxSemобсуждение) |
| Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
| Изменения в БД | Нет |
| Лицензия | GNU General Public License 2.0 или позднее |
| Скачать | |
|
|
| Ежеквартальные загрузки | 106 (Ranked 54th) |
| Использование общедоступными вики | 2,046 (Ranked 189th) |
| Переведите расширение TextExtracts, если оно доступно на translatewiki.net | |
| Проблемы | Открытые задачи · Сообщить об ошибке |
Расширение "Text Extracts" предоставляет API, который позволяет извлекать из содержимого страницы обычный текст или ограниченный HTML (HTML с содержимым из некоторые классы CSS удалены).
Установка
- Скачайте и распакуйте файл(ы) в папку с названием
TextExtractsв вашей папкеextensions/.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts - Добавьте следующий код в конце вашего файла LocalSettings.php:
wfLoadExtension( 'TextExtracts' );
Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Настройки конфигурации
$wgExtractsRemoveClasses- это массив из <tag>, <tag>.class, .<class>, #<id> , который будет исключен из вывода.- Например,
$wgExtractsRemoveClasses[] = 'dl';удаляет отрезкованный текст, часто используемый для необработанных примечаний, которые не желаются в резюме. - extension.json определяет дефолты, из которых один из них - класс "noexcerpt" - это может быть добавлено в любой шаблон, чтобы исключить его.
- Например,
$wgExtractsExtendOpenSearchXmlопределяет, следует ли TextExtracts предоставлять свои выдержки в модуль API Opensearch. По умолчанию неверно.
API
| extracts | |
|---|---|
| Возвращает обычный текст или ограниченные HTML-выдержки из заданных страниц Этот модуль не может быть использован в качестве генератора. | |
| Префикс | ex |
| Необходимые права | нет |
| Только POST? | Нет |
| Генерируемая справка | Текущее |
| Документация ниже автоматически сгенерирована предварительной версией MediaWiki, используемой на этом сайте (MediaWiki.org); она доступна на служебной странице 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]
Другой пример:
| Результат |
|---|
{
"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)..."
}
}
}
}
|
Предостережения
Существуют различные вещи, о которых следует знать при использовании API или программного обеспечения, использующего API, например, Расширение:Всплывающие окна.
- Мы не рекомендуем использовать `exsentences`.(расширениями) Он не работает для HTML-выдержек и есть много крайних случаев, для которых он не существует. Например, "Генерал армии Инг. Джон Смит был солдатом". будет рассматриваться как 4 предложения. Мы не планируем это исправить.
- Встроенные изображения извлекаются из ответа (даже в режиме HTML). Это означает, что если вы используете расширение Math и используете формулы в главном разделе, они могут не появиться в выводе резюме.
- В режиме HTML мы не можем гарантировать хорошо сформированный HTML. Полученный HTML может быть недействительным или деформатированным (сломанным).
- В режиме простого текста:
- цитаты не могут быть удалены (см. phab:T197266)
- Если абзац заканчивается тегом HTML, например, тегом реф, новые строки могут быть выброшены (см. phab:T201946)
- новые строки могут быть выброшены после списков 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 удалит любой элемент, который отмечен классом .noexcerpt.
Это обеспечивается конфигурационной переменной $wgExtractsRemoveClasses (которая также определяет некоторые другие исключенные элементы).
См. также
| Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |
| Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |