Extension:TextExtracts/pl

To rozszerzenie jest dodawane do pakietu MediaWiki od wersji 1.34 i wyższych. W związku z tym nie musi być ponownie pobierane. Niemniej jednak wciąż musisz wykonać inne podane instrukcje.

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

Podręcznik rozszerzeń MediaWiki

TextExtracts Status wydania: stabilne
Realizacja	API
Opis	Provides API with plain-text or limited HTML extracts of page content
Autor(zy)	Max Semenik (MaxSemdyskusja)
Polityka zgodności	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	>= 1.41
Zmiany w bazie danych	Nie
Licencja	GNU General Public License 2.0 or later
Pobieranie	Download extension Git [?]: Pobierz Git master przeglądaj repozytorium (Phabricator · GitHub) historia wprowadzeń repository contributors (GitHub) ocena kodu
Parametry $wgExtractsExtendOpenSearchXml $wgExtractsRemoveClasses
Użyte haki ApiOpenSearchSuggest
Quarterly downloads	168 (Ranked 50th)
Public wikis using	2,046 (Ranked 189th)
Przetłumacz rozszerzenie TextExtracts jeżeli jest dostępne na translatewiki.net
Problemy	Otwarte zadania · Zgłoś błąd

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.

Instalacja

• Pobierz i umieść plik(i) w katalogu o nazwie TextExtracts w folderze 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
• Dodaj poniższy kod na dole twojego pliku LocalSettings.php :

  wfLoadExtension( 'TextExtracts' );
  

•  Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników używających wersji MediaWiki 1.26 lub wcześniejszej:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia z wykorzystaniem wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.26 i wcześniejsze), zamiast wfLoadExtension( 'TextExtracts' ); użyj:

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

Ustawienia konfiguracyjne

• $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 Ten moduł nie może być użyty jako generator.
Prefiks	ex
Wymagane uprawnienia	brak
Tylko POST?	Nie
Wygenerowana pomoc	Aktualna

---

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 [wypróbuj w ApiSandbox]

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

Caveats

There are various things to be aware of when using the API or software that uses the API e.g. Rozszerzenie:Podglądy strony .

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

FAQ

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

Zobacz też

• Extension:InterwikiExtracts
• Page Content Service