Manual:Tag extensions/cs

Jednotlivé projekty často považují za užitečné rozšířit vestavěné značení wiki o další možnosti, ať už jde o jednoduché zpracování řetězců nebo plnohodnotné vyhledávání informací. Rozšíření značek umožňují uživatelům vytvářet nové vlastní značky, které to dělají. Například lze použít rozšíření značky k zavedení jednoduché značky, která na stránku vloží darovací formulář. Rozšíření, včetně funkcí parseru a háčků, jsou nejúčinnějším způsobem, jak změnit nebo vylepšit funkčnost MediaWiki. Před zahájením práce na rozšíření byste měli vždy zkontrolovat, zda někdo jiný neudělal přesně to, o co se pokoušíte.

Jednoduché rozšíření tagu se skládá z funkce callback, která je zaháčkováním připojena k analyzátoru, takže když analyzátor běží, najde a nahradí všechny instance konkrétní značky, voláním odpovídající funkce zpětného volání k vykreslení skutečného HTML.

Příklad
V extension.json nastavte háčky:

A přidejte háček do souboru PHP

Tento příklad registruje funkci zpětného volání pro značku. Když uživatel přidá tuto značku na stránku, jako je tato:, analyzátor zavolá funkci   a předá čtyři argumenty:


 * $input : Vstup mezi značky a  nebo null, pokud je značka "zavřená", tj.
 * $args : Argumenty značek, které se zadávají jako atributy značek HTML. Toto je asociativní pole indexované podle názvu atributu.
 * $parser : Nadřazený analyzátor (objekt analyzátoru). Pokročilejší rozšíření to používají k získání kontextového názvu, analýze wiki textu, rozbalení složených závorek, registraci vztahů a závislostí odkazů atd.
 * $frame : Rodičovský rámec (objekt PPFrame). To se používá spolu s $parser k poskytnutí analyzátoru úplnější informace o kontextu, ve kterém bylo rozšíření voláno.

Propracovanější příklad viz Příklad rozšíření značky

Atributy
Podívejme se na další příklad:

Tento příklad vypíše atributy předané značce spolu s jejich hodnotami. Je zcela zřejmé, že to umožňuje flexibilní specifikaci nových vlastních značek. Můžete například definovat rozšíření značky, které umožňuje uživateli vložit kontaktní formulář na svou uživatelskou stránku pomocí něčeho jako.

Pro MediaWiki je k dispozici nepřeberné množství rozšíření značek, z nichž některá jsou uvedena na tomto webu. Ostatní lze najít pomocí rychlého vyhledávání na webu. Zatímco řada z nich je pro svůj případ použití zcela specializovaná, existuje velké množství oblíbených a dobře používaných rozšíření poskytujících různé stupně funkčnosti.

Konvence
Viz pro obecné rozložení a nastavení rozšíření.



Publikování vašich rozšíření

 * 1) Vytvořte na této wiki novou stránku s názvem Extension:&lt;extension_name> s informacemi o vašem rozšíření, jak jej nainstalovat a se snímky obrazovky, které používá. Pro tyto informace byla vytvořena pohodlná šablona s názvem . Další informace naleznete na stránce šablony. Měli byste také přidat co nejvíce podrobností do těla stránky a je moudré je poměrně pravidelně kontrolovat, abyste odpověděli na dotazy uživatelů na související diskusní stránce. Také se ujistěte, že stránka patří.
 * 2) Rozšíření, která vytvářejí nové háčky v rámci kódu rozšíření, by je měla zaregistrovat do kategorie háčků rozšíření.
 * 3) Upozorněte na mediawiki-l mailing list.

Viz také publikování vašeho rozšíření.

FAQ


Bezpečnostní obavy
Výše si všimnete, že vstup ve výše uvedených příkladech je před vrácením escapován pomocí. Je životně důležité, aby byl veškerý uživatelský vstup ošetřen tímto způsobem, než jej odešle zpět klientům, aby se předešlo zavádění vektorů pro libovolné HTML injection, což může vést k cross-site skriptování zranitelnosti.



Načítání modulů
Správný způsob, jak přidat moduly pro vaše rozšíření, je připojit je k ParserOutput spíše než k $wgOut. Seznam modulů bude poté automaticky převzat z objektu ParserOutput a přidán do $wgOut, i když je vykreslování stránky předem uloženo do mezipaměti. Pokud moduly přidáváte přímo do $wgOut, nemusí být uloženy do mezipaměti ve výstupu analyzátoru.



Časování a rozšíření
Pokud změníte kód rozšíření, všechny stránky, které rozšíření používají, teoreticky okamžitě odrážejí výsledky nového kódu. Technicky vzato to znamená, že váš kód je spuštěn pokaždé, když je vykreslena stránka obsahující rozšíření.

V praxi tomu tak často není, kvůli ukládání stránek do mezipaměti – buď softwarem MediaWiki, prohlížečem nebo zprostředkujícími proxy či firewallem.

Chcete-li obejít mezipaměť analyzátoru MediaWiki a zajistit vygenerování nové verze stránky, klikněte na upravit, nahraďte "action=edit" v adrese URL zobrazené v adresním řádku vašeho prohlížeče "action=purge" a odešlete novou adresu URL. Stránka a všechny šablony, na které odkazuje, budou znovu vygenerovány, přičemž budou ignorována všechna data uložená v mezipaměti. Akce čištění je nutná, pokud není upravena samotná hlavní stránka, ale změnil se způsob jejího vykreslení (bylo upraveno rozšíření nebo byla upravena pouze odkazovaná šablona).

Pokud to k získání nové kopie stránky nestačí, můžete obvykle obejít mezipaměti přidáním "&rand=somerandomtext" na konec výše uvedené adresy URL. Ujistěte se, že 'somerandomtext' je pokaždé jiný.



Jak deaktivuji ukládání do mezipaměti pro stránky používající mé rozšíření?
Od MediaWiki 1.5 je analyzátor předán jako třetí parametr rozšíření. Tento analyzátor lze použít ke zneplatnění mezipaměti takto:



Obnovení stránky při úpravě jiné stránky
Možná nechcete ukládání do mezipaměti úplně zakázat, jen chcete, aby se stránka znovu vygenerovala při každé úpravě jiné stránky, podobně jako je tomu u transkluzí šablon. To lze provést pomocí objektu analyzátoru, který je předán vaší funkci zavěšení. Následující metoda byla zrušena od a zdá se, že pro tento účel funguje.



Jemná úprava chování při ukládání do mezipaměti
Jemně zrnité ukládání do mezipaměti můžete pro své rozšíření použít pomocí klíčů mezipaměti k rozlišení mezi různými verzemi výstupu rozšíření. Při vykreslování můžete přidat klíče mezipaměti pro každou funkci přidáním metody addExtraKey do funkce háčku, např.:

Úprava během analýzy však znamená, že při pokusu o získání stránky uložené v mezipaměti nejsou zahrnuty další klíče voleb, ale pouze při vykreslování stránky pro přechod do mezipaměti, takže můžete použít háček  k nastavení dalších možností. PageRenderingHash se spouští jak při vkládání stránky do mezipaměti, tak při jejím získávání, takže je důležité přidávat nové klíče do hash pouze v případě, že tam ještě nejsou. Například:

Některé důležité poznámky:


 * Použití "!setting1=$value" místo pouhého "!$value" v confstr zajistí, že se mezipaměť analyzátoru nepokazí, pokud jsou nainstalována různá rozšíření nebo se změní jejich pořadí načítání. ! se používá jako oddělovač pro různé možnosti vykreslování
 * Někteří lidé místo  používají  . Upozorňujeme, že addExtraKey neříká mezipaměti analyzátoru, že se používá extra klíč, a proto může snadno vést k prolomení mezipaměti, pokud si nedáte pozor.



Jak vykreslím wikitext v mém rozšíření?


Od verze 1.16
Funkce háčku analyzátoru jsou předány jako odkaz na objekt analyzátoru a objekt frame. Ty by měly být použity k analýze wikitextu.

existuje již od verze 1.8. Mezi jeho výhody patří jednoduchost (bere pouze jeden argument a vrací řetězec) a skutečnost, že analyzuje značky rozšíření v, takže můžete značky rozšíření vnořovat.

Druhý parametr recursiveTagParse,, je volitelný argument zavedený v MW 1.16 alpha (r55682).


 * Pokud je zadán  (s použitím hodnoty   předané vašemu rozšíření), pak budou všechny parametry šablony v   rozšířeny. Jinými slovy, obsah jako   bude rozpoznán a převeden na příslušnou hodnotu.
 * Pokud není zadáno  (např. ) nebo pokud je   nastaveno na false, pak parametry šablony nebudou rozbaleny.   se nezmění. Ačkoli je nepravděpodobné, že by to bylo žádoucí chování, byla to jediná možnost dostupná před MW 1,16.

Jeden krok analýzy, který je u značek stále přeskočen, i když používáte recursiveTagParse, je. preSaveTransform je prvním krokem analýzy, který je zodpovědný za provádění trvalých změn v právě uloženém wikitextu, jako například:


 * Převod podpisů (, ~ ,  )
 * Rozšíření štítků odkazů, známé také jako pipe-trick (např. změna Help:Contents na Obsah ). Bez tohoto kroku jsou zkrácené odkazy jako Help:Contents považovány za neplatné a při analýze jsou ponechány ve formě wikitextu.
 * Rozšíření šablon.

Původní volání preSaveTransform záměrně přeskakuje takové konverze ve všech značkách rozšíření. Pokud potřebujete provést transformaci před uložením, měli byste místo toho zvážit použití funkce parseru. Všechna rozšíření značek lze také volat jako funkci analyzátoru pomocí, která bude mít použitou transformaci před uložením.



Jak mohu předat parametry ve stylu XML do své značky rozšíření?


Od verze 1.5
Od MediaWiki 1.5 jsou podporovány parametry ve stylu XML (atributy značek). Parametry jsou předány jako druhý parametr funkci háčku, jako asociativní pole. Hodnotové řetězce již pro vás dekódovaly znakové entity HTML, takže pokud je odesíláte zpět do HTML, nezapomeňte použít, abyste se vyhnuli riziku vložení HTML.



Jak se mohu vyhnout úpravám výstupu HTML mého rozšíření?
Vrácená hodnota rozšíření značky je považována za téměř analyzovaný text, což znamená, že se s ním nezachází jako s čistým html, ale přesto se mírně upravuje. Existují dvě hlavní věci, které se provádějí na výstupu rozšíření značky (spolu s několika dalšími drobnými věcmi):


 * Nahraďte značky strip. Značky stripů jsou určité položky, které se vkládají v různých fázích zpracování wikitextu, aby fungovaly jako značka pro opětovné pozdější vložení odstraněného obsahu. To není něco, o co by se rozšíření obvykle musela starat.
 * , která změní * na seznamy a promění jakýkoli řádek začínající úvodní mezerou na &lt;pre&gt; mimo jiné. To může být někdy problém v některých rozšířeních.

Rozšíření značek také podporují vrácení pole namísto pouhého řetězce (podobně jako funkce analyzátoru), aby se změnil způsob interpretace návratové hodnoty. 0. hodnota pole musí být HTML. Klíč "markerType" lze nastavit na, aby se zastavila další analýza. Provedení něčeho jako  by zajistilo, že hodnota $html nebude dále upravována a nebude s ní zacházeno jako s pouhým html.



Jak dosáhnu toho, aby se mé rozšíření zobrazovalo na Special:Version?
In order for your extension to be displayed on the MediaWiki Special:Version page, you must assign extension credits within the PHP code.

To do this, add a  variable as the first executable line of code before the hook line or function definition.

An example extension credit is:

Replace  with one of the following (unless your extension falls under multiple classes&mdash;then create a credit for each class):


 * 'specialpage'&mdash;reserved for additions to MediaWiki Special Pages;
 * 'parserhook'&mdash;used if your extension modifies, complements, or replaces the parser functions in MediaWiki;
 * 'variable'&mdash;extension that add multiple functionality to MediaWiki;
 * 'media'&mdash;used if your extension is a media handler of some sort
 * 'other'&mdash;all other extensions.

The  is the name of an interface/i18n message that describes your extension that will need to be defined in your extension's i18n.php file. If you omit this field, the  field will be used instead.

Retrieving the tag name inside of the callback
Suppose you have several tags and  that share the same callback, and inside the callback function, you want to obtain the name of the tag that invoked the callback.

The short answer is: the tag name ( or  ) is not present in any of the callback's arguments. But you can work around this by dynamically constructing a separate callback for each tag:

Toolbar buttons
provides an editing toolbar, allowing users to add tags into their editor by simply clicking a button. If you want a toolbar button for your new tag, create a file named something like  in your extension's   folder. The file should look like this:

Further details about customizing this file can be found here. Once you've created the file, you need to register it with so it will be delivered to visitors; this is done by editing your  :

Then, in your PHP file: