Template:Extension
 | Tato šablona využívá složité funkce syntaxe šablony.
Než začnete upravovat šablonu, doporučujeme vám seznámit se s jejím nastavením a funkcemi parseru. Pokud vaše úprava způsobí neočekávané problémy, rychle ji vraťte, protože tato šablona se může objevit na velkém počtu stránek. Pamatujte, že můžete provádět experimenty a měli byste otestovat všechna vylepšení buď v general sandbox, nebo ve svém uživatelském prostoru, než zde cokoli změníte. |
 | Uses Lua: |
 | Tato šablona používá TemplateStyles: |
Tato šablona by měla být přidána na všechny stránky rozšíření na této wiki (ale pouze na hlavní stránku). Přidá užitečný infobox (viz níže) a automaticky přidá rozšíření na Kategorie:Všechna rozšíření, spolu s příslušnými kategoriemi status a typ implementace.
Použití
|
Zkopíruj a vlož: {{Extension |templatemode =
|name =
|status =
|type1 =
|type2 =
|hook1 =
|hook2 =
|newhook1 =
|newhook2 =
|username =
|author =
|description =
|image =
|imagesize =
|version =
|update =
|version preview =
|update preview =
|compatibility policy =
|mediawiki =
|php =
|needs-updatephp =
|composer =
|table1 =
|table2 =
|license =
|download =
|repo =
|readme =
|changelog =
|help =
|example =
|namespace =
|parameters =
|tags =
|rights =
|compatibility =
|phabricator =
|translate =
|vagrant-role =
}}
Jaký má být obsah parametrů, viz níže |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Obsah parametrů
Tato část popisuje parametry, kterými se řídí obsah infoboxu. Nápovědu k templatemode a dalším kontrolním parametrům najdete v parametrech kontroly.
| Parametr | Popis |
|---|---|
| name | název rozšíření |
| status |
aktuální stav vydání Jeden z:
Pokud je stav jiný než výše uvedený, bude ignorován a v šabloně bude místo toho zobrazena výchozí hodnota 'Neznámé' (Unknown). V případech, kdy je hodnota vynechána, bude kategorizována jako neznámé. V případech, kdy je hodnota neplatná, bude umístěna do speciální kategorie, aby mohla být chyba zachycena a opravena. |
| type1 type2 type3 type4 type5 type6 | typ zavádění
Strategie zavádění použité při vývoji tohoto rozšíření. Tento parametr se používá k vytváření kategorií, které pomáhají programátorům najít příklady různých implementačních strategií nebo vzorců MediaWiki. Ačkoli se hodnoty tohoto parametru někdy shodují s případem použití nebo účelem rozšíření, není to důvod tohoto parametru. Pokud hodnoty, které jste pro tento parametr vybrali, dostatečně neidentifikují požadavky nebo účel nebo možné použití, doporučujeme přidat další odkazy na kategorii podle potřeby. Povolené hodnoty pro parametry type1, type2, ... jsou:
Jakákoli jiná hodnota pro 'type' je neplatná a způsobí umístění přípony do Category:Extensions with invalid or missing type/cs. Poznámka: Mnoho rozšíření má více než jeden typ, pokud se to týká vašeho, nahraďte|type= hodnotou |type1=|type2=|type3=.... Pro rozšíření můžete definovat až šest typů. |
| hook1 hook2 hook3 hook4 ... |
háčky používané rozšířeními
Zadání hodnot do tohoto pole je dobrým způsobem, jak získat další rozšíření pro vaše rozšíření a jak pomoci ostatním vývojářům. Každý dokumentovaný háček automaticky přidá rozšíření do seznamu kategorií rozšíření, které tento háček používají. Tato kategorie je automaticky propojena do každé stránky s háčky, aby programátoři snadno našli příklady rozšíření, která používají konkrétní háček. Pro vestavěné háčky:
Pro vlastní háčky definované rozšířeními:
|
| newhook1 newhook2 newhook3 newhook4 ... newhook90 |
název každého háčku poskytnutého rozšířením Možná budete chtít přidat háčky do Extension hook registry. |
| username | Uživatelské jméno autora na MediaWiki.org (pokud jej má). Může být vynechán, ale bude-li přítomen, bude použit k propojení s autorovou stránkou a stránkou user_talk. Měl by být poskytován bez jmenného prostoru a bez [[]]. |
| Jméno autora rozšíření, pokud se liší od uživatelského jména MediaWiki.org. Libovolný text. Pokud je vynecháno, bude použito pole 'uživatelské jméno' (username) (pokud existuje). | |
| description | Stručný popis |
| image | Snímek obrazovky nebo logo rozšíření. Měl by být poskytován bez jmenného prostoru a bez [[]]. |
| imagesize | Nepovinné, velikost obrázku bez přidání px, např. 360 (výchozí velikost je 300px) |
| version | Poslední verze |
| update | Datum poslední aktualizace |
| version preview | náhledová verze |
| update preview | datum poslední aktualizace na náhledovou verzi |
| compatibility policy | Zásady kompatibility (akceptované hodnoty: master, main, rel, ltsrel). (nedokončené práce) |
| mediawiki | Vyžaduje MediaWiki verze. Většina rozšíření by toto neměla používat – výchozí je hodnota vlastnosti 'requires' extension.json. Viz také Category:Extensions without MediaWiki version a Category:Extensions with manual MediaWiki version. |
| php | Vyžaduje PHP verze |
| needs-updatephp |
Parametr Rozšíření, která odpovídají standardům rozšíření MediaWiki, přicházejí se záznamem změny schématu, který musíte spustit ručně před spuštěním (jednou) a přístupem k MediaWiki přes prohlížeč poté, co zkopírujete všechny přípony do
$IP znamená instalační cestu (nebo "adresář") vaší instalace MediaWiki, stejný adresář, který obsahuje LocalSettings.php, index.php atd.. |
| composer | Název balíčku rozšíření Composer ve [standardním formátu https://getcomposer.org/doc/04-schema.md#name]. Bude automaticky zahrnut, pokud je nastaven v souboru rozšíření "composer.json" (tj. v takovém případě tento parametr není povinný). Bude propojeno se stránkou rozšíření na Packagist. |
| table1 table2 table3 table4 ... table30 | Název každé tabulky bez jádra, kterou používá rozšíření. Odkazy na podstránku vaší stránky rozšíření. Například "table1 = cu_changes" na Extension:CheckUser bude odkazovat na Extension:CheckUser/cu_changes table. Nezahrnujte základní tabulky, jako jsou page nebo revision. Zadávejte pouze seznam tabulek, které jsou přidány pomocí rozšíření. |
| license | Licence upravující použití tohoto rozšíření, jako jeden z kódů nalezených v https://spdx.org/licenses/, např. GPL-2.0-or-later, GPL-2.0-only nebo GPL-3.0-or-later atd. |
| download | Odkaz na stažení: Git, {{WikimediaDownload/cs}}. |
| repo | Jméno repozitáře spravovaného přes Gerrit, ve kterém je uložen kód rozšíření, pokud se liší od jména rozšíření. Jeho nastavením se automaticky nastaví také hodnota |download=. Ta umožní, aby si šablona stáhla další parametry ze souboru extension.json. |
| readme | Externí odkaz na soubor readme, např. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README |
| changelog | Externí odkaz na soubor se záznamy o všech výrazných změnách, např. Extension:GeoGebra/Changelog |
| help | Odkaz na uživatelskou nápovědu pro rozšíření. If not provided, will look for Help:Extension:ExtensionName. Pokud je uveden, měl by být uveden úplný wikitextový odkaz (protože možná budete chtít odkazovat např. na externí stránku). |
| example | Příklad, web nebo snímek rozšíření pracovní obrazovky |
| namespace | Jmenný prostor, ve kterém je tato přípona použita |
| parameters | Dostupné parametry pro LocalSettings.php |
| Všechny značky, které vaše rozšíření používá (např. <tag1>, <tag2>). | |
| rights | Práva přidaná rozšířením. Nesmí být zaměňována s licencí! Práva jsou například makebot nebo desysop. Ne jako GFDL nebo LGPL nebo GPL - to jsou licence! |
| compatibility | Další informace o kompatibilitě, například grafy kompatibility. Doporučujeme sem přidat jakékoli informace o kompatibilitě na straně klienta, zejména při odklonu od očekávání plné podpory prohlížeče. |
| bugzilla | Název komponenty rozšíření Bugzilla MediaWiki |
| phabricator | Název projektu Phabricator |
| translate |
Volitelný parametr pro propojení přesné stránky, na které (skupině zpráv id) bude rozšíření přeložitelné na translatewiki.net, pokud je povoleno. Pokud je výchozí odkaz nesprávný, nastavte jej ručně na:
|
| vagrant-role | Role MediaWiki-Vagrant |
| CheckUsageNameOverride | Přepíše název stránky použitý pro odkaz na kontrolu použití. |
Kontrolní parametry
| Parametr | Popis |
|---|---|
| templatemode |
Řídí automatickou kategorizaci hostitelské stránky. Normálně ponecháno prázdné. Alternativní hodnoty jsou:
|
Použití infoboxu
Na existující stránce k rozšíření
Pokud chcete přidat infobox na stránku, která již existuje, zkopírujte do ní výše uvedený kód.
Založení nové stránky rozšíření
Pokud chcete přidat stránku rozšíření, které zde dosud svoji stránku nemá, napište do níže uvedeného vstupního pole formuláře jeho název a klikněte na tlačítko. Tím dojde k založení nové stránky, která již bude tuto informační šablonu obsahovat.
Vývojář sdílející svůj kód v úložišti kódu MediaWiki by měl očekávat:
- Zpětná vazba / Kritika / Recenze kódu
- Recenze a komentáře ostatních vývojářů k věcem, jako je [použití rámce https://doc.wikimedia.org/], zabezpečení, efektivita a použitelnost.
- Vývojářské ladění
- Ostatní vývojáři upravující váš příspěvek, aby vylepšili nebo vyčistili váš kód, aby vyhovoval novým třídám a metodám rámce, kódovacím konvencím a překladům.
- Vylepšený přístup pro správce systému wiki
- Pokud se rozhodnete umístit svůj kód na wiki, jiný vývojář se může rozhodnout, pro snadnější údržbu, jej přesunout do úložiště kódu MediaWiki. Poté můžete vytvořit Účet vývojáře a pokračovat v jeho údržbě.
- Budoucí verze od jiných vývojářů
- Nové větve vašeho kódu se vytvářejí automaticky s vydáním nových verzí MediaWiki. Pokud chcete podporovat starší verze, měli byste se vrátit na tyto větve.
- Začlenění vašeho kódu do jiných rozšíření s duplicitními nebo podobnými účely – začlenění nejlepších funkcí z každého rozšíření.
- Zásluhy
- Poděkování za zachování vaší práce v budoucích verzích – včetně všech sloučených rozšíření.
- Podobně byste měli připsat zásluhy vývojářům všech rozšíření, jejichž kód si půjčujete – zejména při sloučení.
Žádný vývojář, kterému je nepříjemná jakákoli z těchto akcí, by neměl být hostitelem v úložišti kódu. Stále se doporučuje vytvořit souhrnnou stránku pro vaše rozšíření na wiki, aby lidé věděli o rozšíření a kde si jej mohou stáhnout.
Doplnění šablony o další položky
Pokud byste chtěli tuto šablonu vylepšit, děkujeme! Jedná se o komplikovanou šablonu, takže zde je trochu nápovědy:
Tlačítko Create extension (vytvořit rozšíření)
Chcete-li zlepšit chování tlačítka pro vytvoření rozšíření:
- Template:Extension/Sample: Rozšíření podkladu, který je předem načten do nově vytvořené stránky.
- Template:Extension/CreateExtensionInputBox: Vstupní pole, které lze vložit kamkoli chcete, aby uživatelé snadno vytvářeli rozšíření. Dokumentaci o značce
<inputbox>naleznete na adrese Extension:InputBox.
Parametry Infoboxu
Obecně:
- Aby bylo použití této šablony snadné, je každý štítek v infoboxu spojen s dokumentací o parametrech šablony, které se zobrazí. Pokud přidáte parametr, nezapomeňte jej také přidat do dokumentace k obsahu parametrů a připojit jeho štítek k této dokumentaci.
Postup změny nebo opravy nebo přidání k parametrům typu implementace:
- Podívejte se na diskusní stránku - v této oblasti došlo k rozsáhlým diskusím.
- Použitelné hodnoty a to nač odkazují je definováno v Module:Extension
Chcete-li změnit chování parametrů háčku:
- Template:Extension/HookInUse: Přidá odkazy a kategorie pro použitý háček. Používá se více háčků, které jsou implementovány voláním této šablony s Template:Foreach.
- Template:Extension/HookInUseNoCats: Používá se místo Template:Extension/HookInUse, pokud je tato šablona použita v
templatemode=nocats. Šablony používané s Template:Foreach mohou mít pouze jeden parametr, takže musíme zabalit volání do Template:Extension/HookInUse jinou šablonou, která nastavuje režim.
Zkušební případ
Po úpravě této šablony zkontrolujte, zda jsou následující stránky v pořádku.
TemplateData
| TemplateData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Tato sekce obsahuje strukturovaný popis parametrů šablony využívající rozšíření TemplateData, který umožňuje snadnější používání této šablony v prostředí VisualEditoru. Extension An infobox for a MediaWiki extension.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Maintenance: vulnerabilities, archived