Extension:TextExtracts

此擴充功能正處於程式碼管理審查階段，目前未積極維護。 (T256505) 在此期間，將不考慮任何新功能的請求。

MediaWiki扩展手册

TextExtracts [[Special:MyLanguage/Extension status| 发行状态：]] 稳定版
实现	API
描述	將页面内容的纯文本或受限HTML的提取，提供給API
作者	Max Semenik (MaxSem留言)
兼容性政策	快照跟随MediaWiki发布。 master分支不向后兼容。
数据库更改	否
参数 $wgExtractsRemoveClasses $wgExtractsExtendOpenSearchXml $wgExtractsExtendRestSearch
使用的函数钩 ApiOpenSearchSuggest SearchResultProvideDescription
许可证	GNU General Public License 2.0 or later
下載	下載扩展 Git [?]: 浏览存储库 (Phabricator · GitHub) Gerrit代码复核 Git提交日誌 下載原始碼（tarball壓縮）
前往translatewiki.net翻譯TextExtracts扩展
問題	开启的任务 · 报告错误

TextExtracts扩展提供一個API，可取回纯文本的页面内容、或提取受限HTML(HTML中的一些CSS样式被删除)的页面内容。

安裝

此扩展随附于MediaWiki 1.34及更新版本，因此您無需下載它。 但其余的配置的指示仍须依循執行。

• 下载文件，并解压TextExtracts文件夹到extensions/目录中。
  开发者和代码贡献人员应改从Git安装此扩展，输入：

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

• 請新增下列代码到您的LocalSettings.php 文件的底部：

  wfLoadExtension( 'TextExtracts' );
  

• 完成 – 請导航至您的wiki上的Special:Version，以验证此扩展已成功安装。

配置设置

• $wgExtractsRemoveClasses是<tag>, <tag>.class, .<class>, #<id>的陣列，会在提取时被排除。

  例如，$wgExtractsRemoveClasses[] = 'dl';删除缩进的文本，通常用于摘要中不需要的非模板頂註。

  extension.json定义了默认值，其中“noexcerpt”类是其中之一——可以将其添加到任何模板中以将该模板排除。

• $wgExtractsExtendOpenSearchXml定义TextExtracts是否应将其摘录提供给Opensearch API模块。 默认值为false。

API

extracts
回傳指定页面的纯文本或受限HTML的提取 此模块不能用作generator。
前缀	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]

另一个例子

api.php?action=query&prop=extracts&exchars=100&explaintext&titles=Earth [在Api沙盒中尝试]

结果
{ "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的软件时，需要注意一些事项。例如Extension:Popups（弹出窗口） 。

• 我们不推荐使用`exsentences`。 它不适用于HTML提取，并且在很多情况下都不存在。 例如，“Arm. gen. Ing. John Smith was a soldier.”（约翰·史密斯陆军上将是一名士兵。）将被视为4个句子。 我们也没有计划修复这一问题。
• 行内图片会在响应中被移除（即使在HTML模式下也是如此）。这意味着，如果您正在使用Math 扩展并在首段中使用公式，它们可能不会出现在摘要输出中。
• 在HTML模式下，我们不能保证HTML格式是良好的。HTML结果可能是无效的或者存在格式错误。
• 在纯文本格式下：
  • 引用可能不会被移除（参见phab:T197266）。
  • 如果一个段落以HTML标签结尾（例如ref标签），新行将会被移除（参见phab:T201946）。
  • 列表后的新行可能被移除（参见phab:T208132）。
  • 條目必須以導言段落開頭，方能生成摘要。 任何模板的使用、還有未閉合或空的HTML元素，皆可能導致文章無法預覽。 E.g. "<div></div>hello" will give an empty extract.

常见问题

如何从页面预览中移除内容？

TextExtracts将删除所有带有.noexcerpt类标记的元素。 这是由$wgExtractsRemoveClasses配置变量提供的，该变量同时定义了其他将被排除的元素。

参阅

• Extension:InterwikiExtracts
• Page Content Service
• API:获取页面内容