WebToDate/Výpisy zpráv/Reference

Administrační rozhraní

Nabídka modulu

Nabídka modulu je jednoduchá, vypadá následovně:

Nastavení

Globální

Výpis

Navigační lišta

K administrační části modulu mají přístup pouze administrátoři WebToDate.

Nastavení

Výpis

Formulář Výpis definuje základní grafickou podobu zobrazování stránky s výpisy zpráv. Definují se zde následující položky:

• Předloha – vyberte výchozí předlohu pro stránku s výpisy
• Styl seznamu pro zobrazování výsledků – vyberte výchozí styl pro seznam zpráv ve výpisech včetně počtu záznamů na stránku
• Uvozující nadpis výpisu – obsahuje dvě pole, obsah prvního pole se použije, pokud zadaná kritéria při zobrazení výpisu znamenají výběr alespoň jedné zprávy, obsah druhého pole se použije v případě, že kritériu neodpovídá žádná publikovaná zpráva.

Všechny položky formuláře je třeba vyplnit a formulář uložit, jinak nebude skript pro zobrazování výpisů funkční.

Navigační lišta

Ve formuláři Navigační lišta je definován vzhled lišty, která je používána pro stránkování seznamů položek.

Grafický vzhled jednotlivých prvků navigační lišty se definuje pomocí následujících polí:

1. Předchozí – HTML kód určující formátování odkazu pro přechod na předcházející stránku
2. Následující – HTML kód určující formátování odkazu pro přechod na další stránku
3. Hlavička – HTML kód, který je umístěn na počátku výsledného kódu navigační lišty
4. Patička – HTML kód, který je umístěn na konci výsledného kódu navigační lišty
5. Číslo stránky – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
6. Aktivní stránka – formátování údaje o čísle aktuální stránky
7. Separátor – oddělovač mezi jednotlivými čísly stránek.
8. Počet stránek určuje maximální počet čísel stránek v navigační liště a tím nepřímo ovlivňuje i její šířku.

Pro správnou funkci navigační lišty je nutné do výše popsaných polí zadávat i klíčová slova <!--WTD_NAVIG(URL)--> a <!--WTD_NAVIG(NUMBER)-->.

Jejich použití je zřejmé z následujícího jednoduchého příkladu:

Definici navigační lišty je třeba po instalaci každého modulu v instalovaném modulu uložit – výchozí hodnoty se po instalaci v databázi nenacházejí a bez uložení se pak navigační lišta na žádné stránce nezobrazí.

Veřejné skripty

Prezentační skript a jeho možné parametry

Modul má jediný prezentační skript na adrese /scripts/modules/column/default.php. Z URL tohoto skriptu se zadávají podmínky pro zobrazení zpráv. Pokud je skript volán bez dalších parametrů, zobrazuje všechny publikované zprávy setříděné od nejnovějších k nejstarším. Přehled možných parametrů je v následující tabulce.

Parametr	Význam
publid	ID publikace
categid	ID kategorie
groupid	ID tématu
keyword	Klíčové slovo (textový řetězec)
tmplid	ID předlohy
lid, locale, dlid, dlocale	Jazykové parametry (lid = ID jazyka, locale = zkratka jazyka apod.)
section	Název rubriky (jako textový řetězec)
order	Způsob třídění, možné hodnoty jsou date (podle datumu a času sestupně) a impress (podle počtu shlédnutí sestupně); pokud není parametr uveden nebo neodpovídá žádné z hodnot, použije se výchozí třídění podle datumu a času sestupně
dayfrom, monthfrom, yearfrom	Zadání počátku omezujícího časového intervalu (vždy celé číslo)
dayto, monthto,yearto	Zadání konce omezujícího časového intervalu (vždy celé číslo)
from, to	Omezení zadaná datumem, datum se zadává v českém formátu, tedy např. 15.12.2004.
styleid	ID WebToDate stylu formátujícího seznam

Zadané podmínky se spojují logickou spojkou "a zároveň". Pokud tedy např. sestavíme URL

/scripts/modules/column/default.php?categid=34&keyword=internet

vypíší se zprávy z kategorie s ID=34 obsahující zároveň klíčové slovo "internet".

Pro časová kritéria platí následující:

• Hodnota nula vyjadřuje dnešní den, dále mají smysl záporná čísla udávající kolik dnů (měsíců, roků) nazpět zprávy hledat
• Hodnoty "from" a "to" se mohou vzájemně logicky vylučovat, proto v případě, že se v URL vyskytuje víc parametrů stejného typu, přednost má jemnější kritérium, tedy měsíc před rokem, den před měsícem apod.
• Pokud je uveden parametr from nebo to a zadaný formát data v tomto parametru je validní, má přednost před všemi ostatními parametry daného typu omezení; tedy from má přednost před dayfrom a dayfrom se ignoruje.
• Pokud hodnota některého z těchto parametrů není celé nekladné číslo, parametr se ignoruje.
• Lze uvést jednu nebo dvě omezující podmínky, např. jen spodní hranici, druhé omezení intervalu se automaticky chápe jako bez omezení.

Příklady použití časových omezujících kritérií jsou uvedeny v následující tabulce.

Podmínka	Omezení zespoda	Omezení seshora
Poslední rok	dayfrom=-365
Poslední tři dny (= předvčerejšek, včerejšek a dnešek)	dayfrom=-2
Poslední týden	dayfrom=-6
Poslední měsíc	monthfrom=-1
Dnešní	dayfrom=0
Včerejší	dayfrom=-1	dayto=-1
Předvčerejší	dayfrom=-2	dayto=-2
Před týdnem	dayfrom=-7	dayto=-7
Před měsícem	monthfrom=-1	monthto=-1
Před rokem	yearfrom=-1	yearto=-1

I když krabicové moduly WebToDate podobného charakteru zpravidla nepodporují možnost vynutit z URL styl, je to v tomto případě potřebné, protože jeden skript je možné použít jak na výpisy zpráv určité charakteristiky podle času, tak na výpisy čtenosti, což jsou poměrně rozdílné věci – v prvním případě se čtenost nezahrnuje do interně vytvářených SQL dotazů ani nezobrazuje, v druhém případě se zahrnuje a zobrazuje. Proto je v URL podporován parametr styleid, kterým lze vynutit vybraný styl seznamu zpráv. Pokud styl se zadaným ID není nalezen, není to považováno za chybu a použije se výchozí styl zvolený v nastaveních modulu.

Klíčová slova modulu

Následující klíčová slova se používají v předloze pro umístění objektů vkládaných do stránky modulem.

Klíčová slova použitelná v předloze – dynamické objekty ve stránce
Klíčové slovo	Význam	Poznámka
<!--WTD_COLUMN(LIST)-->	Seznam zpráv	Reprezentuje seznam nalezených zpráv
<!--WTD_COLUMN(NAVIG)-->	Navigační lišta	Reprezentuje místo, kam se vloží navigační lišta
<!--WTD_COLUMN(LABEL)-->	Výpis výsledků	Reprezentuje uvozující nadpis výpisu výsledků (např. "Dokument 1 až 10 z 50")

Následující klíčová slova použijte ve formuláři Nastavení – Globální – Výpis v poli Úspěšné hledání.

Klíčová slova použitelná v uvozujícím nadpisu výpisu výsledků při úspěšném hledání
Klíčové slovo	Význam	Poznámka
<!--WTD_COLUMN(FROM)-->	Počet od	Počáteční pořadové číslo záznamu na stránce v seznamu nalezených
<!--WTD_COLUMN(TO)-->	Počet do	Koncové pořadové číslo záznamu na stránce v seznamu nalezených
<!--WTD_COLUMN(TOTAL)-->	Počet celkem	Počet nalezených záznamů celkem

Následující klíčová slova použijte ve formuláři Nastavení – Globální – Navigační lišta.

Klíčová slova použitelná v definici navigační lišty
Klíčové slovo	Význam	Poznámka
<!--WTD_NAVIG(URL)-->	Odkaz	Klíčové slovo je nahrazováno za odkaz na určitou stránku v rámci stránkování seznamu
<!--WTD_NAVIG(NUMBER)-->	Číslo stránky	Klíčové slovo je nahrazováno za pořadové číslo určité stránky v rámci stránkování seznamu

Následující klíčová slova můžete použít v těle stylu pro seznam zpráv. Kromě klíčových slov <!--WTD_F(NUMBER)--> a <!--WTD_F(IMPRESSIONS)--> se tato klíčová slova shodují s klíčovými slovy použitelnými ve WebToDate pro zprávy či seznamy zpráv.

Klíčová slova použitelná v těle stylu nalezených výsledků
Klíčové slovo	Význam	Poznámka
<!--WTD_F(NUMBER)-->	Číslování řádků
<!--WTD_F(IMPRESSIONS)-->	Počet shlédnutí
<!--WTD_F(ID)-->	ID zprávy
<!--WTD_F(TITLE)-->	Nadpis
<!--WTD_F(TITLELINK)-->	Odkaz nadpisu
<!--WTD_F(DESCRIPTION)-->	Popis
<!--WTD_F(DATE)-->	Datum zprávy
<!--WTD_F(CATEGORYID)-->	Číslo kategorie
<!--WTD_F(CATEGORY)-->	Název kategorie
<!--WTD_F(PIC)-->	Obrázek
<!--WTD_F(ALTPIC)-->	Alt. obrázek
<!--WTD_F(LANGUAGEID)-->	ID jazyka
<!--WTD_F(LANGUAGE)-->	Název jazyka
<!--WTD_F(SOURCE)-->	Autor

K výše uvedeným klíčovým slovům existuje alternativa typu WTD_IF(…NULL) a WTD_IF(…NOTNULL) stejně jako u stylů pro zprávy.

V seznamu zpráv se nahrazují obsahem i klíčová slova instancí položek z databáze zdrojů ve zprávách. Pokud se např. ve zprávách používají ilustrační obrázky uložené jako instance zdrojů do pole Obrázek databáze zpráv, lze ve stylu pro seznam zpráv ve výpisu použít klíčové slovo <!--WTD_F(PIC)--> a obrázek se zobrazí stejně jako v seznamech zpráv WebToDate.

V hlavičce a patičce stylu a předloze lze použít následující klíčová slova.

Klíčová slova použitelná v hlavičce či patičce stylu nalezených výsledků
Klíčové slovo	Význam	Poznámka
<!--WTD_F(CATEGORY)-->	Lokalizovaný název kategorie
<!--WTD_F(CATEGORYID)-->	ID kategorie
<!--WTD_F(PUBLICATION)-->	Název publikace
<!--WTD_F(GROUPNAME)-->	Název tématu
<!--WTD_F(KEYWORD)-->	Klíčové slovo
<!--WTD_F(SECTION)-->	Název rubriky

Dané klíčové slovo se nahrazuje obsahem pouze v případě, že je daná položka součástí kritéria zadaného z URL. Podporováno je i zde podmíněné vkládání ve všech těchto případech pomocí syntaxe NULL a NOTNULL, např.:

<!--WTD_IF(CATEGORYNOTNULL,"Články z kategorie <!--WTD_F(CATEGORY)-->")-->
<!--WTD_IF(CATEGORYNULL,"Články ze všech kategorií")-->

Modul dále podporuje Klíčová slova pro formátování typu WTD_FORMAT, tedy např.

<!--WTD_FORMAT(SMAXLEN,"formátovací předpis","ořezávaný text")-->

apod.