Extension:TextExtracts/zh

此随附于MediaWiki 1.34及更高版本。 因此您无需另外下载。 但是，您仍需遵循此页面提供的其他使用说明。
Category:Extensions bundled with MediaWiki 1.34/zh
This extension is under code stewardship review and not actively maintained (T256505). No new feature requests will be considered during this period.
Category:GPL licensed extensions/zh
TextExtracts
Category:Stable extensions/zh
API Category:API extensions/zh
描述 將页面内容的纯文本或受限HTML的提取，提供給API
作者 Max Semenik (MaxSem留言)
快照跟随MediaWiki发布。
否
GNU通用公眾授權條款2.0或更新版本
下載
下載
Git [?]:
Category:Extensions in Wikimedia version control/zh
  • $wgExtractsRemoveClasses
  • $wgExtractsExtendOpenSearchXml
  • $wgExtractsExtendRestSearch
季度下載量 65 (Ranked 52nd)
正在使用的公开wiki数 2,046 (Ranked 189th)
前往translatewiki.net翻譯TextExtracts
問題 开启的任务 ·
Category:All extensions/zh
Category:Pages using deprecated NoteTA template#%20

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

安裝

  • 下载，并将解压后的TextExtracts移动到extensions/目录中。
    开发者和代码贡献人员应从Git安装扩展，输入：cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TextExtracts
  • 将下列放置在您的LocalSettings.php 的底部： 
    wfLoadExtension( 'TextExtracts' );
  • Yes 完成 – 在您的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)

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
另一个例子
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的软件时，需要注意一些事项。例如:。

  • 我们不推荐使用`exsentences`。 它不适用于HTML提取，并且在很多情况下都不存在。 例如，“Arm. gen. Ing. John Smith was a soldier.”（约翰·史密斯陆军上将是一名士兵。）将被视为4个句子。 我们也没有计划修复这一问题。
  • 行内图片会在响应中被移除（即使在HTML模式下也是如此）。这意味着，如果您正在使用Math扩展并在首段中使用公式，它们可能不会出现在摘要输出中。
  • 在HTML模式下，我们不能保证HTML格式是良好的。HTML结果可能是无效的或者存在格式错误。
  • 在纯文本格式下：
    • 引用可能不会被移除（参见phab:T197266）。
    • 如果一个段落以HTML标签结尾（例如ref标签），新行将会被移除（参见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配置变量提供的，该变量同时定义了其他将被排除的元素。

参见

Category:Extensions used on Wikimedia/zh#TextExtracts/zh
Category:API extensions/zh Category:All extensions/zh Category:ApiOpenSearchSuggest extensions/zh Category:Extensions available as Debian packages/zh Category:Extensions bundled with MediaWiki 1.34/zh Category:Extensions in Wikimedia version control/zh Category:Extensions included in BlueSpice/zh Category:Extensions included in Canasta/zh Category:Extensions included in Fandom/zh Category:Extensions included in Miraheze/zh Category:Extensions included in MyWikis/zh Category:Extensions included in ProWiki/zh Category:Extensions included in WikiForge/zh Category:Extensions included in wiki.gg/zh Category:Extensions used on Wikimedia/zh Category:GPL licensed extensions/zh Category:Pages using deprecated NoteTA template Category:SearchResultProvideDescription extensions/zh Category:Stable extensions/zh