Rozcestník pro vývojáře

Uživatelé

Správci wikiserverů

Vývojáři

Překladatelé

Toto je vysokoúrovňový přehled vývoje MediaWiki, obsahující odkazy na klíčové dokumenty, zdroje a nástroje dostupné vývojářům MediaWiki. Je vytvořena pro zkušené LAMP vývojáře, kteří mají zkušenosti s používáním MediaWiki.

• Pokud chcete použít Wikimedia web APIs, navštivte Web APIs hub
• Chcete-li přispět k vývoji software Wikimedie, vizte New Developers.
• Úvodního průvodce vývojem MediaWiki a rozšíření MediaWiki najdete na stránce Jak se stát hackerem MediaWiki.
• If you want to collaborate with other third-party MediaWiki users, the MediaWiki Stakeholders' Group (MWStake) is a MediaWiki user group consisting of MediaWiki developers, system administrators, users, consultants, and hosting providers.

Přehled

MediaWiki je software, na kterém běží Wikipedie, její sesterské projekty a tisíce dalších wiki po celém světě.

MediaWiki is written in the PHP programming language. It uses jQuery as the client JavaScript library.

MediaWiki is primarily written for the LAMP platform and runs on most operating systems. MediaWiki primarily uses the MySQL and MariaDB database servers.

Development happens in an open source style, is largely coordinated online, and supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

• Development discussion happens on various mailing lists and IRC channels. The main developer list is wikitech-l. The main developer IRC channels are #mediawiki and #wikimedia-dev.
• Source code is managed using the Git version control system.
• Code review for most projects is performed on Gerrit . Follow this tutorial to set up Git and Gerrit in order to submit patches.
• Bug reports and tasks for most projects are managed on Phabricator.
• Developers extending or interfacing with MediaWiki (instead of working on the core code) have several convenient extension points, including the API, the Hooks system and Skins – see the #Extending MediaWiki section of this page for an overview.

Klíčové dokumenty

Kód, jeho vývoj a konvence

• Pravidla pro vývojáře – přehled základních politik pro vývojáře.
• Konvence pro psaní kódu – vás seznámí s tím jak má vypadat kód pro MediaWiki.
• Zabezpečení kódu z hlediska vývojáře – vám pomůže napsat kód, který do MediaWiki nezavleče bezpečnostní díry.
• Pre-commit checklist – čtěte dřív, než uděláte commit svého kódu.
• Kontrola kódu v Gerritu – základní průvodce pro kontrolory změn před jejich odesláním do zdrojového kódu MediaWiki.
• Žádosti o komentář – přečtěte si, jaké změny ekosystému MediaWiki navrhují ostatní uživatelé, nebo nějaké navrhněte sami.

Testování a odstraňování chyb

• Jak odstraňovat chyby – návod k vychytávání chyb v MediaWiki.
• Manuál:Chyby a příznaky – přehled běžných chyb vyskytujících se na MediaWiki, a jejich příznaků.
• Testování prohlížečů – naučte se psát testy UI pro MediaWiki s použitím Selenia
• Unit testing – vás naučí jak psát unit testy pro MediaWiki s využitím PHPUnit.
• API integration tests – learn to write API integration tests for MediaWiki using Mocha.
• Security for developers – vás naučí jak psát bezpečný kód.

Architektura

• Manual:Code – přehled klíčových funkcí a proměnných, s nimiž se můžete setkat ve zdrojovém kódu MediaWiki.
• Database layout – přehled databázových schémat s nimiž pracuje MediaWiki.
• Global object variables – seznam vybraných klíčových globálních proměnných.
• Localisation – vás seznámí s tím jak funguje internacionalizace u MediaWiki.
• Manuál, je u této wiki jmenný prostor kde je soustředěna – dokumentace pro vývojáře.
• MediaWiki Class Reference – technická dokumentace, generovaná přímo ze zdrojového kódu MediaWiki. (Pozor: Vzájemné reference tříd (class) jsou poměrně komplikované, takže se ty stránky mohou načítat velmi pomalu.)
• MediaWiki Virtual Library (MVL) – manuály, postupy, a skupiny vybraných článků podle tématu.

Subsystémy

• API – API MediaWiki umožňuje přímý přístup k datům uloženým v databázích MediaWiki, na té nejvyšší úrovni.
• ContentHandler – je MediaWiki framework, který umožňuje obsah wiki stránky interpretovat různým způsobem, podle typu obsahu.
• Database access – přehled využití databází MediaWiki, včetně stručného průvodce, který vás provede tím, jak s nimi pracovat.
• Job queue – MediaWiki framework pro asynchronní zpracovávání náročných úloh.
• Messages API – MediaWiki framework pro lokalizaci zpráv v PHP či JavaScriptu.

Doplňky do MediaWiki

MediaWiki bylo navrženo tak, aby je bylo možno přizpůsobit bez změn „kódu jádra“. To zajišťuje, že lze upgradovat na novější verzi bez potřeby slučovat uživatelské úpravy do nové verze. V MediaWiki existuje šest hlavních bodů, kde mohou vývojáři přidávat nové funkce nebo měnit stávající vlastnosti. Těmito body jsou:

• API – Přístup k datům a metadatům v instanci MediaWiki prostřednictvím webového API.
• Manuál:Háčky (hooks) – umožňují něco provést vždy, když se zavolají.
• Parser functions – vytvoří nový příkaz, např.: {{#if|...|...|...}}
• Skins – mění vzhled a chování uživatelského rozhraní MediaWiki.
• Speciální stránky – přidá novou speciální stránku.
• Tag extensions – vytvoří nový tag, např.: <newtag>...</newtag>.
• Extending wiki markup – přidá k parseru nový háček, kterým lze upravit obsah wikitextu.

Nápověda pro vývojáře rozšíření

• Manual:Developing extensions – a guide to developing extensions.
• Project:WikiProject Extensions
• Extensions FAQ
• See Category:Extensions, for a list of extensions.
• Manual:$wgExtensionFunctions – use to defer setup (or run other callbacks) for extensions until after the MediaWiki core is setup.
• Extension:BoilerPlate - a blank extension template.

Nápověda pro tvorbu témat

• Manual:Skinning Part 1 – postup jak vytvořit téma pro MediaWiki.
• Manual:Skin configuration – průvodce konfigurací témat pro wiki.

Nápověda pro přebírání kódu knihoven

• Manual:Developing libraries – návod jak zabalit knihovny třetích stran pro použití s MediaWiki.

Third-party wiki se používá

• Enterprise hub - Pro Enterprise wiki
• Academic hub - Pro Akademické wiki