Differences

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

--- user:skripty:autor:dokumentace [2010/09/21 14:49] – medwyn_cz
+++ 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.
+<WRAP center round help 60%>
+Nevíte, jak se skripty vytváří? Tak se podívejte [[user:skripty|sem]].
+</WRAP>
 ===== 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://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ů!
+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ů!
 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.
 ===== Zvolte jméno doplňku =====
+<WRAP center round important 80%>
-<box round 95% #DEE7EC>
+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>
-:!: 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]].
-</box>
 V tomto návodu budeme místo vámi zvoleného jména používat //jméno_doplňku//.
@@ Line 27: / Line 27: @@
 **user:skript://jméno_doplňku//**
-A dejte jej vyhledat. Tím si ověříte, že taková stránka doposud 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).
 ===== Upravte stránku =====
@@ Line 38: / Line 38: @@
 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.
 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í.
 <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ů =====
@@ Line 50: / Line 51: @@
 ~~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 =====
-<box round 95% #DEE7EC>:!: 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í.</box>
+<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.
@@ Line 59: / Line 64: @@
    * Číslo verze obsahuje pouze číslice a tečky (např. 2.11.0.1)
 Balíček přiložte ke stránce.
-<box round 95% #FF0033>
-:!: 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 center round important 80%>
-</box>
+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ěrte, že se nová stránka zobrazuje v [[user:skript|automaticky generovaném přehledu doplňků]].
+  * ověřte, že se nová stránka zobrazuje v [[user:skript|automaticky generovaném přehledu doplňků]].
-Administá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.
+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.
 ===== Řekněte o doplňku uživatelům =====
-Pokud jste přidali na server nějaký skutečně pěkný doplňek, ř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]].
+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]].
-{{tag>gge ggs ggv}}