Extension:TextExtracts/pl

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:TextExtracts and the translation is 36% complete.
Other languages:
English • ‎dansk • ‎español • ‎occitan • ‎polski • ‎português do Brasil • ‎中文 • ‎日本語 • ‎한국어
Podręcznik rozszerzeń MediaWiki
OOjs UI icon advanced.svg
TextExtracts
Status wydania: stabilne
Realizacja API
Opis Provides API with plain-text or limited HTML extracts of page content
Autor(zy) Max Semenik (MaxSemtalk)
MediaWiki 1.23+
PHP 5.4+
Zmiany w bazie danych Nie
Licencja GNU General Public License 2.0 or later
Pobieranie
Pobierz snapshot
Git [?]:
Parametry
  • $wgExtractsRemoveClasses
  • $wgExtractsExtendOpenSearchXml
Użyte haki
Przetłumacz rozszerzenie TextExtracts jeżeli jest dostępne na translatewiki.net
Sprawdź wykorzystywanie i matrycę wersji.
Problemy Otwarte zadania · Zgłoś błąd

The TextExtracts extension provides an API which allows to retrieve plain-text or limited HTML (HTML with content for some CSS classes removed) extracts of page content.

Download

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/TextExtracts/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows: 

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

Instalacja

  • Pobierz i umieść plik(i) w katalogu o nazwie TextExtracts w swoim katalogu extensions/.
  • Dodaj poniższy kod na dole swojego pliku LocalSettings.php: 
    wfLoadExtension( 'TextExtracts' );
  • Yes Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników mających wersję MediaWiki 1.26 lub wcześniejszą:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia, poprzez 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>, and #<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.
    TextExtracts.php 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)

Returns plain-text or limited HTML extracts of the given pages.

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
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, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

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

  • 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

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 global wgExtractsRemoveClasses.


Zobacz też

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:TextExtracts/pl&oldid=3200848"