Manual:Developing extensions/cs



Každé rozšíření se skládá ze tří částí:


 * 1) Nastavení
 * 2) Provedení
 * 3) Lokalizace

Minimální rozšíření se bude skládat z následující struktury:


 * MyExtension/extension.json
 * Ukládá instrukce nastavení. Název souboru musí být extension.json. (Před verzí MediaWiki 1.25 byly pokyny k nastavení v souboru  pojmenovaném podle přípony. Mnoho rozšíření má v tomto souboru PHP stále podložky zpětné kompatibility.)


 * MyExtension/includes/ (or MyExtension/src/)
 * Ukládá kód provedení PHP pro rozšíření.


 * MyExtension/resources/ (or MyExtension/modules/)
 * Ukládá prostředky na straně klienta, jako je JavaScript, CSS a LESS pro rozšíření.


 * MyExtension/i18n/*.json
 * Ukládá informace o laklizaci pro rozšíření.

Při vývoji rozšíření nahraďte MyExtension výše názvem svého rozšíření. Použijte názvy UpperCamelCase pro jeho adresář a soubor(y) PHP. Toto je obecná konvence pojmenování souborů. (Dobrým výchozím bodem pro vaše rozšíření je .)

Nastavení
Vaším cílem při psaní části nastavení je co nejvíce usnadnit instalaci rozšíření, takže uživatelé musí do LocalSettings.php přidat pouze tento řádek:

Pokud chcete, aby bylo vaše rozšíření uživatelsky konfigurovatelné, musíte definovat a zdokumentovat některé konfigurační parametry a nastavení vašich uživatelů by mělo vypadat nějak takto:

K dosažení této jednoduchosti musí váš instalační soubor provést řadu úkolů (podrobně popsaných v následujících částech):


 * zaregistrovat jakýkoli obslužný program médií, funkci analyzátoru, speciální stránku, vlastní značku XML a proměnnou používané vaším rozšířením.
 * definovat a/nebo ověřit jakékoli konfigurační proměnné, které jste definovali pro své rozšíření.
 * připravit třídy používané vaším rozšířením pro automatické načítání
 * určit, které části vašeho nastavení by měly být provedeny okamžitě a co je třeba odložit, dokud nebude inicializováno a nakonfigurováno jádro MediaWiki
 * definovat jakékoli další háčky potřebné pro vaše rozšíření
 * vytvořit nebo zkontrolovat jakékoli nové databázové tabulky požadované vaším rozšířením.
 * nastavit lokalizaci pro vaše rozšíření



Registrace funkcí na MediaWiki
MediaWiki uvádí všechna rozšíření, která byla nainstalována na stránce. Všechna rozšíření nainstalovaná na této wiki můžete například vidět na Special:Version.

Chcete-li to provést, přidejte podrobnosti rozšíření na extension.json. Záznam bude vypadat nějak takto:

Mnoho polí je volitelných, ale přesto je dobré je vyplnit. odkazuje na verzi schématu, do které je zapsán soubor. Dostupné verze jsou 1 a 2. Dokumentaci k této funkci najdete zde. Pokud nepotřebujete podporovat starší verzi MediaWiki, vyberte nejnovější verzi.

Kromě výše uvedené registrace musíte svou funkci také "zaháčkovat" do MediaWiki. Výše uvedené pouze nastaví stránku Special:Version. Způsob, jakým to uděláte, závisí na typu vašeho rozšíření. Podrobnosti naleznete v dokumentaci pro každý typ rozšíření:



Konfigurace uživatele vašeho rozšíření
Pokud chcete, aby váš uživatel mohl konfigurovat vaše rozšíření, budete muset zadat jednu nebo více konfiguračních proměnných. Je dobré dát těmto proměnným jedinečný název. Měli by také dodržovat konvence pro názvy MediaWiki (např. globální proměnné by měly začínat $wg).

Pokud se například vaše rozšíření jmenuje "MyExtension", možná budete chtít pojmenovat všechny konfigurační proměnné tak, aby začínaly. Je důležité, aby žádné jádro MediaWiki nezačínalo své proměnné tímto způsobem a vy jste odvedli rozumnou práci, abyste zjistili, že žádné z publikovaných rozšíření nezačíná své proměnné tímto způsobem. Uživatelé nebudou ochotni volit mezi vaším rozšířením a některými dalšími rozšířeními, protože jste zvolili překrývající se názvy proměnných.

Je také dobré zahrnout do poznámek k instalaci rozsáhlou dokumentaci všech konfiguračních proměnných.

Zde je příklad boiler plate, kterou lze použít pro začátek:

Všimněte si, že po volání  globální proměnná   neexistuje. Pokud proměnnou nastavíte např. v, pak se výchozí hodnota uvedená v extension.json nepoužije.

Další podrobnosti o tom, jak používat globální proměnnou uvnitř vlastních rozšíření, naleznete v.



Příprava kurzů pro automatické načítání
Pokud se rozhodnete pro implementaci svého rozšíření používat třídy, MediaWiki poskytuje zjednodušený mechanismus, který pomáhá PHP najít zdrojový soubor, kde se nachází vaše třída. Ve většině případů by to mělo eliminovat potřebu psát vlastní metodu.

Chcete-li použít mechanismus automatického načítání MediaWiki, přidejte položky do pole. Klíčem každé položky je název třídy. Hodnota je soubor, ve kterém je uložena definice třídy. U jednoduchého rozšíření jedné třídy má třída obvykle stejný název jako rozšíření, takže vaše sekce automatického načítání může vypadat takto (rozšíření se jmenuje MyExtension):

Název souboru je relativní k adresáři, ve kterém je soubor extension.json.

U složitějších rozšíření je třeba zvážit namespaces. Podrobnosti viz Příručka:Extension.json/Schema#AutoloadNamespaces.



Definování dalších háčků
Podívejte se na stránku.



Přidávání databázových tabulek
Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

Pokud vaše rozšíření potřebuje přidat vlastní databázové tabulky, použijte háček. Další informace o použití naleznete na stránce s příručkou.



Nastavit lokalizaci
Více vám řekneː
 * Lokalizace (souhrn)



Přidat protokoly
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 stránku jak se to dělá.

Handling dependencies
Assume that an extension requires the presence of another extension, for example because functionalities or database tables are to be used and error messages are to be avoided in case of non-existence.

For example the extension requires the presence of the extension  for certain functions.

One way to specify this would be by using the  key in extension.json.

Otherwise, some ideas to figure this out:

This should work at least from 1.23 up to 1.35.

Lokalizace
Pokud chcete, aby bylo vaše rozšíření používáno na wiki, které mají vícejazyčnou čtenářskou obec, budete muset do svého rozšíření přidat podporu lokalizace.



Ukládat zprávy v &lt;language-key>.json
Uložte definice zpráv do lokalizačního souboru JSON, jednu pro každý jazykový klíč, do kterého je vaše rozšíření přeloženo. Zprávy se ukládají pomocí message key a zprávy samotné pomocí standardního formátu JSON. Každé ID zprávy by mělo být malé a může neobsahovat mezery. Každý klíč by měl začínat malým názvem rozšíření. Příklad najdete v rozšíření MobileFrontend. Zde je příklad minimálního souboru JSON (v tomto případě en.json):

en.json



Dokumentaci zpráv uložte do souboru qqq.json
Dokumentace ke klíčům zpráv může být uložena v souboru JSON pro pseudojazyk s kódem qqq. Dokumentace k výše uvedenému příkladu může být:

qqq.json:



Načtěte lokalizační soubor
V souboru extension.json definujte umístění souborů zpráv (např. v adresáři i18n/):



Použijte wfMessage v PHP
V kódu nastavení a implementace nahraďte každé doslovné použití zprávy voláním. Ve třídách, které implementují (stejně jako některé další, jako jsou podtřídy SpecialPage), můžete místo toho použít. Example:

Use mw.message in JavaScript
It's possible to use i18n functions in JavaScript too. Look at for details.

Extension types
Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:


 *  Subclassing:  MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
 *  – Subclasses of the class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom PHP code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds Google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as  or   are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
 *  – you can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Support other core versions
There are two widespread conventions for supporting older versions of MediaWiki core:


 * Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
 * Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki need to use the  branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Extension maintainers should declare with the  parameter of the Extension template which convention they follow.

Publishing
To autocategorize and standardize the documentation of your existing extension, please see. To add your new extension to this Wiki:

Deploying and registering
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. Consult.

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at.

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.

Help documentation
You should provide public domain help documentation for features provided by your extension. is a good example. You should give users a link to the documentation via the function.

Providing support / collaboration
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.