# Dokumentace k pluginu 'Gravatar'

Dokumentaci k tomuto pluginu přeložil do češtiny Vladimír Ajgl (vlada [zavinac] ajgl [tecka] cz) dne 26.6.2011. Od té doby mohl být plugin pozměněn nebo mohly být rozšířené jeho funkce. Zkontrolujte pro jistotu i aktuální německou dokumentaci, anglickou dokumentaci a ChangeLog.

# Dokumentace k pluginu: Avatar Plugin (Gravatar)

## Obsah

1. Přehled

1. Gravatar
2. Pavatar
3. Favatar
4. Twitter
5. Identica
6. MyBlogLog
7. Wavatar
8. MonsterID
9. Identicon/YCon
10. Standardavatar

2. Nastavení

1. Pořadí vložení Avatarů
2. Standard-Avatar
3. Zobrazovat v postranním panelu
4. Zobrazovat podporované typy avatarů
5. Jméno autora v atributu ALT
6. Generovat Smarty Tag
7. Zarovnání
8. Velikost obrázku
9. Doba cachování
10. Indikace Gravataru
11. Gravatar Fallback (zpracování chyby)
12. Vždy vyžadovat Gravatar Fallback

3. ChangeLog (historie verzí)

## Přehled

Pomocí pluginu Avatar lze přiřadit komentujícím v blogu přiřadit "obličej". Každému samostatnému komentátorovi lze přiřadit takzvaný Avatar, který ho reprezentuje. K tomu lze použít několik různých mechanizmů, jak umožnit komentujícím použití avatara, které budou v následujícím textu probrány.

Vždy je použit první mechanizmus, který nalezne avatara. Další způsoby pak nejsou ani zkoušeny. To znamená, že je třeba seřadit metody v tom pořadí, aby byly co nejdříve použity nejčastěji používané mechanizmy. Způsoby, které poskytnou avatara v každém případě, by měly být umístěny až na konci, protože po nich zařazené metody nebudou přirozeně nikdy uplatněny.

Důležité: Tento plugin musí být umístěn v seznamu pluginů před všemi pluginy, které mění odkazy, jako například "Markup: Sledování odchodů" (Exit Tracking Plugin). Jinak nemusejí fungovat například avatary, které jsou generovány na základě odkazů na stránky komentátorů.

Následuje popis aktuálně dostupných mechanizmů, jak přiřadit avatara komentátorům:

nahoru

### Gravatar

Gravatar je jedna z nejznámějších služeb pro uživatele avatarů. Uživatele se mohou u této služby registrovat pomocí emailu, na který je vázán obrázek avatara.

Gravatary jsou tedy spřažené s emailem komentátora. Pouze pokud komentátor zadá svůj mail, je možné dotázat se Gravataru, jestli je pro daný mail registrován obrázek avatara.

nahoru

### Pavatar

Pavatary jsou avatary (obrázky), které pro tento účel nahrál uživatel na svoji domovskou stránku.

Oproti velmi podobným Favatarům sem může uživatel nahrát obrázek avatara v libovolném rozlišení.

V tomto případě se zjišťuje avatar na základě domovské stránky, kterou zadal komentátor, konkrétně jestli tato domovská stránka obsahuje Pavatara. Tento způsob zjišťování avatara je použit přirozeně pouze v případě, že komentátor zadal domovksou webovou stránku.

nahoru

### Favatar

Toto je koncept, pomocí kterého má spousta vlastníků webových stránek Avatara, aniž pro to musejí cokoliv udělat:

Blog použije jednoduše favicon (ikonku webu) ze stránky, kterou komentátor zadal jako svoji domovskou. Favicon je obvykle jenom obyčejná ikona, která bývá docela malá a často nevypadá jako avatar.

nahoru

### Twitter

V případě, že komentátor zadá adresu domovské stránky jako URL profilu na Twitteru, pak bude tento profil prohledán, jestli obsahuje profilovou fotku, která bude následně použita jako avatar.

Poznámka: Pokud je zároveň použito hledání metodou "Favatar", pak musí stát tato metoda Twitter před Favatarem, protože jinak bude místo obrázku z profilu použita favicona Twitteru. Což může být na druhou stranu použito úmyslně, například k jasnému a jednoznačnému označení "tweetbacků" z Twitteru.

nahoru

### Identica

Toto je zvláštní avatar pro pingbacky Identica. V tomto případě je hledán profilový obrázek uživatele, který poslal pingback.

Poznámka: Pokud je zároveň použito hledání metodou "Favatar", pak musí stát tato metoda Identica před Favatarem, protože jinak bude místo obrázku z profilu použita favicona Identicy. Což může být na druhou stranu použito úmyslně, například k jasnému a jednoznačnému označení "tweetbacků" z Identicy.

nahoru

### MyBlogLog

Toto je opět centrální služba (podobně jako Gravatar). MyBlogLog je služba poskytující blogy, ale zároveň z ní lze získat avatary.

Přítomnost MyBlogLog avatarů je zjištěna z domovské adresy komentátorů.

nahoru

### Wavatar

Wavatar je dynamicky vyroben z domovské stránky a emailové adresy komentátorů. Poskytuje pro každého uživatele jiný, ale vždy stejný obrázek. Tímto způsobem je vždycky vložen avatar, tedy všechny metody zařazené po této budou ignorovány. Wavatary vypadají asi následovně:

nahoru

### MonsterID

MonsterID avatary jsou generovány stejným mechanizmem jako Wavatary nebo Idnetikony. V tomto případě jsou vygenerovány takovéto roztomilé "příšerky" (monstra).

Podobně jako u Wavataru a Identikon je tímto způsobem vždycky vložen avatar, tedy všechny metody zařazené po této budou ignorovány.

nahoru

### Identicon/YCon

Avatary Identicon (identikony) jsou generovány stejným mechanizmem jako Wavatary nebo MonsterID. V tomto případě jsou vygenerovány abstraktní obrazce.

Podobně jako u Wavataru a MonsterID je tímto způsobem vždycky vložen avatar, tedy všechny metody zařazené po této budou ignorovány.

nahoru

### Standardavatar

Metoda "Standardavatar" poskytuje vždycky stejný obrázek pro všechny uživatele. Obrázek, který bude použit, lze zadat v sekci "Nastavení".

nahoru

## Nastavení

### Pořadí vložení Avatarů

Zde je zadáno pořadí zkoušení jednotlivých metod pro zjištšění avatarů ke komentátorům.

V současnosti existuje 6 metod, ze kterých je možné pořadí sestavit. Je třeba dát pozor na to, že metody, které generují avatara pokaždé, jsou poslední, které jsou vyzkoušeny, všechny následující metody jsou ignorovány.

nahoru

### Standard-Avatar

URL adresa ke standardnímu avataru. Tady musíte zadat relativní nebo absolutní URL adresu k obrázku standardního avataru.

nahoru

### Zobrazovat v postranním panelu

Mají se obrázky avatarů zobrazovat i v postranním panelu (poslední komentáře)?

nahoru

### Zobrazovat podporované typy avatarů

Pokud je zaškrtnuto, pak se pod políčkem k vložení komentáře objeví řádek s výčtem podporovaných avatarů.

nahoru

### Jméno autora v atributu ALT

Normálně je umístěho jméno autora v atributu TITLE u obrázku, atribut ALT je pak vyplněn hvězdičkou "*", aby se v rozvržení stránky nic nerozházelo, pokud nejsou nataženy obrázky. Nicméně z hlediska přístupnosti stránky i pro slepé čtenáře je důležité, aby v atributu ALT něco bylo, protože je to právě tento atribut, který jim je předčítán a podle kterého poznají, co je na obrázku. Pokud tedy chcete podporovat i tyto postižené čtenáře, měli byste tuto volbu povolit.

nahoru

### Generovat Smarty Tag

Pokud je zaškrtnuta tato volby, není obrázek avatara vložen přímo do komentáře, ale místo toho je generován Smarty Tag {$comment.avatar}, který při generování stránky obsahuje HTML kód pro zobrazení obrázku. Tuto volbu byste měli zapnout pouze pokud víte, že šablona vzhledu, kterou požíváte, podporuje tento tag. Jestli tomu tak opravdu je, můžete jednoduše vyzkoušet.

nahoru

### Zarovnání

Pomocí této volby můžete zadat zarovnání avatara vzhledem ke komentáři, tedy pokud nepoužítáve volbu Smarty Tag. V případě, že Smarty Tag používáte, pak musíte k zarovnání obrázku použít odpovídající CSS třídu ve stylopisu.

nahoru

### Velikost obrázku

Maximální zobrazená velikost avataru v pixelech.

nahoru

### Doba cachování

Když mají být avatary dočasně ukládány (doporučeno!), musí být zde uveden počet hodin, během kterých se mají obrázky natahovat z blogového serveru, namísto serveru vzdáleneé avatarové služby. Sice to způsobí lehké zvýšení provozu na vašem blogovém serveru, na druhou stranu se stanou obrázky víceméně nezávislé na přístupnosti serveru externích služeb. "0" znamená vypnutí cachování.

nahoru

### Indikace Gravataru

Dětská pojistka :)

nahoru

### Gravatar Fallback (zpracování chyby)

Metoda Gravatar umožňuje chybovou metodu pro případ, kdy pro uživatele není nalezen žádný avatar. Tou může být jedna z Monster ID, Identicon nebo Wavatar. Pokud nastavíte tuto chybovou metodu pro Gravatara, nebudou zkoušeny žádné další metody pro zjištění avatara, pokud uživatel zadal emailovou adresu.

nahoru

### Vždy vyžadovat Gravatar Fallback

Vyžadovat zpracování chyby Gravatar (Gravatar Fallback) také pokud uživatel nezadal žádný email (ale pokud zadal URL adresu domovské stránky nebo jméno).

nahoru

## Historie verzí (ChangeLog)

- verze 1.54

- Do jazykové konstanty PLUGIN_EVENT_GRAVATAR_SUPPORTED byl přidán parametr %s pro zobrazení podporovaných avatarových služeb.

- verze 1.52

- Změněno zobrazení podporovaných avatarů pod polem pro komentář, aby podporovalo hezké zalamování řádků.

- verze 1.51

- Použití funkce strtolower() pro mailové adresy.

- verze 1.49 [brockhaus]

- Pavatar v blozích s přesměrováním nefungoval, pokud byl odkaz na Pavatar přístupný pouze v informacích tagu "rel link"

- verze 1.48 [brockhaus]

- Oprava: Kompatibilita PHP byla porušena při opravě 1.46 :-/
- Přidán avatar Identica. Použito hlavně pro pingbacky Indetica a mělo by být použito před Favatarem, jinak se bude zobrazovat značka Identica místo obrázku uživatele.
- Vyčištění kódu

- verze 1.47 [brockhaus]

- Vypnutí ladicích výpisů v template_c

- verze 1.46 [brockhaus]

- Přidán Twitter Avatar (pokud URL odkazuje na profil na Twitteru). To je většinou použito pro Tweetbacky a mělo by být použito před Favatarem, jinak se bude zobrazovat logo Twitteru.
- Vyčištění kódu

- verze 1.45 [brockhaus]

- Nápověda
- Vyčištění

- verze 1.44 [brockhaus]

- Přidána podpora Wavatarů
- Podpora pro ošetření chyb (fallback) Gravataru pomocí indetyicon, MonsterID a Wavataru.
- Optimalizace zpětných volání (trackback) avatarů: Querypars budou odstřiženy z URL. Nyní v ukázkovém Serendipity blogu dostanete vždycky stejného cachovaného Avatara, ne samostatného pro jiné stránky.

- verze 1.43 [brockhaus]

- Volba nastavení pro přidání jména autora do attributu ALT u obrázku avatara. Normálně je to vyplněno hvězdičkou "*", ale slepci jsou při prohlížení stránek závislí na tagu ALT, který jim čtečky předčítají, aby se dozvěděli, co je obsahem obrázku.

- verze 1.42 [brockhaus]

- Kódování podtržítka "_" v URL adresách uživatelů, aby se odlišily od oddělovačů. Funkce "urlencode" je nekóduje. Díky uživateli [Tino Schwarze] za objevení a opravu.

- verze 1.41 [garvinhicking]

- Opravena hlavička "Last-Modified" u obrázků avatarů.

- verze 1.40

- Přidána podpora Ycon (http://moblog.wiredwings.com)(

- verze 1.39 [brockhaus]

- Avatary Monster ID je nyní také cachován, protože jejich vytváření trvá dlouho.

- verze 1.38 [brockhaus]

- Podpora Monster ID avatarů (podrobnosti naleznete na http://www.splitbrain.org/go/monsterid)
- Selhání při čerstvé instalaci a času cache nastaveném na 0.
- Podpora nastavení absolutní cesty k standardnímu avataru.
- Po uložení nastavení je nyní cache vždy vyčištěna, aby byly změny viditelné ihned, dokonce i když je cachování zapnuto.
- Pokud plugin nemůže zapisovat do cache, pak to v ladicím módu zapíše do logu a zobrazí výchozí obrázek, pokud není nalezen cachovaný soubor.

- verze 1.37 [brockhaus]

- Řádka pod oknem komentáře informující o podporovaných typech avatarů lze skrýt pomocí nastavení.

- verze 1.36 [brockhaus]

- Přidána nová volba: Můžete nastavit, že plugin nebude vytvářet avatary přímo, ale místo toho pouze tag pro smarty. Pokud je tato volba zapnutá, můžete si definovat v šabloně pro komentáře, kde se mají avatary zobrazovat, a to pomocí tagu $comment.comment_avatar.
- CSS třída avataru se bude měnit podle toho, kde je zobrazen. Pro normální komentáře bude mít třídu "comment_avatar", pro plugin "nejnovější příspěvky" to bude třída "serendipity_plugin_comments_avatar", aby byla možnost jednoduše je označit, ostylovat.
- Nastavení zarovnání avatarů: Nastavení zarovnání bude použito, pokud je avatar vykreslen přímo (ne pomocí smarty).
- Nová volba pro vypínání/zapínání obrázků avatarů v postranním sloupci (nejnovější komentáře).
- Podporovaní metody avatarů se zobrazovaly i pod kontaktním formulářem, což ale nemělo logický smysl. V tomto fromuláři byly tedy avatary vypnuty.
- Další změny v jazykových souborech.

- verze 1.35 [brockhaus]

- Opraveny chyby v anglickém jazykovém souboru. (Díky Donovi!)

- verze 1.34 [brockhaus]

- Hodnocení Gravatarů nepracuje spolehlivě. Můj Gravatar hodnocený jako G je zobrazen pouze při použití hodnocení gravatarů X. :-/
  Přidána volba pro vypnutí parametru hodnocení Gravatarů, což by mělo mít stejný efekt jako nastavení hodnocení X.

- verze 1.33 [brockhaus]

- Pavatar: X-Pavatar Header je nyní znovu podporován a je první použitou metodou automatické detekce Pavatara.

- verze 1.32 [brockhaus]

- Výchozí avatar MyBlogLog nebyl správně detekování. :-/
- Pokud není zadán email ani url adresa, ale je definován výchozí avatar, je nyní zobrazen právě výchozí avatar.

- verze 1.31 [brockhaus]

- Změna času volání (call-time) chyby (pass-by-reference) (fetchAvatar).

- verze 1.30 [brockhaus]

- Standradní Avatar se nezobrazoval, pokud byl blog nainstalován v podadresáři webu a ne přímo v kořenové složce.
- Odkaz na Gravatara byl trochu špatně (přesto fungoval).

- verze 1.29 [brockhaus]

- Oprava chyby 1.27 přidávala k URL "http://", i když nebyla zadána vůbec žádná URL adresa.

- verze 1.28 [brockhaus]

- V Serendipity 1.1 nebylo možné natavit výchozího avatara. Nastavení nebylo kompatibilní s verzí Serendipity 1.1.

- verze 1.27 [brockhaus]

- Pokud pisatel zadal svoji adresu jako "www.domena.cz" místo "http://www.domena.cz", Avatar nebyl načten správně.

- verze 1.26 [brockhaus]

- MyBlogLog trochu pozměnil způsob volání avatara, což mělo za následek, že ošetření chybových výstupů (fallback) pro MyBlogLog přestal fungovat.

- verze 1.25 [garvinhicking]

- Zarovnání (algin) nahraceno definicí pomocí CSS stylů, takže XHTML už neobsahuje žádné definice zarovnání.

- verze 1.24 [brockhaus]

- Kontrola odpovědi MyBlogLog, jestli obsahuje opravdu obrázek.
- Vyčištění paměti cache při nastavení hodnoty cachování na 0.
- Vypnutí ladicích výpisů.

- verze 1.23 [brockhaus]

- Při vkládání čerstvých P/favatarů, plugin přijme pouze odpovědi označené vzdáleným serverem jako obrázky. To zamezí přijetí potenciálních html stránek jako obrázku avatara.

- verze 1.22 [brockhaus]

- Vkládání i přesměrovaných P/Favatarů.

- verze 1.21 [brockhaus]

- Vkládání avatarů se rozbilo při vypnutí cache.
- Prohlížeč nebyl schopen cachovat výchozí avatary kvůli špatně nastavenému času cache.
- Kontrola, jestli cachovaný soubor vypadá jako obrázek, předtím, než je odeslán na klienta.

- verze 1.20 [brockhaus]

- Titulek obrázku avatara nyní zobrazuje jméno autora místo "Avatar" (V.)

- verze 1.19 [brockhaus]

- Využití cache prohlížeče má za následek dobré vylepšení výkonu!

- verze 1.18 [brockhaus]

- Vypnutí ladicích výpisů

- verze 1.17 [brockhaus]

- Pokud je zapnuto cachování, je nyní cachováno všechno. Známí přispěvatelé a komentátoři nyní nezpůsobí žádné volání cizích serverů, pokud už jsou jejich obrázky cachovány. Velmi pěkné posílení výkonu. Díky Garvinovi za nápad.
- Záplata proti hackování od uživatele [garvinhickins]

- verze 1.16 [garvinhicking]

- uhlazení kódu

- verze 1.14 [brockhaus]

- Implementováno zpracování chyb pro MyBlogLog! :-) Ale je pomalé, dokonce i s optimalizací pomocí cachování. MyBlogLog by neměl být první v pořadí avatarů.
- Přidána pátá kolonka pro výběr metody avatarů, protože MyBlogLog nyní také podporuje zpracování chyb (fallback).

- verze 1.13 [brockhaus]

- Doporučení změněno: Není to plugin "statistika", který znefunkční Pavatary/Favatary, ale plugin "sledování odchodů" (exit tracking plugin)

- verze 1.12 [brockhaus]

- MyBlogLog avatary jsou nyní také cachovány.
- Stránky s přesměrováním na výchozí stránku, pokud nebyla nalazena výchozí položka, jsou nyní podporovány. Dřívější plugin avatar předpokládal, že výchozí stránka ja P/Favatar.
- Výchozí nastavení pořadí avatarů je nyní: Gravatar -> Pavatar -> Favatar -> výchozí Avatar
- Přidáno doporučení, že plugin by měl být zařazen před pluginy, které mění odkazy.
- Načítání nastavené cesty pluginu. Dříve to byl vždy adresář 'plugin'.
- Vyřazeno nastavení okraje gravatara, protože už nefunguje (napořád?).

- verze 1.11 [brockhaus], testovací verze nebyla releasována do CVS/Spartacus

- Fallback (zpracování chyby) pro Gravatar funguje! Ale zobrazuje výchozího avatara nezávisle na nastavení. Takže toto nastavení bylo smazáno.

- verze 1.10 [brockhaus]

- Informace o Pavatar / Avatar nebyly nikdy načtené z cache
- ...ale po načtení z cache způsobily nekonečnou smyčku pro obrázky načtené z lokálního blogu (pokud byl povolen postranní blugin s komentáři - comment sidebar)
- Nastavení výšky obrázku bylo pojmenováno "height" ... :-/
- Cachování Gravataru nefungovalo spolehlivě, pokud byl nastaven výchozí avatar.

- verze 1.9 [brockhaus]

- Při hledání Pavatara byl natažen Favatar jako Pavatar, pokud nebyl nalezen Pavatar, ale favicon. Díky uživateli [El Burro]

- verze 1.8 [brockhaus]

- Plugin nebych schopen načíst Favatary/Pavatary, pokud bylo přesměrování nasměrováno na URL stránky nastavené jako domovská stránka komentujícího. Třeba Garvin má takový blog...

- verze 1.7 [brockhaus]

- Přidána podpora Pavatarů (www.pavatar.com)
- Přidána podpora MyBlogLog avatarů (www.mybloglog.com)
- Pořadí pro výběr avatarů a jaké typy avatarů jsou podporovány, vše je nyní nastavitelné.
- Standardní avatar může být jeden z nich (měl by být poslední).
- Volba pro nenastavení Gravatara jako výchozího avatara, i když je definovaný. (Chceme méně datových profilů...)
- Vložení výchozího avatara pomocí mediatéky v nastavení pluginu.
- Velikost obrázku je nyní zajištěna pomocí HTML kódu.
- Pod polem pro komentář jsou zobrazovány pouze aktuálně nastavené metody avatara jako podporované.

- verze 1.6 [garvinhickins]
- verze 1.5 [garvinhickins]
- verze 1.4 [garvinhickins]
- verze 1.3 [garvinhickins]

- Opraveny chyby neplatnosti domény

nahoru