GgsCwgList - plugin pro GgStat

Obsah souboru:

• Obsah distribučního balíčku
• Funkce pluginu
• Instalace
• Popis práce pluginu
• Příkazový řádek
• Konfigurace pluginu
• Doprovodná makra pro GeoGet
  • Makro pro nastavení TAGu
  • Makro pro export seznamu vlastněných CWG
• Technické podrobnosti o uložení informací o vlastněných CWG
• Ukázka použití pluginu

GgsCwgList.exe je plugin pro GgStat.exe, pomocí něhož je možné do statistik vložit seznam a obrázky všech nalezených, vyměněných nebo jinak získaných CWG. Seznam je tvořen kartami s CWG. Velikost a barvy karty lze měnit. Údaje na kartě mohou obsahovat:

• klikací nick majitele CWG nebo ID keše, ke které je CWG vydáno (např. event)
• klikací odkaz kešky, z které bylo CWG vyzvednuto
• datum získání CWG (implicitně podle nálezu keše, ale hodnotu lze změnit na jiné datum, například v případě vyzvednutí při opakované návštěvě keše)
• obrázek příslušného CWG; pro CWG vydané ve více verzích lze určit, o kterou z verzí jde a tento obrázek se na kartě zobrazí
• seznam je možné členit do samostatných tabulek podle typu (např. nalezené v keši, vyměněné, vlastní CWG, ...)
• stejným způsobem je možné pracovat prakticky s libovolnými "osobními" předměty a je možné k nim zobrazit i vlastní obrázek

Všechny zobrazené informace lze doplnit o krátkou poznámku, která se objeví jako "bublina" při najetí myšího kurzoru na příslušné místo v kartě.

Lze definovat barvy a velikosti celého seznamu, karty, písma a obrázku CWG.

Seznam karet je definován při generování statistiky, plugin automaticky získává potřebné informace z databáze GeoGetu, z oficiálního CWG serveru, jehož informace doplňuje z častěji aktualizovaného Maxinohova serveru.

Plugin si uchovává poslední načtenou verzi seznamů a pokud nejsou seznamy dostupné online, použije tuto zálohu. Pro vytvoření seznamu není tedy nezbytně nutné být online. Seznam slouží i pro makro s formulářem jako zdroj dat pro výběr správného jména CWG

Volitelně je možné zařadit na začátek seznamu tlačítka pro změnu řazení karet s CWG.

Automatická instalace probíhá standardním postupem nejlépe pomocí správce pluginů v GeoGetu. Během instalace je převeden starý formát záznamu o CWG na nový a protože došlo i ke změně formátu offline katalogu, automaticky se načte z webu i poslední verze.

Nová instalace vytvoří samostatný adresář v DATADIR\script. Pro začlenění výstupu do statistik je potřeba doplnit do souboru Template volání pluginu a nastavení parametrů. Příkazy a parametry pluginu použité v souboru Template jsou uvedeny v části Konfigurace pluginu.

Plugin načte z obou serverů nebo z uložené zálohy seznam všech CWG v katalogu a dostupné informace o nich. Rozsah informací se liší podle serveru, takže CWG, která nejsou v oficiálním katalogu, nemají některé odkazy klikací.

Plugin načte z databáze GeoGetu a ze souboru určeného příkazem FileMyCwg seznam všech vlastněných CWG a informace, které mají upravit nebo doplnit podrobnosti o jednotlivých CWG. Vytvořený seznam předá programu GgStat.exe pro začlenění do souboru se statistikou.

Plugin může nastavit GgStatu proměnnou, která bude obsahovat celkový počet vlastněných CWG. Tuto proměnnou je pak možné použít třeba k doplnění textu pod obrázky s CWG. Viz níže příkaz CwgCount. Upozorňuji, že tato hodnota může být vypsána až po zpracování seztnamu CWG, nelze tedy tímto způsobem vypsat počet CWG například do nadpisu části statistik s CWG. (S jistým omezením leze počet CWG získat také pomocí pluginu GgsExprTag a tuto hodnotu v nadpisu použít lze, pokud bude plugin použit před generováním tabulky s CWG.)

Za normálních okolností asi parametry příkazového řadku nebudou nijak využívány. Mohou se ovšem vyskytnout situace, kdy použití některého z nich bude užitečné. V případě spouštění pluginu pomocí GgStat.exe jsou parametry zapsány:
PLUGINSTART GgsCwgList.exe parametry

Parametry:

Konfigurace se skládá z několika částí:

1. úprava souboru Template pro program GgStat.exe - doplnění příkazu pro spuštění pluginu a definice některých hodnot pomocí příkazů pluginu. Stačí ty příkazy, kde nemají být použité implicitní hodnoty. Ukázka příkazů vložených do souboru Template je níže, v části "Ukázka použití pluginu". Možné příkazy jsou:

   OfflineDir xxx	adresář, kde budou uloženy poslední načtené seznamy CWG, tato "záloha" může také sloužit k ověřování platných jmen CWG, viz níže
   CardItems xxx	definuje, co bude na kartě zobrazeno a v jakém pořadí. Jedná se o mezerou oddělený seznam položek Příklad: CardItems Nick Date CWG Nick jméno CWG (majitel nebo keška) Date datum nálezu CacheId GC kód keše, v které bylo CWG nalezeno Img katalogové číslo CWG
   TagName xxx	Kategorie TAGu, v kterém jsou uloženy nalezené CWG a upřesňující informace k zobrazení jednotlivých karet s CWG
   FileMyCwg CP FILE	načte z uvedeného souboru seznam vlastněných CWG. Je to jakási zjednodušená alternativa TAGu. Každý řádek souboru obsahuje jméno jednoho CWG, soubor je kódován ve stránce CP (možné hodnoty jsou utf-8, cp1250 , ...). Lze kombinovat načítání ze souboru i načítání z TAGu, takže pokud někdo u stávajících CWG nezná příslušná data a u nových je chce evidovat, není v tom žádný problém. Cesta k souboru je buďto absolutní nebo relativní vůči DATADIR. DATADIR je aktuálním adresářem při spouštění všech pluginů z GeoGetu.
   UseType xxx	zpracuje jen CWG, která mají <TYP="xxx"/>, ostatní ignoruje. To umožňuje rozdělit zpracování CWG do samostatných seznamů (např. nalezené, vyměněné, vyměněné poštou, vlastní, CWG kačerů, CWG keší, ...). Příkaz je možné použít vícekrát, v tom případě budou zpracovány typy uvedené ve všech příkazech.
   NoFromDb	plugin bude ignorovat CWG uvedená v databázi GeoGetu a bude pracovat jen se souborem uvedeným v příkaze FileMyCwg. Příkaz je dalším prostředkem, jak rozdělit seznam CWG do více částí (např. získané v keši nebo mimo keš)
   Sort xxx	podle čeho karty CWG seřadit; možné hodnoty jsou Nick jméno CWG (majitel nebo keška) Date datum nálezu CacheId GC kód keše, v které bylo CWG nalezeno Img katalogové číslo CWG
   SortButtons xxx	seznam může obsahovat tlačítka pro změnu řazení CWG přímo ze stránky se zobrazeným seznamem. Řazení je realizováno pomocí Javascriptu, takže v závislosti na povoleném skriptování na serveru geocaching.com funkce řazení nemusí pracovat. Platné parametry jsou Yes nebo No. Implicitně tlačítka pro změnu řazení nejsou zobrazena.

   Následující hodnoty definují zobrazení informací. Jejich definice a zápis hodnot odpovídá příslušným definicím v HTML. Jednotky velikostí nepoužívejte, jsou vždy doplněny jako px.

   DivHeight xxx	zobrazená délka seznamu CWG. Pokud bude seznam delší, bude mít rolovátko. 0 znamená, že bude zobrazen vždy celý seznam bez rolovátka
   DivWidth xxx	šířka tabulky se seznamem CWG
   CardWidth xxx	šířka jedné karty s CWG
   CardHeight xxx	výška jedné karty s CWG
   CardBorderSize xxx	tloušťka rámečku okolo karty
   CardBorderColor xxx	barva rámečku okolo karty
   CardBorderStyle xxx	styl rámečku okolo karty
   CardBgColor xxx	barva karty s CWG
   TableBgColor xxx	barva pozadí tabulky (implicitně je použitá tato hodnota z GgStatu jako první položka příkazu COLORS, tato hodnota má vyšší prioritu)
   TableColor xxx	barva písma tabulky a karet CWG (implicitně je použitá tato hodnota z GgStatu GgStatu jako druhá položka příkazu COLORS, tato hodnota má vyšší prioritu)
   ButtonColor xxx	barva tlačítek pro změnu řazení karet CWG (implicitně je použitá tato hodnota z GgStatu jako třetí položka příkazu COLORS, tato hodnota má vyšší prioritu)
   FontSize xxx	velikost použitého fontu
   FontFamily xxx	definice fontu
   CwgSize xxx	velikost obrázku s CWG
   CwgCount Jméno	plugin na konci své práce předá GgStatu příkaz pro nastavení proměnné Jméno tak, aby obsahovala celkový počet vlastněných CWG. Tuto proměnnou je pak možné využít třeba k výpisu souhrnného textu pod přehledem CWG. Protože hodnota proměnné je předána zpět volajícímu GgStatu, není možné tímto způsobem hodnotu zobrazit před seznamem CWG. Zatím je jedinou možností, jak ji zobrazit "dopředu", použít plugin GgsExprTag, pomocí něj spočítat počet CWG a zobrazit jej ještě před voláním pluginu GgsCwgList.

2. vytvoření seznamu vlastněných CWG - seznma vlastněných CWG je kombinací CWG uložených v databázi GeoGetu a seznamu CWG v souboru určeném příkazem FileMyCwg. Pro manipulaci s těmito informacemi jsou v distribučním balíčku 2 makra. Jedno makro je aktivovatelné ze zobrazeného listingu keše (ggc) a druhé makro ze seznamu zobrazených keší (ggp, zpracuje všechny označené keše).

   Při znalosti podrobností je možné použít i manuální způsob pomocí nastavení TAGů vlastním GeoGetem, ale proč to dělat složitě, když existuje nástroj pro jednodušší manipulaci.

Makra pro nastavení informací o CWG

Makro pro export seznamu vlastněných CWG

Technické podrobnosti o uložení informací o vlastněných CWG

Ukázka použití pluginu