Uživatelská dokumentace by měla být nedílnou součástí zveřejnění každého skriptu či doplňku (pluginu). Dobrým místem pro její umístění je tento web, který také poskytuje šablonu se základními body, jež by každá dokumentace měla obsahovat.

Zvažte, zda je vhodnější dokumentace přiložená k doplňku jako součást jeho distribuce nebo dokumentace veřejně dostupná na webu. I v prvním případě však zde založte stránku, protože to je jediný způsob, jak zajistit možnost automatizované kontroly aktuální verze doplňku proti verzi nainstalované v GeoGetu.

Pokud sem chcete přidat svůj skript nebo doplněk, držte se, prosím, následujícího návodu.

Anonymní uživatelé zde mohou jen číst. Pokud zde chcete vytvářet a modifikovat nějaké stránky, musíte se na tomto webu zaregistrovat. Nicméně samotná registrace není dostatečným oprávněním pro nahrávání a mazání zdejších souborů!

Pokud chcete pracovat i se soubory, musíte mne požádat o přidělení příslušných práv. Chceme, aby toto vysoké oprávnění měli jen lidé, kterým můžeme věřit, že zde neudělají žádnou neplechu.

Již při tvorbě doplňku je velmi důležité zvolit správně jeho jméno. Mělo být výstižné a zároveň by mělo být v rámci všech doplňků jedinečné a pokud možno nezaměnitelné s jiným doplňkem. Odstrašujícím příkladem mohou být GgStat a naštěstí již neexistující ggstat2, který způsoboval zmatky u některých uživatelů jěště rok po jeho přejmenování na dnešní Autostat.

V tomto návodu budeme místo vámi zvoleného jména používat jméno_doplňku.

Do vyhledávacího políčka (vlevo nahoře na stránce, přímo nad hlavním menu) zadejte:

user:skript:jméno_doplňku

A dejte jej vyhledat. Tím si ověříte, že taková stránka opravdu neexistuje. Pak použijte volbu Vytvořit stránku (vlevo nahoře).

Před samotnou tvorbou může být vhodné se krátce seznámit se syntaxí, která je na webu používána pro tvorbu stránek.

Nově vytvořená stránka obsahuje základní osnovu, která by měla být dodržena vždy. Pochopitelně, jsou výjimky, takže se může stát, že některý z bloků potřeba není, ale měla by to být výjimečná situace a vynechání každého doporučeného odstavce by mělo mít dobrý důvod.

Součástí šablony jsou i části pro automatické generování seznamu souborů pro stažení, příkaz pro kontrolu verzí doplňku a stažení aktuální verze. Prosím, neupravujte tyto části, pokud jim nerozumíte a nevíte jak přesně pracují.

Vaším hlavním úkolem je doplnit texty vlastní vašemu doplňku. Věnujte jim, prosím, dostetečnou péči a snažte se o vyčerpávající popis, který bude uživatelům užitečný. Doplnění obrázků může jednoduchou cestou a bez přemíry slov hodně zpřehlednit a vysvětlit.

Při následných úpravách dokumentace, prosím, mažte staré a nepotřebné soubory. Zajistíme tak přehlednost a nezaneseme disky odpadem.

Na konci šablony je seznam TAGů. Vyberte TAGy, které nejlépe odpovídají Vašemu doplňku. Tím zajistíte zobrazení doplňku ve správných seznamech a značně zvýšíte pravděpodobnost, že uživatel najde to, co potřebuje.

~~TAGCLOUD~~

Pokud nevíte, jaké tagy přiřadit, podívejte se na stránky ostatních doplňků, jsou to ta zeleně vypsaná slovíčka vpravo na konci každé dokumentace.