Dokumentaci k tomuto pluginu přeložil do češtiny Vladimír Ajgl (vlada [zavinac] ajgl [tecka] cz) dne 19.6.2010. Od té doby mohl být plugin pozměněn nebo mohly být rozšířené jeho funkce. Zkontrolujte pro jistotu i aktuální anglické "readme" a ChangeLog.
Tento plugin ve své podstatě pouze poskytuje API - programátorské rozhraní, neboli soubor funkcí, které můžete používat v šablonách Smarty.
Budete potřebovat obrázky se symboly hodnocení (hvězdičky, medaile, ...). Ty jsou součástí pluginu, nacházejí se v podadresáři "img/".
Zkopírujte tyto soubory do podadresáře "img" ve vaší aktuální šabloně/stylu vzhledu!
Tento plugin umožňuje vytvořit hodnotící stupnici pro jakoukoliv položku si usmyslíte. V následujícím příkladu budeme hodnotit filmy na základě IMDB odkazů a ID čísla pro každý hodnocený film.
Poté co nainstalujete plugin, jděte do Administrační sekce a vytvořte nový příspěvek. Podívejte se na konec stránky, tam najdete odstavec "Hodnocení" (Community Rating).
Tady naleznete rozbalovací panel, kam můžete přidávat hodnocené věci ("IMDB", "Výrobek", ...) a zadat hodnocení. Pro jeden příspěvek můžete zadat více typů a hodnocení.
Hodnocení, která jste takto zadali, jsou Vaše osobní hodnocení a jsou uložena databázové tabulce serendipity_entryproperties.
Teď když jsme zadali hodnocení, určitě ho potřebujeme zobrazit a ukázat návštěvníkům stránek. K tomu musíme změnit šablony.
Používání funkcí API rozhraní má smysl pouze v šabloně entries.tpl.
Odrolujte nakonec a prohlédněte si HTML kód. Nejdříve si musíte rozmyslet, kde se má hodnocení zobrazovat.
Dobré místo je třeba následující úsek kódu:
<div class="serendipity_entry_extended"><a id="extended"></a>{$entry.extended}
Tento řádek je zodpovědný za zobrazení rozšířené textové části příspěvku. Zobrazovat hodnocení hned pod ním zní jako dobrý nápad.
Aby se zobrazovalo hodnocení filmu, vložte do kódu následující tag:
{communityrating_show data=$entry.properties type="IMDB"}
Tato funkce vloží požadovaná data o hlasování ("data") do šablony ("IMDB") a zobrazí na stránce Vaše hodnocení.
Také můžete zobrazovat hodnocení jiných lidí, kteří používají tento plugin. Uděláte to následovně:
{communityrating_show data=$entry.properties type="IMDB" who="garvin" url="http://www.blog_kamarada.cz/index.php?/plugin/communityrating"}
Pomocí parametrů "who" a "url" můžete zadat adresu blogu kamaráda. Můžete přirozeněě přidat libovolný počet volání funkce {communityrating_show}.
Pro zobrazení hodnocení můžete použít pro každý typ hodnocené věci (IMDB, Výrobek, ...) a pro každého kamaráda jinou šablonu. Tedy že každá kombinace může vypadat jinak.
Jako výchozí je použita šablona, která zobrazuje hvězdičky jako indikátor hodnocení.
Šablony jsou pojmenovaní jako "communityrating_IMDB.tpl" nebo "communityrating_IMDB_garvin.tpl". První část označuje typ věci ("_IMDB"). Druhá část názvu ("", "_garvin") je jméno kamaráda, od kterého zobrazujeme hodnocení. Takže si můžete hodnocení tak, že se pro každého cizího hodnotitele bude zobrazovat odlišně!
Informaci o hodnocení můžete také přidat do RSS kanálu. Použijte stejnou funkci API rozhraní v šabloně RSS kanálu, jmenuje se feed_*.tpl. A nezapomeňte připojit parametr "escaped='true'" podle následujícího příkladu:
{communityrating_show data=$entry.properties type="IMDB" escaped="true"}
{communityrating_show data=$entry.properties type="auta"}
{communityrating_show who="garvin" url="http://garvin/index.php?/plugin/communityrating" data=$entry.properties type="auta"}