WebToDate/Stránkování zpráv/Reference

Administrační rozhraní

Nabídka modulu

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

Nastavení

Globální

Stránkování kapitol

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

Nastavení

Stránkování kapitol

Ve formuláři Stránkování kapitol je definován vzhled lišty, která je používána pro stránkování seznamů kapitol.

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)--> a případně další slova vypsaná v kapitole [ Klíčová slova modulu].

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

Posledním polem formuláře je Nadpis kapitoly. Zde se definuje formátování uvozujících nadpisů kapitol, které jsou v předloze stránky reprezentovány klíčovým slovem <!--WTD_NEWSPAGING(LABEL)-->. Bez stránkovací lišty se ve stránkách zobrazujících zprávy rozdělené na kapitoly neobejdete, použití uvozujících nadpisů kapitol z principu povinné není a záleží na požadovaném designu a funkčnosti.

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 nemá žádný samostatný prezentační skript, kódy ovlivňující zobrazení jsou implementovány formou extenze, která se musí použít dle kapitoly pojednávající o instalaci.

Extenze obohacuje možnosti parametrů skriptu pro zobrazování zpráv /scripts/detail.php o následující parametry:

• chapterid – pořadové číslo kapitoly. Pokud není uvedeno nebo je z jakéhokoliv důvodu nevalidní (neexistující číslo, nejedná se o číslo), zobrazí se první kapitola.
• nopaging – pokud obsahuje jakoukoliv jinou hodnotu než prázdný řetězec (např. "yes"), celá funkce realizující stránkování se ukončí hned na začátku a zpráva se zobrazí celá jako kdyby žádné stránkování neexistovalo.

Klíčová slova modulu

Následující dvě tabulky obsahují definice klíčových slov, která lze použít v polích formuláře Nastavení – Globální – Stránkování kapitol.

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í kapitol
<!--WTD_NAVIG(NUMBER)-->	Pořadové číslo kapitoly	Klíčové slovo je nahrazováno za pořadové číslo určité stránky v rámci stránkování kapitol
<!--WTD_NAVIG(CHAPTERNAME)-->	Název kapitoly	Je použitelné v polích Číslo stránky, Aktivní stránka, Předchozí a Následující
<!--WTD_NAVIG(PAGETOTAL)-->	Celkový počet kapitol	Je použitelné v kterémkoliv poli

Klíčová slova použitelná v uvozujícím nadpisu kapitoly
Klíčové slovo	Význam	Poznámka
<!--WTD_NEWSPAGING(CHAPTERNAME)-->	Název aktuální kapitoly
<!--WTD_NEWSPAGING(PAGECURRENT)-->	Pořadové číslo stránky	Pořadové číslo stránky (kapitoly) v rámci stránkování
<!--WTD_NEWSPAGING(PAGETOTAL)-->	Počet stránek	Celkový počet kapitol v rámci stránkování

Následující tabulka obsahuje klíčová slova použitelná v předloze pro zprávy.

Klíčová slova použitelná předloze pro zprávy
Klíčové slovo	Význam	Poznámka
<!--WTD_NEWSPAGING(NAVIG)-->	Navigační lišta	Reprezentuje místo, kde se vloží navigační lišta
<!--WTD_NEWSPAGING(LABEL)-->	Výpis výsledků	Reprezentuje uvozující nadpis kapitoly (např. "Kapitola 2 z 10")
<!--WTD_NEWSPAGING(CONTENTBEGIN)-->	Začátek textu, ve kterém se hledají kapitoly
<!--WTD_NEWSPAGING(CONTENTEND)-->	Konec textu, ve kterém se hledají kapitoly

Následující dvě klíčová slova se používají v textu zpráv pro vyznačení názvů a začátků kapitol.

Klíčová slova pro vyznačení kapitol
Klíčové slovo	Význam	Poznámka
<!--WTD_NEWSPAGING(CHAPTERBEGIN)-->	Začátek názvu kapitoly
<!--WTD_NEWSPAGING(CHAPTEREND)-->	Konec názvu kapitoly

Pravidla způsobu stránkování

Při zobrazování kapitol se postupuje takto:

• Pokud není v těle nalezena ani jedna značka pro kapitoly, nahrazují se v šabloně klíčová slova pro název kapitoly i stránkovací lištu prázdným znakem, pro kratší zprávy tudíž nedochází k žádné změně oproti současnému stavu.
• Identifikace první kapitoly je taková, že buď celý text začíná značkou pro kapitolu, pak kapitola rovná se text od této značky až po následující značku nebo konec dokumentu, nebo text nezačíná značkou kapitoly a pak kapitola rovná se text od začátku po další značku pro kapitolu.
• Konec kapitoly je identifikován buď další značkou pro kapitolu nebo koncem textu.

Z toho vyplývají následující skutečnosti pro používání značek pro začátek a konec kapitoly v textu zprávy a pro jejich vztah se značkami pro začátek a konec stránkovaného textu:

• První kapitola nemusí začínat klíčovým slovem <!--WTD_NEWSPAGING(CHAPTERBEGIN)-->. Pokud je mezi <!--WTD_NEWSPAGING(CONTENTBEGIN)--> a <!--WTD_NEWSPAGING(CHAPTERBEGIN)--> text (mezery se ignorují), je tento text chápán jako kapitola bez názvu
• Sekvence <!--WTD_NEWSPAGING(CHAPTERBEGIN)--><!--WTD_NEWSPAGING(CHAPTEREND)--> je přípustná, jedná se opět o kapitolu bez názvu
• Poslední kapitola končí klíčovým slovem <!--WTD_NEWSPAGING(CONTENTEND)-->
• Názvy kapitol uvnitř klíčových slov CHAPTERBEGIN - CHAPTEREND se nezobrazují. Využívají se pro naplnění obsahu klíčových slov jako <!--WTD_NAVIG(CHAPTERNAME)--> apod.

Integrace s WYSIWYG editorem

Od verze WebToDate 4.1 používá systém WebToDate pro úpravy HTML kódů (textů zpráv apod.) WYSIWYG editor FCKeditor. Pro nasazení ve WebToDate je tento editor vybaven několika moduly, jedním z nich je modul podporující vkládání značek pro kapitoly do textu zprávy. Tuto funkci můžete tedy jednoduše použít na definování stránkování zpráv v režimu vytváření zprávy.

Dialog pro vložení značky po začátek nebo konec názvu kapitoly se otevírá ikonou (s malou číslicí dvě) z tlačítkové lišty editoru.

Zobrazí se následující dialog.

Po potvrzení tlačítkem OK se na pozici kurzoru vloží vybraná značka.

Zobrazení těla zprávy z příkladu v kapitole [ První zobrazení stránkované zprávy ]vypadá následovně:

Značky jsou odlišeny barevně a nelze je přímo editovat. V textu máte následující možnosti:

• Odstranění značky – klepněte na značku a použijte klávesu Delete na klávesnici
• Posun značky na jiné místo v textu – klepněte na značku a myší ji přetáhněte na odpovídající místo
• Změna značky – poklepejte na značku; zobrazí se dialog, který je stejný jako pro vložení značky, zde můžete změnit značku pro začátek názvu kapitoly na značku pro konec názvu kapitoly a naopak.