Differences

This shows you the differences between two versions of the page.

--- user:skripty:autor:dokumentace [2010/09/08 12:16] – gord
+++ user:skripty:autor:dokumentace [2020/10/28 11:44] (current) – mikrom
@@ Line 1: / Line 1: @@
 ====== Dokumentace k doplňkům ======
 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.
-====== Zajistěte si oprávnění ======
+<WRAP center round help 60%>
-Anonymní uživatelé zde mohou jen číst. Pokud zde chcete vytvářet a modifikovat nějaké stránky, musíte se na tomto webu [[http://geoget.ararat.cz/doku.php/start?do=register|zaregistrovat]]. Nicméně samotná registrace není dostatečným oprávněním pro nahrávání a mazání zdejších souborů!
+Nevíte, jak se skripty vytváří? Tak se podívejte [[user:skripty|sem]].
+</WRAP>
-Pokud chcete pracovat i se soubory, musíte mne požádat o **[[mailto:geoget@ararat.cz| 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.
+===== Zajistěte si oprávnění =====
+Anonymní uživatelé zde mohou jen číst. Pokud zde chcete vytvářet a modifikovat nějaké stránky, musíte se na tomto webu [[http://www.geoget.cz/doku.php/start?do=register|zaregistrovat]]. Nicméně samotná registrace není dostatečným oprávněním pro nahrávání a mazání zdejších souborů!
-====== Zvolte jméno doplňku ======
+Pokud chcete pracovat i se soubory, musíte požádat o **[[geoget@ararat.cz| 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.
-<box round 95% #DEE7EC>
+===== Zvolte jméno doplňku =====
+<WRAP center round important 80%>
-:!: 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 [[user:skript:ggstat|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í [[user:skript:autostat|Autostat]].
+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 [[user:skript:ggstat|GgStat]] a naštěstí již neexistující **ggstat2**, který způsoboval zmatky u některých uživatelů ještě rok po jeho přejmenování na dnešní [[user:skript:autostat|AutoStat]].
+</WRAP>
-</box>
 V tomto návodu budeme místo vámi zvoleného jména používat //jméno_doplňku//.
-====== Založte stránku ======
+===== Založte stránku =====
 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).
+A dejte jej vyhledat. Tím si ověříte, že taková stránka doposud neexistuje. Pak použijte volbu //Vytvořit stránku// (ikonka tužtičky s plusem vpravo).
-====== Vytvořte stránku ======
+===== Upravte stránku =====
 //Před samotnou tvorbou může být vhodné se krátce seznámit se [[wiki:syntax|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, dostateč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.
-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íte tak přehlednost a nezanesete disky odpadem.
-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.
+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, příkaz pro automatickou instalaci do GeoGetu. Prosím, neupravujte tyto části, pokud jim nerozumíte a nevíte jak přesně pracují.
-====== Označení pomocí Tagů ======
+<hidden onHidden=":!: **Zobrazit podrobnosti** o automatizovaných funkcích" onVisible="Skrýt podrobnosti">
+   * [[downloadrewrite|příkaz DOWNLOAD - automatická aktualizace a stažení nejnovější verze]]
+   * [[geogetinstall|příkaz GEOGET_INSTALL - automatická instalace doplňku do GeoGetu]]
+</hidden>
+===== Označte stránku pomocí Tagů =====
 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.
-===== Dostupné Tagy =====
+==== Dostupné Tagy ====
 ~~TAGCLOUD~~
-:!: Pokud nevíte, jaké tagy přiřadit, podívejte se na [[user:skript|stránky ostatních doplňků]], jsou to ta zeleně vypsaná slovíčka vpravo na konci každé dokumentace.
+<WRAP center round tip 80%>
+Pokud nevíte, jaké tagy přiřadit, podívejte se na [[user:skript|stránky ostatních doplňků]], jsou to ta zeleně vypsaná slovíčka vpravo na konci každé dokumentace.
+</WRAP>
+===== Přiložte instalační balíček =====
+<WRAP center round info 80%>
+Doplňky pro program GeoGet jsou distribuovány ve speciálních [[gip|balíčcích s příponou *.gip]]. Na odkazované stránce je k dispozici popis formátu instalačního balíčku a návod k jeho vytvoření.
+</WRAP>
+Hotový instalační balíček musí splňovat tyto podmínky.
+   * Instalační balíček musí být pojmenován jako **//jméno_doplňku//-//verze//.gip**
+   * Číslo verze obsahuje pouze číslice a tečky (např. 2.11.0.1)
+Balíček přiložte ke stránce.
+<WRAP center round important 80%>
+Pozor, balíček je nutno uložit do jmenného prostoru stránky, tedy **user:skript://jméno_doplňku//://jméno_doplňku//-//verze//.gip**
+</WRAP>
+<WRAP center round important 80%>
+Podobně je do stejného jmenného prostoru potřeba uložit i ostatní soubory, například obrázky.
+</WRAP>
+===== Zkontrolujte hotovou stránku =====
+Hotovou stránku si po sobě překontrolujte:
+  * ověřte, že funguje odkaz ve stránce pro stažení aktuální verze
+  * ověřte, že se přiložený balíček zobrazuje v seznamu dostupných verzí
+  * ověřte funkčnost [[geogetinstall|instalačního tlačítka]]
+  * ověřte, že GeoGet přiložený [[gip|balíček]] správně rozpozná a nainstaluje
+  * ověřte, že GeoGet v seznamu nainstalovaných balíčků zobrazuje správně číslo nejvyšší dostupné verze balíčku
+  * ověřte, že se nová stránka zobrazuje v [[user:skript|automaticky generovaném přehledu doplňků]].
+Administrátoři serveru sledují změny ve stránkách skriptů. Pokud na nově vytvořené stránce při kontrole narazí na nějaký problém, s nejvyšší pravděpodobností Vás kontaktují a pomohou jej odstranit, případně jej rovnou odstraní sami.
-{{tag>gge ggs ggv}}
+===== Řekněte o doplňku uživatelům =====
+Pokud jste přidali na server nějaký skutečně pěkný doplněk, řekněte o jeho existenci geokešerům. Vhodnou cestou může být například nové vlákno na fóru [[http://www.geocaching.cz/forum/viewforum.php?forum_id=20|Geocaching.cz]].