Manual:Special pages/cs

Speciální stránky jsou stránky, které generuje systém až v okamžiku zavolání, obvykle za účelem vykonání určité specifické funkce. Taková speciální stránka může vygenerovat třeba seznam všech stránek, na kterých se nachází minimálně jeden odkaz na externí webovou stránku, nebo nabízet formulář, jehož prostřednictvím mohou uživatelé poskytovat zpětnou vazbu. Speciální stránky mají svůj vlastní jmenný prostor (Speciální:) ale nedají se editovat, tím se liší od ostatních stránek. Nové speciální stránky mohou vytvářet pouze. Ale pracují s nimi uživatelé, kterým se zobrazují na stránce s přehledem dostupných speciálních stránek Special:SpecialPages. Některé speciální stránky jsou ale dostupné jen uživatelům s odpovídajícím oprávněním. Některé speciální stránky se v tomto přehledu nezobrazují vůbec, protože s nimi pracuje interně sama wiki.

Základní informace
Všechny vestavěné speciální stránky, které přicházejí s MediaWiki, se nazývají  a jsou umístěny v adresáři. Základní speciální stránky musí být zaregistrovány v základním seznamu umístěném v, aby je MediaWiki načetla. Speciální stránky vytvořené vývojáři třetích stran jsou obecně uloženy v adresáři  v jejich vlastním souboru nebo jako součást většího rozšíření. Všechny speciální stránky dědí z třídy s názvem, která je definována v. Při vytvoření nové speciální stránky lze definovat uživatelská práva potřebná pro přístup na stránku. Tato práva mimo jiné určují, zda se stránka zobrazí na Special:SpecialPages a zda je stránka zahrnuta do jiných stránek.

Speciální stránky mají také jedinečné názvy, které lze na wiki upravit. Obecná forma je "Special:Název stránky", kde lze přizpůsobit "Special" i "Název stránky". Speciální pseudo lze přeložit do jiných jazyků. Tento přeložený jmenný prostor lze vytvořit pomocí wikitextu    , na této wiki vkládá "    ". Jméno speciální stránky lze také předefinovat v systémové zprávě pro jazyk webu s obecným názvem speciální stránky jako ID.

Speciální stránka může nebo nemusí umožňovat vstup. Například Special:Export umožňuje uživateli definovat konkrétní stránku k exportu voláním Special:Export/Sun. Pokud speciální stránka umožňuje komplexní vstup, budou další parametry odeslány v řetězci dotazu složky URL ke zpracování, např. https://www.mediawiki.org/w/index.php?title=Special:Recentchanges&days=3&limit=250.

Základní šablona speciální stránky
Většina speciálních rozšíření stránek vyžaduje tři soubory:


 * Malý instalační soubor, který se načte při každém spuštění MediaWiki.
 * Soubor s většinou kódu.
 * Lokalizační soubor.

Konvence kódování MediaWiki definují tři soubory takto:


 * - Instalační soubor.
 * - Speciální kód stránky.

Umístěte všechny soubory do nového adresáře v adresáři  MediaWiki.

Zvláštní stránkovací soubor byste měli pojmenovat podle přípony. Například obsahuje soubor. Pokud vaše rozšíření používá více než jednu speciální stránku, budete potřebovat více názvů.

V níže uvedeném příkladu je název speciální stránky MyExtension.

Po vytvoření souborů uvedených níže přidáním následujícího řádku do LocalSettings.php povolíte rozšíření:

Instalační soubor
Příklad instalačního souboru pro :

Tento soubor registruje několik důležitých a povinných věcí:


 * Umístění třídy MediaWiki\Extension\MyExtension\Special.
 * Umístění lokalizačních souborů.
 * Novou speciální stránku a její název třídy.

Soubor speciální stránky
Soubor skupiny by měl obsahovat podtřídu   nebo jednu z jejích podtříd. Tento soubor se načte automaticky, když někdo požádá o speciální stránku. Níže uvedený příklad implementuje podtřídu SpecialMyExtension.

Potřebujete konstruktor, protože jeho první parametr pojmenovává vaši speciální stránku.

je hlavní funkce volaná při přístupu na speciální stránku. Tato funkce přepíše funkci. Předá jediný parametr, komponentu podstránky aktuálního titulku. Pokud například někdo následuje odkaz na Special:MyExtension/blah,  obsahuje "blah".

Wikitext a výstup HTML byste měli spustit přes. Nepoužívejte 'print' nebo 'echo' přímo při práci v uživatelském rozhraní wiki.

Pokud však svou speciální stránku používáte jako přístupový bod k vlastnímu XML nebo binárnímu výstupu, podívejte se na stránku.

Lokalizační soubor

 * Podívejte se na stránku, jak jej přeložit.

Všechny speciální stránky mají název, například.


 * Název se používá v prvcích a  na stránce rozšíření a na Special:SpecialPages.
 * Může to být cokoliv, ale mělo by to popisovat speciální stránku a rozšíření.
 * Je specifikováno prostřednictvím zprávy. Struktura zprávy je pár klíč-hodnota. Klíč,, musí být psán malými písmeny.

Příklad lokalizačního souboru v :

V dokumentaci ke zprávě :

Všimněte si, že ID by neměla začínat velkým písmenem a že mezera v ID by měla být zapsána v kódu jako podtržítko.

Zpráva -summary je volitelná. Je vytvořen automaticky nadřazenou třídou a zobrazen v horní části speciální stránky, obvykle pro stručný popis toho, co na něm může uživatel dělat. Pokud nedefinujete jeho obsah, bude použit pouze tehdy, když jej administrátoři wiki přizpůsobí na wiki.

Soubor aliasů
Můžete také internacionalizovat název speciální stránky vytvořením aliasů. Níže uvedený příklad používá soubor "MyExtension.i18n.alias.php". V tomto příkladu speciální stránka  registruje alias, takže stránka bude přístupná na   a   v němčině.

Přidejte svůj soubor aliasu do :

Přidat speciální aliasy stránky do :

Opět byste měli do ID napsat mezeru a do kódu podtržítko.

Pro záhlaví stránky a propojení platí obvyklá pravidla pro názvy stránek.

Pokud má  hodnotu true, malé písmeno se převede na velké a podtržítko se zobrazí jako mezera.

Například místo výše uvedeného bychom mohli použít, za předpokladu, že jsme jinde konzistentně identifikovali rozšíření jako.

Všimněte si, že v asociativním poli pro anglický jazyk je řetězec identifikující naši SpecialPage (v příkladu ) také platným názvem.

Všimněte si také, že první prvek musí být stejný jako klíč ! Jinak Special:Specialpages stránku nevypíše.

Skupina speciální stránky
Můžete nastavit, pod kterou skupinou se vaše speciální stránka objeví na Special:SpecialPages přepsáním  ve vaší podtřídě.

systémovou zprávu rozhraní, která se v angličtině překládá jako 'Media reports and uploads'; *     * @return string */   function getGroupName { return 'media'; }

Některé běžné hodnoty jsou 'login', 'maintenance', 'media', 'other', 'pagetools', 'redirects', 'users'. Přijímané hodnoty můžete vidět na Special:AllMessages (hledejte specialpages-group) nebo procházet wiki pomocí pseudojazyka 'qqx' na Special:SpecialPages?uselang=qqx ) a dívat se na nadpisy. Chcete-li použít zprávu rozhraní 'specialpages-group-media', zadejte slovo 'media'.

Pokud se vaše speciální stránka nevejde do žádného z předkonfigurovaných nadpisů, můžete přidat nový nadpis jeho přidáním do svého lokalizačního souboru, viz Lokalizační soubor).

Standardní skupiny stránek dodávané s MediaWiki jsou uvedeny v lokalizačním souboru. Například anglické zprávy jsou v  a začínají. Pokud chcete svou speciální stránku zařadit do kategorie, pak je zpráva. Hodnota tohoto klíče je text, který se zobrazuje jako název dané kategorie, například.

Pokud se vám zdá, že vaše speciální stránka nespadá do žádné ze stávajících kategorií, můžete vždy vytvořit novou. Do lokalizačního souboru vašeho rozšíření jednoduše vložte nový klíč pro pole. V tomto příkladu definujeme skupinu :

Nyní, za předpokladu, že jste v definici třídy nastavili návratovou hodnotu pro metodu  jako , znovu načtěte Special:SpecialPages, abyste viděli svou novou kategorii.

Konstruktor
Můžete přetížením konstruktoru inicializovat svá vlastní data, ale hlavním důvodem, proč byste to chtěli udělat, je změnit chování samotné třídy SpecialPage. Když zavoláte konstruktor základní třídy z vaší podřízené třídy, jsou k dispozici následující parametry:


 * string  název speciální stránky, jak je vidět v odkazech a adresách URL
 * string  uživatelské právo vyžaduje, např. "block" (blokovat) nebo "delete" (smazat); viz také Omezení přístupu na stránku
 * boolean  zda je stránka uvedena ve Special:Specialpages

Tím se inicializuje objekt OutputPage  s názvem a popisem vaší speciální stránky. Mělo by být vždy voláno z vaší metody execute.

Tato metoda vrací objekt OutputPage, ke kterému lze přistupovat, jak je popsáno níže. Stejně jako v příkladu kódu použijte

namísto zastaralé globální proměnné

Tato metoda vrací objekt WebRequest, ke kterému lze přistupovat, jak je popsáno níže. Stejně jako v příkladu kódu použijte

namísto zastaralé globální proměnné

Některé speciální stránky lze zahrnout z jiné stránky. Pokud například přidáte do wikitextu stránky, vloží se seznam posledních změn do stávajícího obsahu stránky.

Zahrnutí speciální stránky z jiné webové stránky je možné pouze v případě, že jste stránku prohlásili za zahrnutou v konstruktoru. Můžete to udělat přidáním následujícího do metody  po inicializaci nadřazené třídy:

Můžete také definovat svou speciální třídu stránky jako rozšíření třídy IncludableSpecialPage.

Funkce SpecialPage->včetně vrací booleovskou hodnotu, která vám říká, z jakého kontextu je speciální stránka volána: False, pokud se jedná o samostatnou webovou stránku, a true, pokud je zahrnuta z jiné webové stránky. Usually you will want to strip down the presentation somewhat if the page is being included.

This is the function which your child class should overload. It passes a single parameter, usually referred to cryptically as  (short for $parameter, as it is the parameter the users can feed to your special page). This parameter is the subpage component of the current title. For example, if someone follows a link to Special:MyExtension/blah,  will contain "blah".

Nápověda
It's useful to add help pages on MediaWiki.org, where they'll be translatable. To make sure users find your help page, it's advisable and very simple for your special page to link the help page in question:

OutputPage.php
OutputPage.php contains the class definition for objects of type. You can get an object of this class from your SpecialPage using

The variablename $output is, of course, arbitrary. Whatever you call it, this is the variable you will use the most, because it is the way to send output to the browser (no, you don't use  or  ). If you want to use it somewhere, declare the variable global:

If you want to, you can create multiple OutputPage objects in different methods in your SpecialPage extension. They will add to the output in the order they are executed.

You can inspect the OutputPage class by viewing  (indeed, all of these can be inspected), but there are a few methods you should definitely know about.

Essentially the quick and dirty substitute for. It takes your input and adds it to the buffer: no questions asked. In the below action, if  contains user-data, it could easily have XSS, evil stuff, or the spawn of Satan injected in. You're better off using escaping (such as with the php function htmlentities) or the XML builders class to build trusted output.

For most output, you should be using this function. It's a bit of a black magic function: wikitext goes in, HTML comes out, and a whole lotta arcane code and demon summonings happen in between.

What's worth noting is that the parser will view your chunks as cohesive wholes and paragraph accordingly. That is...

Will output three lists with one item each, which probably wasn't intended.

Note however, if you just want to insert a system message and have it treated like parsed wikitext, you can use code like. This will not have the issue with nested parser calls mentioned above.

workaround #1
Important: these work arounds are only needed if you are making a transcludable special page. Normal special pages do not need these.

As a workaround, you can have your extensions convert Wikitext to HTML using a separate Parser object and then use. Příklad:

workaround #2
I tried the above, and found that the same problem now applied to any tags in the transcluded text. This won't be a problem for a lot of extensions, but the extension I was writing was intended to show wikitext from another page as part of its functionality, so this was a problem.

The process for parsing a page which transcludes a special page seems to be this:


 * 1) Replace  with a UNIQ-QINU marker (because SpecialPage output is expected to be ready-to-output HTML)
 * 2) Replace any tags with QINU markers as above
 * 3) Parse everything else from wikitext to HTML
 * 4) Replace all QINU markers with their respective stored values, in a single pass

The process for parsing a page which transcludes a non-special page, though, is apparently like this:


 * 1) Replace  or  with contents of transcluded page (because transcluded pages contain unparsed wikitext)
 * 2) Replace any tags with QINU markers as above
 * 3) Parse everything else from wikitext to HTML
 * 4) Replace all QINU markers with their respective stored values, in a single pass

The problem is apparently that in the earlier case, the parsing of the SpecialPage's wiki text is lacking the final QINU decoding step (why?), so all the QINU markers are left undecoded. (This may be a leftover from using the same syntax to invoke transclusion of a wikitext page, which is just pasted straight into the host page's wikitext contents and parsed, as is used to invoke transclusion of a SpecialPage, which must not be parsed at all. Wherever the code is that decides "wait, this is a special page -- replace it with a QINU", it should be doing the extra unstripGeneral before doing the QINU substitution.)

So I just did the following -- after this line: ...I added these lines (the second one is only because the function definition for the first one recommends it): Since I have now documented this, of course, I will now find a tragic flaw with it and feel really stupid... but as long as it seems to be working, I had to note it here. (It is also important to note the problem with work-around #1.) Also, I have only tested this with MediaWiki 1.10.1. The problem still exists under MW 1.14, but this solution may or may not work. --Woozle 18:26, 9 April 2009 (UTC)

An error page is shown. The arguments  and   specify keys into $this->msg, not text. Například:


 * 'error' refers to the text "".
 * 'badarticleerror' refers to the text "".

You can also specify message objects or add parameters:

WebRequest.php
The class is used to obtain information from the GET and POST arrays. Using this is recommended over directly accessing the superglobals. The WebRequest object is accessible from extensions by using the.

Database.php
MediaWiki has a load of convenience functions and wrappers for interacting with the database, using the class. It also has an interesting load balancing scheme in place. It's recommended you use these wrappers. Check out  for a complete listing of all the convenience functions, because these docs will only tell you about the non-obvious caveats. Viz.

User.php
The class is used to represent users on the system. SpecialPage->getUser should be used to obtain a User object for the currently logged in user. The use of the global  is deprecated

Title.php
Title represents the name of a page in the wiki. This is useful because MediaWiki does all sorts of fun escaping and special case logic to page names, so instead of rolling your own convert title to URL function, you create a Title object with your page name, and then use  to get a URL to that page.

To get a title object for your special page from outside of the special page class, you can use. It will give you a localised title in the wiki's language.

Vlastní speciální stránky
There are various ways to provide your own special pages not bundled within MediaWiki:


 * One method is to install an extension that generates a form to create or edit an article. A list of extensions currently available, can be found at.
 * You can also write an extension which provides your own special page. Writing your own extension requires PHP coding skill and comfort with object oriented design and databases also is helpful.  You will also need to know how to use code to create and edit MediaWiki articles. For more information, please see this discussion.
 * You can also display a custom page through JavaScript, in place of the default error message "Unknown special page" (or the "This page is intentionally left blank." message, if using a subpage of Special:BlankPage). In MediaWiki:Common.js, check for, then hide the MediaWiki-generated content (just appendCSS  ), and inject custom HTML  into the   or  . For an example, see meta:User:Krinkle/Tools/Real-Time Recent Changes.

Nastavení názvu rozšíření
MediaWiki does not set the title of the extension, which is the developer's job. It will look for the name of the extension when Special:Specialpages is called or the special page is loaded. In the function execute( $par ) section, use OutputPage methods to title the extension like:

The place where the extension can be found (as specified by what is passed into the SpecialPage constructor) is the key--except that it is not capitalized because of, the internally used function that finds out the title (or, what they call description) of the special page,   the name. "ThisIsACoolSpecialPage"'s key would be "thisisacoolspecialpage."

Theoretically,  can be overloaded in order to avoid interacting with the message cache but, as the source code states: "Derived classes can override this, but usually it is easier to keep the default behavior.  Furthermore, this prevents the MediaWiki namespace from overloading the message, as below.

Lokalizace názvu rozšíření
So you've just installed a shiny new MediaWiki extension and realize: "Oh no, my wiki is in French, but the page is showing up as English!" Most people wouldn't care, but it's actually a quite simple task to fix (as long as the developer used the method explained on this page). No noodling around in source code. Let's say the name of the page is  and the name comes out to "List of Dirty Pages" but you want it to be (and excuse my poor French) "Liste de Pages Sales". Well, it's as simple as this:


 * 1) Navigate to MediaWiki:DirtyPages, this page may not exist, but edit it anyway
 * 2) Insert "Liste de Pages Sales" and save

And voilà (pardon the pun), the change is applied.

This is also useful for customizing the title for your wiki within your language: for instance, the developer called it "List of Dirty Pages" but you don't like that name, so you rename it "List of Pages needing Cleanup". Check out Special:Allmessages to learn more.

Also, if your extension has a large block of text that does change, like a warning, don't directly output the text. Instead, add it to the message cache and when the time comes to output the text in your code, do this:

Then this message too can be customized at MediaWiki:Dirtypageshelp.

See also.

Do not display your Special Page on Special:SpecialPages
Sometimes you may want to limit the visibility of your Special Page by removing it from Special:SpecialPages and making it visible to only those users with a particular right. You can do this in the constructor by passing in a  parameter; e.g., “editinterface”, a right only assigned to sysops by default; see the User rights manual for other available user rights.

Or you can create your own right in the setup file and assign it to sysops, e.g.:

and then call the constructor with your right:

Prevent access to your Special Page
Even if you restrict your page in the constructor, as mentioned above, it will still be viewable directly via the URL, e.g. at Special:MySpecialPage. In order to actually limit access to your SpecialPage you must call in the   method.

If you need more fine-grained control over permissions, you can override, and/or add whatever permissions-checking is required for your extension.

Disabling Special:UserLogin and Special:UserLogout pages
In LocalSettings.php you can use the to unset unwanted built-in special pages. See "making a few SpecialPages restricted" if you need conditional unsetting of special pages for example for certain user groups. The general message "You have requested an invalid special page." is shown if users try to access such unset special pages.

A different approach would be to use the DisabledSpecialPage callback. This approach may be preferred if you're only disabling the special page "temporarily", because the default message in this case would say: "" instead of pretending the page does not exist at all. This gives clear hint that the page maybe activated at a later time.

It is also possible to add custom lengthy explanation of why you're disabling the special page, by giving a message key as the second argument of the callback. To do so first create a system message "MediaWiki:Userlogout-disable-reason" and write all the explanation there. The message will be parsed in a block format. Then in LocalSettings.php add:

Logování
V rámci MediaWiki se zaznamenávají veškeré akce uživatelů realizované v rámci wiki, neboť cílem je spolupráce a transparentnost. Podívejte se na jak se to dělá.

Změna překládané zprávy zobrazované na Special:Specialpages
Pokud jste vývojář rozšíření, tak určitě máte implementovanou funkci, což je metoda popsaná na této stránce v sekci o názvu speciální stránky.

Od MediaWiki verze 1.21, může být výchozí jméno speciální stránky přepsáno pomocí systémové zprávy. Tahle funkcionalita má svůj význam především pro administrátory stránek nikoliv pro vývojáře rozšíření. Je pro to nutné vytvořit ve jmenném prostoru pro systémové zprávy stránku, jejíž název je tvoří následující řetězec   kde je místo řetězce   uvedeno, malými písmeny kanonické jméno speciální stránky. Konkrétně, pokud nechcete, aby se pro vaši jazykovou verzi zobrazoval výchozí překlad speciální stránky, musíte nejprve zjistit kanonické jméno této speciální stránky, které může být dejme tomu "Special:MyLittlePage". Pak máte dvě možnosti. Jednou z nich je vytvoření nové systémové zprávy. Nejprve si zvolíte nové kanonické jméno. Dejme tomu "MyLittleGroup", pak vytvoříte ve jmenném prostoru MediaWiki podle výše uvedeného schématu stránku "MediaWiki:Specialpages-specialpagegroup-mylittlepage", do níž napíšete zvolený řetězec nového kanonického jména, tedy "MyLittleGroup". "Special:MyLittlePage" se pak bude zobrazovat jako "MyLittleGroup", kterou pak lze lokalizovat přes systémovou zprávu "MediaWiki:Specialpages-group-mylittlegroup".

Druhá varianta pak je, podívat se na seznam speciálních stránek přes url Special:SpecialPages&uselang=qqx, zjistit jak vypadá řetězec překládané systémové zprávy, a ten pak lokalizovat, jako ostatní systémové zprávy přes podstránku /cs

Unlisting the page from Special:Specialpages
To remove a special page from the Special:Specialpages altogether, pass a as a third parameter to the SpecialPage parent constructor, as described in the SpecialPage Constructor section of this page. If you need more complicated logic to determine whether the page should be listed or not, you can also override the  function, but using the constructor parameter is simpler.

Getting a list of special pages and their aliases on a wiki
Simply use the "siteinfo" API module to retrieve the information from the wiki like e.g. /api.php?action=query&meta=siteinfo&siprop=specialpagealiases.

Viz též

 * HTMLForm – Tutoriál, o tvorbě formulářů používaných na speciálních stránkách