Dokumentace k pluginu 'Hodnocení'

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.

Příprava souborů

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!

Backend

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.

entries.tpl

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}.

Šablony pro hodnocení

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ě!

RSS Kanály

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"}

Postup přidání nového typu věci

  1. Nastavte plugin "Hlasování". Upravte políčko, které obsahuje seznam aktuálně použitých typů. Přidejte svůj vlastní typ na konec. Oddělovačem je čárka ",". Zadávejte názvy bez diakritiky a speciálních znaků.
  2. Zkopírujte obrázky img/stars_XXX_(full|half|zero).png tak, abyste mohli vytvořit obrázky pro Váš nový typ. Pokud přidáte nový typ "auta", musí se obrázky jmenovat "stars_auta_full.png", "stars_auta_half.png", "stars_auta_zero.png".
  3. Vytvořte nový soubor šablony "communityrating_auta.tpl"
    4. buď v adresáři pluginu, nebo v adresáři Vaší aktuální šablony/stylu vzhledu. Upravte šablonu podle potřeby.
  4. Upravte šablonu "entries.tpl". Vložte do ní následující řádek: {communityrating_show data=$entry.properties type="auta"}

Postup přidání nového kamaráda

  1. Nejprve se přesvědčte, že kamarád nainstaloval plugin do svého blogu serendipity. Také se předpokládá, že znáte URL adreu kamarádova blogu.
  2. Přidejte nové soubory šablon. Řekněme, že chcete zobrazovat, jak kamarád "garvin" hodnotil filmy podle IMDB. Pak budete potřebovat vytvořit soubor "communityrating_IMDB_garvin.tpl".
  3. Upravte šablonu "entries.tpl". Vložte do ní následující řádek: {communityrating_show who="garvin" url="http://garvin/index.php?/plugin/communityrating" data=$entry.properties type="auta"}

CHANGE_LOG (HISTORIE VERZÍ)