Šablona:Rozšíření

This page is a translated version of the page Template:Extension and the translation is 98% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎norsk bokmål • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎Ελληνικά • ‎беларуская (тарашкевіца)‎ • ‎български • ‎македонски • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎کوردی • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎မြန်မာဘာသာ • ‎中文 • ‎日本語 • ‎粵語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎조선말 • ‎한국어
Template documentation

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í/cs , 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             = 
|readme               = 
|changelog            = 
|example              = 
|namespace            = 
|parameters           = 
|tags                 = 
|rights               = 
|compatibility        = 
|bugzilla             = 
|phabricator          =
|vagrant-role         = 
}}
Jaký má být obsah parametrů, viz níže
Základní informace k tomuto rozšíření MediaWiki
OOjs UI icon advanced.svg
{{{name}}}
Stav rozšíření: neznámý
Placeholder.png
Zavádění {{{type1}}}, {{{type2}}}
Popis {{{description}}}
Napsal(i) SomeAuthor (SomeUsertalk)
Aktuální verze {{{version}}} ({{{update}}})
Poslední verze náhledu {{{version preview}}} ({{{update preview}}})
Zásady kompatibility neplatný
MediaWiki {{{mediawiki}}}
PHP {{{php}}}
Změny v databázi {{{needs-updatephp}}}
Composer {{{composer}}}
Tabulky [[Special:MyLanguage/Template:Extension/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/{{{table1}}} table| ]]
[[Special:MyLanguage/Template:Extension/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/{{{table2}}} table| ]]
Licence {{{license}}}
Zdrojový kód {{{download}}}
{{{readme}}}
{{{changelog}}}
Příklad {{{example}}}
{{{namespace}}}
{{{parameters}}}
{{{tags}}}

{{{rights}}}

{{{compatibility}}}
Přeložte rozšíření Extension, jsou-li dostupné jeho lokalizační zprávy na webu translatewiki.net
Vagrant role {{{vagrant-role}}}
Problémy [[phab:tag/{{{phabricator}}}|Otevřené úkoly]] · Nahlásit chybu

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 Kontrolní parametry.

Parametry obsahu
Parametr Popis
namenázev rozšíření
statusaktuální stav vydání

Jeden z:

  • unstable - rozbité - nepoužívejte toto rozšíření
  • experimental - rane stádium vývoje, může se drasticky změnit
  • beta - stabilní, ale ne úplně otestované
  • stable - stabilní verze
  • unmaintained - dříve potvrzeno jako stabilní, nyní neudržované
  • archive - archivováno - zastaralé nebo sloučené s jinou příponou
  • unknown - výchozí

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 uskutečnění

Implementační strategie použité při budování 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:

  • parser - catchall pro nezařazené parser rozšíření. Pokud jste napsali rozšíření syntaktického analyzátoru, použijte jeden z následujících konkrétnějších typů:
  • access - catchall za User access extensions , tj. rozšíření, která vytvářejí, ověřují, udělují oprávnění, odvolávají oprávnění nebo sledují aktivitu uživatelů. Pokud jste napsali rozšíření o přístup, použijte jeden z následujících konkrétnějších typů:
    • user activity - rozšíření, která monitorují aktivitu uživatelů (přihlášení, odhlášení, vytváření nových uživatelů atd.)
    • user identity - rozšíření, která vytvářejí a odstraňují uživatele a nebo ověřují totožnost uživatele
    • user rights - rozšíření systému správy práv, např. změny způsobu přiřazování práv, API, nástrojů údržby (nezahrnuje rozšíření, která pouze pojmenovávají práva potřebná k použití funkcí tohoto rozšíření. Pro tento účel použijte parametr parametrů)
  • interface - catchall pro nezařazená rozšíření uživatelského rozhraní.
    • media - rozšíření, která umožňují vkládání multimediálního obsahu na wiki stránky registrací přípony souboru u $wgMediaHandlers .
    • mywiki - rozšíření, která poskytují infrastrukturu, takže uživatelé si mohou přizpůsobit své zkušenosti s MediaWiki a nebo pomáhat při správě této infrastruktury
    • notify - rozšíření, která odesílají e-maily uživatelům, vysílají zprávy a poskytují další formy oznámení komunity
    • page action - rozšíření, která vylepšují nebo upravují page action s (stránkování). To zahrnuje vše, co implementuje akci, která čte, zapisuje, vyhledává, vytváří, přejmenovává, vymaže, přesměruje nebo diskutuje o stránce. Nezahrnuje práva (použijte user rights) ani protokoly (použijte user activity).
    • search - rozšíření, která prohledávají a vybírají články pro uživatele.
    • skin - rozšíření přidávající CSS nebo JavaScript nebo implementace funkcí zavěšení pro změnu vzhledu a dojmu MediaWiki prostřednictvím rámce skins.
    • ajax - rozšíření, která používají programovací techniky Ajax.
    • special - rozšíření, která v podtřídě SpecialPage, používají jeden z jejích háčků nebo opravují jednu nebo více funkcí v SpecialPage.php. Další informace naleznete v příručce Special pages .
  • other
    • api - rozšíření, která přidávají nový modul API nebo rozšiřují základní modul API.
    • hook - háčkové rozšíření - definuje new (nový) háček - viz hook1 atd. Níže, pokud chcete definovat háčky used (používané) vaší příponou
    • database - přidá tabulky a nebo pole do databáze podporující instalaci MediaWiki
    • data extraction - Extrakce dat
    • filerepo - přípona, která přidá nové typy úložišť souborů jako backend souboru
    • example - není to skutečné rozšíření, ale příklad toho, jak ho napsat

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
...
použité háčky

Zadání hodnot do tohoto pole je dobrým způsobem, jak získat rozšíření pro vaše rozšíření a pomoci ostatním vývojářům. Každý dokumentovaný háček automaticky přidá rozšíření k rozšíření o seznam kategorií, která tento háček používají. Tato kategorie je automaticky propojena do každého článku 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:

  • použijte název háčku samostatně. Hodnoty najdete v příručce Manual:Hooks (ale vynechejte úvodní '/').

Pro vlastní háčky definované rozšířeními:

U více háčků přiřaďte první háček k hook1, druhý k hook2 atd.
newhook1
newhook2
newhook3
newhook4
...
newhook90
použité háčky Možná budete chtít přidat háčky k Extension hook registry.
usernameUživatelské jméno autora na MediaWiki.org (pokud je 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 [[]].
authorJmé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).
descriptionstručný popis
imagesnímek obrazovky, nebo logo rozšíření Měl by být poskytován bez jmenného prostoru a bez [[]].
imagesizefakultativní, velikost obrázku (výchozí velikost je 220px)
versionposlední verze
updatedatum poslední aktualizace
compatibility policyzásady kompatibility (akceptované hodnoty jsou master, rel a ltsrel). (nedodělávky )
mediawikivyžaduje MediaWiki verze
phpvyžaduje PHP verze
needs-updatephpyes označuje, že rozšíření vyžaduje změnu schématu databázové tabulky nebo podobnou akci než bude MediaWiki spuštěna. Jedná se o běžná úskalí: vaše MediaWiki se zastaví, pokud jste zapomněli spustit update.php - pokud to rozšíření vyžaduje. no by měla být nastavena jako hodnota, protože to zajišťuje, že rozšíření nevyžaduje spuštění update.php, a tím se vyhne nejistotě

Rozšíření, která odpovídají standardům rozšíření MediaWiki, přicházejí se skriptem 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/extensions/ExtensionName a vložíte wfLoadExtension( "ExtensionName"); do "LocalSettings.php", spusťte z příkazového řádku:

cd path/to/wiki_install_directory
cd maintenance
php update.php
$IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holds LocalSettings.php , index.php etc..
composerPokud je to možné, je třeba zadat jméno "dodavatele" (vendor) a "balíček" (package) ve formátu vendor/package, např. mediawiki/semantic-media-wiki pro přímé nasměrování lidí na packagist.org, který slouží jako archiv balíčku.
table1
table2
table3
table4
...
table30
název každé tabulky bez jádra, kterou používá přípona 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 je page nebo revision ; pouze seznam tabulek, které jsou přidány pomocí rozšíření.
licenselicence 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.
downloadodkaz na stažení: Git, {{WikimediaDownload/cs}} s $server pro případ, že by nebyl přenesen z $svn. Pokud kód vložíte na stránku ve wiki MediaWiki, odkazujte na něj pomocí úplného názvu stránky a názvu sekce, např. $code (musí být platný i při kopírování bot jinam)
repoName of the Gerrit repository the extension's code is stored in, if different from the page name. Setting this automatically sets |download=, and allows the template to automatically load data from the appropriate extension.json file.
readmeexterní odkaz na soubor readme, např. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
changelogexterní odkaz na soubor changelog, např. Extension:LDAP Authentication/Changelog
parametersdostupné parametry pro LocalSettings.php
tagsvšechny značky, které vaše rozšíření používá (např. <tag1>, <tag2>).
rightsprá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!
namespaceobor názvů, ve kterém je tato přípona použita
examplepříklad, web nebo snímek rozšíření pracovní obrazovky
compatibilityDalší informace o kompatibilitě, například grafy kompatibility (dříve pomocí Template:Extension Testing). 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.
translateVolitelný parametr pro propojení přesné stránky, na které (skupina zpráv id, se kterou) bude rozšíření přeložitelné na translatewiki.net, pokud je povoleno. Pokud je výchozí odkaz nesprávný, nastavte jej ručně na:
  • ext-LOWERCASE malá písmena (NOSPACES (Label definovaný v $souboru)), aka
  • parametr, který dostanete po URL
bugzillaNázev komponenty Bugzilla MediaWiki
phabricatorNázev projektu výrobce
CheckUsageNameOverridepřepíše název stránky použitý pro odkaz použití kontroly.

Kontrolní parametry

Kontrolní parametry
Parametr Popis
templatemodeŘídí automatickou kategorizaci hostitelské stránky.

Normálně ponecháno prázdné. Alternativní hodnoty jsou:

  • nocats - potlačí kategorizaci a odkaz 'zkontrolovat použití'. Tuto hodnotu použijte, pokud přidáváte tuto šablonu do podstránky rozšíření nebo do dokumentace k rozšíření. Například výše uvedený obrázek použití nastavuje templatemode=nocats, protože se nejedná o skutečnou stránku rozšíření a tuto stránku nechceme přidat do žádných kategorií.
  • nousage - potlačí odkaz 'zkontrolovat využití'. Odkaz je také potlačen, pokud je stránka podstránkou, není v rozšíření: namespace nebo pokud je potlačeno 'templatemode=nocats'
Pokud toto políčko ponecháte prázdné, přidá tato šablona hostitelskou stránku do Category:All extensions/cs a do jedné nebo více dalších kategorií v závislosti na hodnotách přiřazených parametru obsahu.

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 k rozšíření

Pokud chcete přidat stránku k 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.


A developer sharing their code in the MediaWiki code repository should expect:

Feedback / Criticism / Code reviews
Review and comments by other developers on things like framework use, security, efficiency and usability.
Developer tweaking
Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
Improved access for wiki sysadmins
If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then create a Vývojářský účet to continue maintaining it.
Future versions by other developers
New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.
Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
Credit
Credit for your work being preserved in future versions — including any merged extensions.
Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.

Doplnění této š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 Vytvořit rozšíření

Chcete-li zlepšit chování tlačítka vytvořit rozšíření:

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 parametrům obsahu a připojit jeho štítek k této dokumentaci.

Postup změny / opravy / přidání k parametrům typu implementace:

Chcete-li změnit chování parametrů háčku:

Zkušební případ

Po úpravě této šablony zkontrolujte, zda jsou následující stránky v pořádku.

TemplateData

Maintenance: vulnerabilities, archived