Nápověda k MediaWiki API

Toto je automaticky generovaná dokumentační stránka k MediaWiki API.

Dokumentace a příklady: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

prop=info (in)

(main | query | info)

Tento modul vyžaduje oprávnění ke čtení.
Zdroj: MediaWiki
Licence: GPL-2.0-or-later

Získať základné informácie o stránke.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Info

Parametry:

K dispozícii sú aj ďalšie všeobecné parametre.

inprop

Ktoré dodatočné vlastnosti získať:

protection: Vypísať úroveň ochrany každej stránky.
talkid: ID diskusnej stránky pre každú nediskusnú stránku.
watched: Vypísať stav sledovania každej stránky.
watchlistlabels: Vypísať štítky zoznamu sledovaných pre každú stránku.
watchers: Počet sledovateľov, ak je to povolené.
visitingwatchers: Počet sledovateľov každej stránky, ktorí navštívili posledné úpravy danej stránky, ak je to povolené.
notificationtimestamp: Časová pečiatka upozornenia zo zoznamu sledovaných pre každú stránku.
subjectid: ID rodičovskej stránky pre každú diskusnú stránku.
associatedpage: Názov s predponou pridruženej obsahovej alebo diskusnej stránky.
url: Vráti plnú URL, URL úprav a kanonickú URL pre každú stránku.
readable: Zastaralý. Či môže používateľ čítať túto stránku. Namiesto toho použite intestactions=read.
preload: Zastaralý. Vráti text vrátený EditFormPreloadText. Namiesto toho použite preloadcontent, ktoré podporuje aj iné druhy prednačítaného textu.
preloadcontent: Vráti obsah, ktorý sa má zobraziť v editore, keď stránka neexistuje alebo pri pridávaní novej sekcie.
editintro: Vráti úvodné správy, ktoré by sa mali zobraziť používateľovi pri úprave tejto stránky alebo revízie, ako HTML.
displaytitle: Vráti spôsob, akým sa názov stránky skutočne zobrazuje.
varianttitles: Vráti zobrazovaný názov vo všetkých variantoch jazyka obsahu webu.
linkclasses: Vráti dodatočné CSS triedy (napr. farby odkazov) používané pre odkazy na túto stránku, ak by sa objavili na stránke s názvom inlinkcontext.

Hodnoty (oddělené | nebo alternativou.): associatedpage, displaytitle, editintro, linkclasses, notificationtimestamp, preloadcontent, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, watchlistlabels, preload, readable

inlinkcontext

Kontextový názov, ktorý sa má použiť pri určovaní dodatočných CSS tried (napr. farieb odkazov), keď inprop obsahuje linkclasses.

Typ: název stránky

Přijímá neexistující stránky

Predvolené: Hlavní strana

indefaultlinkcaption

Či považovať odkazy za odkazy s predvoleným popisom (popis je príponou cieľa odkazu a predchádza mu lomka, dvojbodka alebo začiatok reťazca). Môže to mať vplyv na vrátené triedy odkazov.

Typ: logická hodnota (boolean) (podrobnosti)

intestactions

Otestovať, či aktuálny používateľ môže vykonať určité akcie na stránke.

Hodnoty oddělujte pomocí | nebo alternativou.

Maximálny počet hodnôt je 50 (500 pre klientov s povolenými vyššími limitmi).

intestactionsdetail

Úroveň podrobností pre intestactions. Na riadenie formátu vrátených správ použite parametre errorformat a errorlang hlavného modulu.

boolean: Vrátiť logickú hodnotu pre každú akciu.
full: Vrátiť správy popisujúce, prečo je akcia zakázaná, alebo prázdne pole, ak je povolená.
quick: Ako full, ale s vynechaním nákladných kontrol.

Jedna z následujících hodnot: boolean, full, quick

Predvolené: boolean

intestactionsautocreate

Otestovať, či by vykonanie intestactions automaticky vytvorilo dočasný účet.

Typ: logická hodnota (boolean) (podrobnosti)

inpreloadcustom

Názov vlastnej stránky, ktorá sa má použiť ako prednačítaný obsah.

Používa sa iba vtedy, keď inprop obsahuje preloadcontent.

inpreloadparams

Parametre pre vlastnú stránku používanú ako prednačítaný obsah.

Používa sa iba vtedy, keď inprop obsahuje preloadcontent.

Hodnoty oddělujte pomocí | nebo alternativou.

Maximálny počet hodnôt je 50 (500 pre klientov s povolenými vyššími limitmi).

inpreloadnewsection

Vrátiť prednačítaný obsah pre novú sekciu na stránke namiesto novej stránky.

Používa sa iba vtedy, keď inprop obsahuje preloadcontent.

Typ: logická hodnota (boolean) (podrobnosti)

ineditintrostyle

Niektoré úvodné správy prichádzajú s voliteľnými obaľovacími rámami. Použite moreframes na ich zahrnutie alebo lessframes na ich vynechanie.

Používa sa iba vtedy, keď inprop obsahuje editintro.

Jedna z následujících hodnot: lessframes, moreframes

Predvolené: moreframes

ineditintroskip

Zoznam úvodných správ, ktoré sa majú odstrániť z odpovede. Použite, ak konkrétna správa nie je relevantná pre váš nástroj alebo ak je informácia sprostredkovaná iným spôsobom.

Používa sa iba vtedy, keď inprop obsahuje editintro.

Hodnoty oddělujte pomocí | nebo alternativou.

Maximálny počet hodnôt je 50 (500 pre klientov s povolenými vyššími limitmi).

ineditintrocustom

Názov vlastnej stránky, ktorá sa má použiť ako dodatočná úvodná správa.

Používa sa iba vtedy, keď inprop obsahuje editintro.

incontinue

Keď je dostupných viac výsledkov, použite toto na pokračovanie. Podrobnejšie informácie o tom, ako pokračovať v dotazoch, nájdete na mediawiki.org.

Příklady:

Získať informácie o stránke Hlavní strana.: api.php?action=query&prop=info&titles=Hlavn%C3%AD%20strana [otevřít v pískovišti]
Získať všeobecné informácie a informácie o ochrane stránky Hlavní strana.: api.php?action=query&prop=info&inprop=protection&titles=Hlavn%C3%AD%20strana [otevřít v pískovišti]

list=categorymembers (cm)

(main | query | categorymembers)

Tento modul vyžaduje oprávnění ke čtení.
Tento modul lze využívat jako generátor.
Zdroj: MediaWiki
Licence: GPL-2.0-or-later

Seznam všech stránek v dané kategorii.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categorymembers

Parametry:

K dispozícii sú aj ďalšie všeobecné parametre.

cmtitle

Ktorá kategória sa má vymenovať (povinné). Musí obsahovať predponu Kategorie:. Nemožno použiť spolu s cmpageid.

cmpageid

ID stránky kategórie, ktorá sa má vymenovať. Nemožno použiť spolu s cmtitle.

Typ: celé číslo

cmprop

Ktoré informácie zahrnúť:

ids: Pridá ID stránky.
title: Pridá názov a ID menného priestoru stránky.
sortkey: Pridá triediaci kľúč použitý na triedenie v kategórii (hexadecimálny reťazec).
sortkeyprefix: Pridá predponu triediaceho kľúča použitú na triedenie v kategórii (časť triediaceho kľúča čitateľná pre človeka).
type: Pridá typ, ako bola stránka kategorizovaná (page, subcat alebo file).
timestamp: Pridá časovú pečiatku zaradenia stránky.

Hodnoty (oddělené | nebo alternativou.): ids, sortkey, sortkeyprefix, timestamp, title, type

Predvolené: ids|title

cmnamespace

Zahrnúť iba stránky v týchto menných priestoroch. Upozorňujeme, že namiesto cmnamespace=14 alebo 6 možno použiť cmtype=subcat alebo cmtype=file.

Hodnoty (oddělené | nebo alternativou.): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

Na zadanie všetkých hodnôt použite *.

cmtype

Ktorý typ členov kategórie zahrnúť. Ignorované, keď je nastavené cmsort=timestamp.

Hodnoty (oddělené | nebo alternativou.): file, page, subcat

Predvolené: page|subcat|file

cmcontinue

Keď je dostupných viac výsledkov, použite toto na pokračovanie. Podrobnejšie informácie o tom, ako pokračovať v dotazoch, nájdete na mediawiki.org.

cmlimit

Maximální počet stránek k zobrazení.

Typ: celé číslo alebo max

Hodnota musí byť medzi 1 a 500.

Predvolené: 10

cmsort

Vlastnosť, podľa ktorej triediť.

Jedna z následujících hodnot: sortkey, timestamp

Predvolené: sortkey

cmdir

Smer triedenia.

Jedna z následujících hodnot: asc, ascending, desc, descending, newer, older

Predvolené: ascending

cmstart

Časová pečiatka, od ktorej sa má začať výpis. Možno použiť iba s cmsort=timestamp.

Typ: časová pečiatka (povolené formáty)

cmend

Časová pečiatka, pri ktorej sa má výpis skončiť. Možno použiť iba s cmsort=timestamp.

Typ: časová pečiatka (povolené formáty)

cmstarthexsortkey

Triediaci kľúč, od ktorého sa má začať výpis, ako ho vracia cmprop=sortkey. Možno použiť iba s cmsort=sortkey.

cmendhexsortkey

Triediaci kľúč, pri ktorom sa má výpis skončiť, ako ho vracia cmprop=sortkey. Možno použiť iba s cmsort=sortkey.

cmstartsortkeyprefix

Predpona triediaceho kľúča, od ktorej sa má začať výpis. Možno použiť iba s cmsort=sortkey. Má prednosť pred cmstarthexsortkey.

cmendsortkeyprefix

Predpona triediaceho kľúča, pred ktorou sa má výpis skončiť (nie pri nej; ak sa táto hodnota vyskytne, nebude zahrnutá!). Možno použiť iba s cmsort=sortkey. Má prednosť pred cmendhexsortkey.

cmstartsortkey

Zastaralý.

Namiesto toho použite cmstarthexsortkey.

cmendsortkey

Zastaralý.

Namiesto toho použite cmendhexsortkey.

Příklady:

Zobrazit prvních 10 stránek v Category:Physics: api.php?action=query&list=categorymembers&cmtitle=Category:Physics [otevřít v pískovišti]
Získat informace o prvních 10 stránkách v Category:Physics.: api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [otevřít v pískovišti]