Příručka:$wgExtensionCredits

Pole typů rozšíření a uvnitř toho jejich jména, verze, autoři, adresy URL, popisy a ukazatele na zprávy s lokalizovaným popisem. Upozorňujeme, že klíče verze, url, popis a descriptionmsg lze vynechat.

Tyto informace o kreditu jsou přidány na stránku Special:Version wiki, což uživatelům umožňuje vidět, která rozšíření jsou nainstalována, a najít o nich další informace.

Toto není nastavení konfigurace uvedené v LocalSettings.php . Rozšíření vývojáři obvykle zapíše kód, který aktualizuje pole v této globální proměnné. Viz Vývoj rozšíření a (od MediaWiki 1.25) Registrace rozšíření .

Vývojáři rozšíření mohou k poli připojit následující kód:

$wgExtensionCredits[$type][] = array(
	'path' => __FILE__, // File name for the extension itself, required for getting the revision number from SVN - string, added in 1.15.0. Since 1.23 also used to create the link to the extension's license file
	'name' => "", // Name of extension - string
	'namemsg' => "", // Same as above but name of a message, for i18n - string, added in 1.24.0.
	'description' => "", // Description of what the extension does - string. Omit in favour of descriptionmsg.
	'descriptionmsg' => "", // Same as above but name of a message, for i18n - string, added in 1.12.0.
	'version' => 0, // Version number of extension - number or string
	'author' => "", // The extension author's name - string or array for multiple
	'url' => "", // URL of extension (usually instructions) - string
	'license-name' => "", // Short name of the license, links LICENSE or COPYING file if existing - string, added in 1.23.0
);

Pole description a author se analyzují jako syntaxe wiki. To se často používá k poskytování odkazů na domovskou stránku autora v poli autor. Ve verzi 1.12 a novější, descriptionmsg přepíše description.

$type musí být jedna z následujících:

• api — rozšíření API
• antispam — rozšíření antispam
• datavalues (zavedeno od 1.21) — rozšíření Wikidata-related
• media (zavedeno od 1.11) — manipulátory médií
• parserhook — rozšíření, která upravují, přidávají nebo nahrazují funkce v MediaWiki analyzátoru
• semantic — Semantic MediaWiki a závislá rozšíření
• skin — rozšíření, která upravují vzhledy
• specialpage — rozšíření, která přidávají speciální stránky
• variable (zavedeno od 1.6) — vytvoří novou proměnnou
• other — dělá něco jiného

Hodnota namemsg bude považována za klíč zprávy pro název rozšíření nebo vzhledu: Viz stránka nápovědy o lokalizaci. Standardně je ve tvaru <repositoryname>-extensionname nebo <repositoryname>-skinname (vše malá písmena).

Název je stejný jako název vlastnosti name.

Hodnota descriptionmsg bude považována za klíč message pro popis rozšíření: viz stránka nápovědy o lokalizaci. Standardně je ve tvaru ‎<repositoryname>-desc (všechna písmena malá).

Popis

• Musí to být jedna stručná věta: Nemá uzavírací část a v případě potřeby zahrnuje "toto rozšíření" jako předmět.
• Obvykle je v jedné z následujících forem:
  • "Does" (dělá)/"Adds" (přidává)/"Allows to do" (umožňuje) něco (např. "Přidá značku <poem> pro formátování básně");
  • "Allow to do" (povolit něco udělat)/"Do" (udělat) něco s wiki nebo uživateli jako předmětem (např. "Hide individual revisions from all users for legal reasons, etc." (skrýt jednotlivé revize před všemi uživateli z právních důvodů atd.));
  • Něco "Special page to do" (speciální stránka k provedení) nebo jiná podstatná věta popisující, z čeho se rozšíření skládá (např. "Provides a special page to view global file usage" (poskytuje speciální stránku pro zobrazení globálního využití souborů), "Provides Wikimedia specific messages" (poskytuje specifické zprávy Wikimedia)).
    • Zahrnuje odkaz na (hlavní) přidané speciální stránky, pokud existují, pomocí "special page" (speciální stránky) nebo "do something" (udělejte něco) atd. jako štítky odkazů.

Od MediaWiki 1.17 (r81549 ) může seznam autorů obsahovat speciální hackish '...' pro označení autorů, kteří nejsou jednotlivě pojmenováni, tj. další autoři. Trojitá tečka způsobí, že MediaWiki vloží zprávu "version-poweredby-others".

Příklad

$wgExtensionCredits['other'][] = array(
	'author' => array(
		'Jane Doe',
		'...'
		),
	);

Od MediaWiki 1.23 je možné uvést licenci na "Special:Version" a také odkazovat na soubor, který ji obsahuje. Aby to fungovalo, musí být poskytnuto "path" a také soubor s názvem COPYING nebo LICENSE. Klíč "license-name" by měl být použit pro zadání krátkého názvu licence, např. "GPL-2.0-or-later" nebo "MIT" v souladu se seznamem identifikátorů na spdx.org. Text z "license-name" bude poté použit jako popisek odkazu.

Příklad:

$wgExtensionCredits['other'][] = array(
	'path' => __FILE__,
	'license-name' => 'GPL-2.0-or-later' // GNU General Public License v2.0 or later
);

$wgExtensionCredits['specialpage'][] = array(
	'path' => __FILE__,
	'name' => 'Example extension',
	'version' => '1.9.0',
	'author' => 'Foo Barstein',
	'url' => 'https://www.mediawiki.org/wiki/Extension:MyExtension',
	'descriptionmsg' => 'exampleextension-desc',
	'license-name' => 'GPL-2.0-or-later'
);

• Body rozšíření MediaWiki

• MediaWiki configuration settings/cs
• MediaWiki configuration settings introduced in version 1.5.0/cs
• MediaWiki configuration settings still in use/cs
• Extension variables/cs