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)

nahoru