GeoGet

Complete geocaching solutions

User Tools

Site Tools


user:navody:statistiky:template

Template.extended - šablona pro GgStat

Vzorová šablona pro GgStat, která využívá řadu doplňků a triků pro rozšíření obsahu i funkčnosti statistiky. Část použitých technik je popsána na stránce triky a vychytávky. Aplikování dílčích návodů na vlastní šablonu a sladění všech nastavení je ale dost pracné, proto jsem se rozhodl raději zveřejnit celou vzorovou šablonu. Je odvozena od šablony, kterou používám ve svém profilu. Lehce jsem ji očistil od osobního balastu a vyřadil části, tvořené mým zatím nezveřejněným pluginem. Kvůli přehlednosti a snazším úpravám je šablona rozdělena na více souborů. Začátečníci mohou použít šablonu jak je, pokročilí ji mohou vzít jen jako základ vlastního díla.

Vzhledem k vývoji situace kolem GgStatu zůstane tahle šablona jako slepá ulička vývoje. Myšlenky zde obsažené jsou zapracovány do Statoru, nového generátoru statistik…

Autor

Diskuze

  • Diskuze o Template.extended se nachází na stránkách FIXME Geocaching.cz.

Vlastnosti

  • Vše (jednotlivé části šablony a podpůrné pluginy) se nainstaluje jedním balíčkem.
  • Statistiky jsou rozděleny na záložky, v rámci záložek na sekce. Sekce je základním stavebním kamenem Template.extended. Konfigurace obsahu statistiky spočívá ve výběru předdefinovaných sekcí a jejich zařazení do seznamů na záložkách. Sekce mohou obsahovat i podsekce, což jsou standardní záhlaví GgStatu.
  • Sekce se dají pro lepší přehlednost sbalit a rozbalit. Ve výchozím stavu jsou rozbaleny jen vybrané sekce. Hlavička sekce je rozlišena ikonou podle obsahu.
  • Vzhled (barvy grafů a tabulek, rámečky sekcí) je maximálně přizpůsoben integrovaným jednoduchým statistikám od Groundspeaku. “Komu se to nelíbí, ať si…” - ne ne, to ne, ať si to změní. :-)
  • Celá šablona je pouze česky.
  • Obsah statistik je rozšířen řadou doplňků, často pomocí GgsExpr. Jedna záložka je věnovaná odznakům, generovaným skriptem BadgeGen II, jedna obsahuje GeoPuzzle, na záložce vlastních keší můžete použít výstup z pluginu MyOwnStat.
  • Pro generování speciálních seznamů keší, grafů a zajímavých čísel jsou často použity tagy. Kromě standardních i několik speciálních.
  • Doplňky vytvářejí řadu proměnných, které lze použít do popisných textů.
  • Soubor šablony je rozdělen na větší než malé množství částí. Ale nebojte se, je to kvůli přehlednosti a snadnější správě. Jen v některých z nich bude třeba něco upravit a dokonce i bez jakýchkoliv změn se vám statistika vygeneruje.
  • V některých částech je použit odkaz na Project-CG. Snadno tak třeba zjistíme, kde máme v okolí neodlovené keše, které nám chybí do tabulky D/T apod. Při prvním použití je nutné se na Project-GC přihlásit (resp. potvrdit autentizaci přihlášení webu Project-GC na Geocaching.com).

Instalace

FIXME (viz Gord) - předělat na balíček, který zařídí vše potřebné

  1. Soubory FIXME šablony rozbalte do kořenové složky GgStatu ./script/GgStat.
  2. Nainstalujte pluginy GgsExpr, SvetloTma, BadgeGen II, GeoPuzzle a MyOwnStat.
  3. Nainstalujte plugin Combine a do něj dávku FIXME Doplnění tagů pro Template.extended.
  4. Jako šablonu, kterou generujete statistiky, nastavte soubor Template.extended.cz.
  5. Proveďte základní nastavení podle následující kapitoly.

Pak už jen stačí spustit generování statistiky a nahrát ji do profilu. A je hotovo!

Nastavení

Obsah šablony

FIXME Zde jen velmi stručně, detailní tabulku s popisem všech souborů zařadit “do přílohy”. Pokud bude sekcí a záložek připraveno víc, než použito, okomentovat. Možná udělat i S|M|L|XL varianty záložek (případně začátečník|FTF lovec|drsnokačer)…?!? Varianty asi jako podadresáře Tabs, kde budou soubory Tab*.cfg stejných jmen a jen se nakopírují.

Texty do záložek

Mapy

Tagy

Šablona předpokládá existenci tůzných tagů. Podle nich se tvoří speciální seznamy keší, vytváří grafy a počítají různá čísla. Kromě standardních tagů GeoGetu a jeho integrálních doplňků (jako tagy Favorites, Elevation, GCVote-median, Vote), použítá šablona i tyto další tagy:

TagNastavuje seHodnotaPoužívá se pro
FTFručněFTF | STF | TTFvšechny xTF seznamy, grafy a čísla
FTFNejručně redukovaný seznam jen těch zajímavějších FTF1)
FTFMaturityzatím ručně2)<dní od publikace>seznam keší nejdéle odolávajících FTF3)
SvetloTmapluginem SvetloTmaSvetlo | Tmakoláčový graf podílu odlovů za světla a za tmy
NejNejručně seznam legendárních lovů - do seznamu se jako popis použije obsah tagu NejPopis
NejTypručně<v čem byla první nebo nej>4)seznam keší, které byly v něčem první nebo nej - do seznamu se jako typ použije obsah tagu NejTyp a jako popis obsah tagu NejPopis
NejPopisručně<popis>klidně i delší popis, použitý v obou seznamech - “legendární lovy” i “první a nej”
StatExtdávkou CombineFirstFoundByCountryseznam prvních keší v odlovených zemích
FirstFoundByCacheTypeseznam prvních keší podle typu
HighestFoundByCountryseznam nejvyšších keší v odlovených zemích
FirstFTFByCountryseznam prvních FTF v odlovených zemích
CZ okres T5dávkou Combine za použití skriptu TagCopy<název okresu podle tagu CZ okres>mapa okresů s T5 odlovy

Vlastní keše

Nastavení pluginů

Výstupy použitých pluginů je možné si konfigurovat podle vlastních představ. Jen je třeba dodržet tyto parametry: FIXME (konfigurace pluginem?!?)

BadgeGen II

  • Šířka plochy v px: 740
  • Kódování: ANSI
  • Jazyk: CZ

MyOwnStat

  • Šířka stránky: 730
  • Kódování: ANSI
  • Jazyk: CZ
  • Hlavička keše: M (doporučeno)

Další možnosti úprav

Použití proměnných v textu

Odstranění záložky

Změna sekcí na záložkách

Vytvoření vlastní sekce

Změna grafiky úvodního textu záložky

Vedle úvodního textu je na záložkách grafika. Pro jednoduchost jsou použity odznaky typu, který má souvislost s obsahem záložky. Je samozřejmě možné si odznaky vyměnit za jiné nebo použít jakékoliv jiné obrázky, umístěné na webu. Doporučuji jen dodržet šířku obrázku 100 pixelů. Odkaz na obrázky změnite v souborech s definicí obsahu jednotlivých záložek, tedy v souborech Tabs\Tab.*.cfg.

Seznam souborů šablony

Šablona je z důvodu přehlednosti a snadnějších úprav rozdělena na více částí. Do samostatných souborů jsou odděleny definiční části šablony, jednotlivé záložky, části generující hodnoty pomocí GgsExpr, apod. Dále v textu jsou označeny části, kde se čekají uživatelské úpravy:

  • Části, které je nutné upravit, mají v seznamu značku Nutno upravit.
  • Části, které je úprava jen doporučená nebo možná, mají v seznamech značku Doporučeno upravit nebo Možno upravit.
  • Do budoucna se uvažuje o nástrojích, které budou šablonu Template.extended konfigurovat klikací způsobem. Části, kde se předpokládá, že budou vznikat jako výsledek konfigurace nástrojem, mají v seznamu značku Upraví se nástrojem. FIXME Otazka (Gord): To má znamenat, že plugin soubor vytvoří nebo změní nebo že spustí editor k jeho ruční úpravě uživatelem? Prosím upravit formulaci, aby to bylo zřejmé,
  • Do ostatních souborů není potřebné nijak zasahovat. Pokud nevíte přesně co děláte, tak to ostatně ani nedoporučuji.

Hlavní

SouborPopis
Template.extended.czHlavní soubor šablony. Ten prosím použijte při generování statistiky FIXME (viz Gord). Obsahuje základní parametry včetně barev, hlavní kostru statistiky, definuje záložky a vkládá do nich obsah pomocí souborů Tabs\Tab.*.cfg. Editovat přímo zde můžete existenci záložek, případně barvy. Možno upravit

Definice a parametry

SouborPopis
Params.cfg Nutno upravit
Lang.cfg
DefineTag.cfg
Tabs.cfg Upraví se nástrojem

Záložky

Všechny soubory, definující vlastní obsah záložek jsou umístěny v podadresáři Tabs.

Konvence pojmenování souborů
SouborPopis
Tab.<jméno_záložky>.cfgHlavní soubor záložky, do něj se vkládají další dva soubory.
Tab.<jméno_záložky>.Text.cfgÚvodní text na záložce. Úvodní text je Doporučeno upravit, případně nechat prázdný.
Tab.<jméno_záložky>.Sections.cfgSoubor obsahuje seznam sekcí, které jsou v záložce zobrazeny. Soubor je automaticky generován pluginem podle toho, které sekce si uživatel v pluginu vybere. U každé sekce je v pluginu možné určit, zda ve výchozím stavu bude sekce rozbalena a bude vidět její obsah nebo bude sbalena jen do nadpisu s možností jejího rozbalení.5)

:!: Protože každá záložka je definovaná právě těmito třemi soubory, je v následujícím popisu uveden jen hlavní soubor záložky. Jména zbylých dvou si čtenář jistě sám odvodí. V je pak uved seznam sekcí, které jsou v záložce (jejich seztnam je tedy v souboru Tab.<jméno záložky>.Sections.cfg).

SouborPopis
Tabs\Tab.Main*.cfgObsah záložky Přehled. Záložka se zobrazí jako výchozí při otevření profilu a obsahuje sekce Zajímavá čísla, Nejlepší dny a Nálezy podle měsíce6).
Tabs\Tab.Maps*.cfgObsah záložky Mapy (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main). Pokud lovíte jen po Evropě, nebude potřeba nic měnit. Světoběžníci si mohou zapnout odlovené světadíly nebo přidat nějakou speciální zemi.
Tabs\Tab.Stat*.cfgObsah záložky Statistiky (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main). Histogramy, koláče, grafy, tabulky křížové i seznamy. Je zde toho celkem dost. Jediným problémem by mohla být poslední sekce Nálezy podle času. Vyžaduje mít u logů i čas odlovu. Kdo nemá, může celou sekci vypustit.
Tabs\Tab.Milestones*.cfgObsah záložky Milníky a legendy (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main).
Tabs\Tab.FTF*.cfgObsah záložky FTF (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main).
Tabs\Tab.Owned*.cfgObsah záložky Naše kešky (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main).
Tabs\Tab.Badges*.cfgObsah záložky Odznaky (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main).
Tabs\Tab.Puzzle*.cfgObsah záložky Puzzle (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main).
Tabs\Tab.About*.cfgObsah záložky O nás (včetně souborů *.Text.cfg Doporučeno upravit a *.Sections.cfg Upraví se nástrojem - viz záložku Main). Na rozdíl od většiny ostatních částí statistiky je tato záložka dost osobní. Většinu obsahu tvoří text, chtělo by to napsat něco o sobě, doplnit na přátele apod. Na druhou stranu je také možné celou záložku vypustit.

Sekce

Sekce je základním stavebním kamenem Template.extended. Každý soubor definuje celou jednu sekci. Všechny soubory sekcí jsou umístěny v podadresáři Sections.

SouborPopis
Sections\Section.SomeNumbers.cfg
Sections\Section.BestDays.cfg
Sections\Section.FindsByMonths.cfg
Sections\Section.MapEurope.cfg
Sections\Section.MapEuropeLarge.cfg
Sections\Section.MapWorld.cfg
Sections\Section.MapWorldContinents.cfg
Sections\Section.MapCzech.cfg
Sections\Section.MapSlovakia.cfg
Sections\Section.MapGermany.cfg
Sections\Section.MapAustria.cfg
Sections\Section.MapFrance.cfg

Výpočty a generování obsahu

SouborPopis
SomeNumbers.cfg
AddSomeNumbers.cfg
BestDays.cfg
FTFGraph.cfg
FTFNumbers.cfg
FTFNumbersTable.cfg
OwnCacheGraph.cfg

Ostatní

SouborPopis
SectionHeader.cfg
SectionStart.cfg
SectionEnd.cfg
SectionSetOpened.cfg
SectionSetClosed.cfg
SetVariables.cfg

Seznam proměnných

Kromě standardních proměnných GgStatu, popsaných v jeho dokumentaci vytváří Template.extended řadu dalších proměnných. Mnohé z nich šablona používá do grafů, tabulek a zajímavých čísel, mnohé z nich jsou úplné zbytečnosti. Všechny je možné zároveň použít i do vlastních textů. Proměnné jsou rozděleny do skupin:

Vzdálenost od keše ke keši

  • %TOTALDISTANCE% - celková vzdálenost od keše ke keši (nejde o proměnnou Template.extended, ale o základní proměnnou GgStatu, zde je uvedena jen z důvodu, že existuje až v poslední verzi GgStat 1.1.36a a není uvedena v dokumentaci dodávané s programem)
  • %EarthCirc% - podíl celkové vzdálenosti a obvodu Země
  • %MoonDist% - podíl celkové vzdálenosti a vzdálenosti k Měsíci

Počet slov logů

  • %TotalWords% - celkový počet slov
  • %TotalWordsThs% - celkový počet slov v tisících
  • %PocetBibli% - na kolik Biblí (Kralických) by logy stačily

Milníky

  • %NextMilestone% - číslo příštího stovkového milníku
  • %NextBigMilestone% - číslo příštího tisícovkového milníku
  • %NextMilestonDays% - počet kalendářních dní do stovkového milníku
  • %NextBigMilestonDays% - počet kalendářních dní do tisícovkového milníku
  • %NextMilestonCachingDays% - počet kešovacích dní do stovkového milníku
  • %NextBigMilestonCachingDays% - počet kešovacích dní do tisícovkového milníku
  • %NextMilestoneDate% - datum příštího stovkového milníku
  • %NextMilestoneWeekDay% - den v týdnu příštího stovkového milníku
  • %NextBigMilestoneDate% - datum příštího tisícovkového milníku
  • %NextBigMilestoneWeekDay% - den v týdnu příštího tisícovkového milníku

Do konce roku

  • %DaysToEndOfYear% - počet dní do konce roku
  • %CachesToEndOfYear% - odhad počtu odlovů do konce roku
  • %TotalCachesOnEndOfYear% - odhad celkového počtu odlovených keší na konci roku

Datum a čas

  • %CurrDate% - aktuální datum (tj. datum generování statistiky) ve formátu d.m.rrrr
  • %CurrDateTime% - aktuální čas (tj. čas generování statistiky) ve formátu hh:mm
  • %CurrDateWeekDay% - aktuální den v týdnu (tj. den generování statistiky)

Lovy za světla a za tmy

  • %Svetlo% - počet nálezů za světla (nastavuje plugin SvetloTma)
  • %Tma% - počet nálezů za tmy
  • %PodilSvetla% - podíl nálezů za světla
  • %PodilTmy% - podíl nálezů za tmy

Po sobě jdoucí dny lovu/nelovu (streaky)

  • %NumConsFound% - nejdelší období s nálezem (denní streak nálezů)
  • %StartConsFound% - jeho datum začátku
  • %EndConsFound% - jeho datum konce
  • %NumConsEmpty% - nejdelší období bez nálezu
  • %StartConsEmpty% - jeho datum začátku
  • %EndConsEmpty% - jeho datum konce

Ostatní počty

  • %DisableCount% - počet disable keší z nalezených
  • %DisablePerc% - podíl disable
  • %ArchiveCount% - počet archivovaných
  • %ArchivePerc% - podíl archivovaných
  • %PMOCount% - počet Premium Members Only keší
  • %PMOPerc% - podíl PMO
  • %CountryCount% - počet zemí s nálezy
  • %Nad1000m% - počet keší s nadmořskou výškou nad 1 km
  • %PodilNad1000m% - podíl nad 1 km
  • %NadSnezku% - počet keší s nadmořskou výškou vyšší, než Sněžka
  • %AvgFavoritesOnFound% - průměrný počet favoritních bodů na nalezených keších
  • %mdCachingPoints% - celkový počet bodů za ulovené keše podle váženého bodování www.macdefender.org
  • %CachingKarma% - kešovací karma - tj. podíl logů na založených keších a nálezů
  • %CombRatio% - (tohle už je úpná hovadina) podíl počtu nálezů na celkovém počtu kombinací Obtížnost/Terén/Typ keše/Den/Mesíc/Hodina/Den v týdnu/Rok a měsíc založení

xTF

  • %MyFTFCount% - celkový počet FTF nálezů
  • %MySTFCount% - celkový počet STF nálezů
  • %MyTTFCount% - celkový počet TTF nálezů
  • %FTFIndex% - celkový FTF index
  • %FTFInterval% - průměrný interval mezi FTF nálezy v kalendářních dnech
  • %FTFIntervalCachingDays% - průměrný interval mezi FTF nálezy v kešovacích dnech
  • %NextFTFMilestone% - příští stovkový FTF milník
  • %NextFTFMilestoneDate% - očekávané datum příštího stovkového FTF milníku
  • %NextFTFMilestoneWeekDay% - den v týdnu očekávaného data FTF milníku
  • %BestFTFNum1% - nejvyšší počet FTF za den
  • %BestFTFDay1% - datum, kdy byl dosažen
  • %BestFTFNum2% - druhý nejvyšší počet FTF za den
  • %BestFTFDay2% - datum, kdy byl dosažen
  • %BestFTFNum3% - třetí nejvyšší počet FTF za den
  • %BestFTFDay3% - datum, kdy byl dosažen
  • %BestFTFMonthNum% - nejvyšší počet FTF za měsíc
  • %BestFTFMonth% - měsíc, kdy byl dosažen
  • %BestFTFYearNum% - nejvyšší počet FTF za rok
  • %BestFTFYear% - rok, kdy byl dosažen

FTF streaky

  • %NumConsFTFMonths% - nejdelší období s FTF nálezem během měsíce (měsíční streak FTF)
  • %StartConsFTFMonths% - jeho měsíc začátku
  • %EndConsFTFMonths% - jeho měsíc konce
  • %NumConsFTFound% - nejdelší období s denním FTF (denní streak FTF)
  • %StartConsFTFound% - jeho datum začátku
  • %EndConsFTFound% - jeho datum konce
  • %NumConsFTFEmpty% - nejdelší období bez FTF
  • %StartConsFTFEmpty% - jeho datum začátku
  • %EndConsFTFEmpty% - jeho datum konce
1)
pokud na záložce FTF změníme seznam na všechna xTF, nebudeme tag potřebovat
2)
Combine na to bohužel nestačí a plugin, který používám ještě není dotažen ke zveřejnění
3)
pokud seznam na záložce FTF zrušíme, nebudeme tag potřebovat
4)
Např. První stromovka, Nejdelší hledání nebo První podvodní keš
5)
Stav sekcí se přepíná vložením SectionSetOpened.cfg nebo SectionSetClosed.cfg do seznamu sekcí.
6)
ve výchozím nastavení se zde zobrazují všechny roky, je možné je omezit příkazem HIDEYEARS v hlavním souboru Template.extended.cz
user/navody/statistiky/template.txt · Last modified: 2016/01/23 00:00 (external edit)