WebToDate - Příspěvky [cs]

WebToDate/Redaktorská/Zdroje

2019-08-30T07:42:01Z

Jardac: /* Vložení nového souboru do zdroje - multiupload */

[[Category:WebToDate Redaktorská]]
[[Category:Redaktorská]]
== Co jsou zdroje ==
Zdroje využijete v případě, že chcete ve zprávě použít jakýkoliv soubor – obrázek uvnitř textu, přílohu ke stažení, obrázek do fotogalerie apod. Databáze zdrojů je jakýsi sklad souborů k dalšímu použití na webové prezentaci, přičemž tyto soubory jsou opatřeny doprovodnými informacemi (metadaty) podobně jako zprávy tak, aby bylo možné zdroje prohledávat a efektivně spravovat.

Redaktor vytvářející zprávu, ke které patří i nějakou soubory, postupuje následovně:

# vybere potřebné soubory z databáze zdrojů, případně je do této databáze vloží, pokud se tam ještě nenacházejí.
# Vytvoří zprávu
# Připojí vybrané soubory ze ke zprávě, v rámci tohoto připojování musí označit, zda se jedná o obrázek v textu, obrázek do fotogalerie, soubor ke stažení apod.
# Pokud je nějaký připojený soubor potřeba umístit na nějaké konkrétní místo v textu, provede to.
== Procházení databáze zdrojů ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). V pravé horní části okna se zobrazí seznam podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img053.png|center]]

V prvním řádku seznamu jsou k dispozici odkazy pro přidání nového zdroje, stránkování seznamu a zobrazení uživatelského výběru a uživatelské schránky.

V prvním sloupci se zobrazují ikony pro náhled, uzamčení / odemčení zdroje a vyznačení stavu zdroje. V druhém sloupci se zobrazují textové informace o zdroji – název, popis, výchozí kategorie, datum a údaje o souboru (formát, velikost, případně rozměry).

Třetí sloupec zobrazuje počet souborů ve zdroji. Kliknutím na ikonu se navíc přidává soubor do výběru. Pokud je soubor ve zdroji jen jeden, provede se akce okamžitě, pokud je zde souborů víc, zobrazí se dialog, ve kterém se vybírá, které soubory do výběru vložit. Více o uživatelském výběru se dozvíte v kapitole '''Uživatelský výběr'''.

Poslední sloupec zobrazuje náhled (v případě, že se jedná o obrázek) nebo ikonu (v případě že se jedná o soubor). Klepnutím na náhled či ikonu se zobrazí v novém okně prohlížeče náhled ''master'' varianty, čili fotografie v původní velikosti apod.

Vyhledávání zdrojů funguje analogicky jako vyhledávání zpráv.

[[Image:redaktorska-zdroje-img038.png|center]]

Vyhledávání zde opět nefunguje jednorázově, ale jako filtr nastavený v rámci daného připojení. Pokud se tedy nezobrazují v seznamu všechny očekávané položky, použijte odkaz '''Vyhledat''' a ujistěte se, že není aplikován nějaký filtr, který zobrazuje pouze část obsahu databáze zdrojů.

== Vytvoření nového zdroje ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). Použijte odkaz '''Přidat''' v pravém horním rohu obrazovky.

Formulář pro vkládání zdrojů se skládá ze tří záložek – '''Základní''' – '''Zařazení''' – '''Položky'''. Záložka '''Položky''' je pro nový zdroj nepřístupná a zobrazí se až po prvním uložení, to znamená, že soubory lze do zdrojů vkládat, až když je zdroj vytvořen.

[[Image:redaktorska-zdroje-img039.png|center]]

Vytvoření zdroje je velmi podobné vytvoření zprávy, v první záložce se vyplní především Nadpis, v druhé záložce se zvolí vhodná metadata.

[[Image:redaktorska-zdroje-img040.png|center]]

<div class="note">Věnujte pozornost stavu zdroje – soubory ze zdrojů jsou prezentovány na veřejné části pouze, pokud je stav zdroje '''Publikováno'''.</div>

== Vložení nového souboru do zdroje ==
Soubor se do zdroje vkládá tlačítkem '''Přidat položku''' v záložce '''Položky''' vstupního formuláře.

[[Image:Referencniprirucka-zdroje-img050.png|center]]

Zobrazí se dialogové okno podle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img051.png|center]]

Soubory lze do zdroje vložit buď z lokálního disku, nebo z uživatelské schránky. Pokud máte soubor na svém lokálním disku, vyberte jej pomocí volby '''Vložit soubor z lokálního počítače''', přetáhněte soubor nebo soubory myší do oblasti pro nahrávání souborů a použijte tlačítko '''Spustit nahrávání'''. Funkce schránky jsou popsány v následující kapitole.

== Uživatelská schránka ==
Uživatelská schránka je místo, kam může uživatel vkládat soubory, které ještě nejsou zařazeny do databáze a nejsou zařazeny do žádného zdroje. Pokud si chcete nejprve na serveru připravit více souborů a ty potom do zdrojů zařadit (tj. zadat popisky apod.), použijte nejprve schránku.

[[Image:referencniprirucka-zdroje-img055.png|center]]

Obsah schránky vyvolejte odkazem '''Schránka''' v seznamu zdrojů. Otevře se dialogové okno, ve kterém lze buď přidat soubory z lokálního disku do schránky, nebo naopak odstranit vybraný soubor či všechny soubory ze schránky. Pro odstranění jednoho souboru klepněte na radiopřepínač pod náhledem či ikonou souboru a použijte tlačítko '''OK'''. Pro odstranění všech souborů ze schránky použijte tlačítko '''Smazat vše'''.

V dialogu pro vložení souboru do zdroje se obsah schránky zobrazuje rovněž. V tomto dialogu lze vybrat buď soubor z lokálního disku, nebo ze schránky. Pokud je vybrán soubor ze schránky, soubor se ze schránky nekopíruje, ale přesouvá, což znamená, že po vložení souboru ze schránky do zdroje tento soubor ze schránky mizí.

== Rychlé vytvoření více zdrojů z obsahu schránky ==
Z okna pro zobrazení schránky lze vyvolat funkci pro hromadné vložení souborů ve schránce do databáze zdrojů. Tato funkce je určena především k vytvoření více zdrojů najednou s obrázky, které pak tvoří např. fotogalerii k dané zprávě, lze ji ale s výhodou použít i na vkládání jednotlivých obrázků, protože umožňuje automaticky v jednom kroku vytvořit i druhou variantu obrázku – náhled vhodný pro další použití ve webové prezentaci.

Funkce se spouští tlačítkem '''Vytvořit zdroje''' ve okně zobrazujícím obsah schránky. Zobrazí se formulář dle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img056.png|center]]

Funkce zařadí do databáze zdrojů všechny obrázky aktuálně umístěné do schránky, každý obrázek jako samostatný zdroj. Pro funkci platí následující:

* Všechny takto vytvořené zdroje mají stejná metadata, výjimkou je pouze možnost zvolit jako název zdroje název souboru (první radiopřepínač ve formuláři)
* Všechny soubory budou umístěny na serveru v jednom adresáři, který je ve formuláři uveden
* Hromadně je nastavitelná pro jednoduchost pouze vybraná množina metadat, ve formuláři tedy chybí např. datum ''Publikovat dne'', ''Témata'' apod.
* Vytvořené zdroje mají stav zvolený ve formuláři a vždy jsou odemčené.

Volby dále zrychlující celou práci jsou ve formuláři dole:

* '''Vytvořit pro obrázky další variantu''' – funkce vytvoří automaticky pro všechny obrázky druhou variantu uloženou vždy ve stejném zdroji jako původní obrázek, rozměry této varianty se vybírají v příslušné rozevírací nabídce. Nová varianta se nezakládá, pokud jsou rozměry obrázku ve schránce menší než nastavený požadovaný rozměr.
* '''Přidat soubory do uživatelského výběru''' – naplní uživatelský výběr právě vloženými soubory. Pokud je zvoleno vytváření nové varianty, do výběru se vloží vždy tato druhá varianta, v opačném případě původní (''master'') soubor.

Když úloha skončí, okno se schránkou se uzavírá a obnovuje se seznam zdrojů, typický výsledek je na následujícím otisku obrazovky:

[[Image:redaktorska-zdroje-img045.png|center]]

Zdroje jsou vytvořené a obrázky v nich požadovaným způsobem uložené, stačí vybrat nějakou konkrétní zprávu a připojit k ní výběr souborů, obsah fotogalerie (či příloh ke zprávě apod.) je takto rychle sestaven.

== Úpravy obrázků ==
WebToDate obsahuje zabudovaný editor, kterým lze měnit vložené obrázky nebo vytvářet nové varianty (zmenšeniny, ořezy apod.). Použití zabudovaného editoru pro obrázky je v zásadě možné ve dvou případech:

# Chceme editovat obrázek, který je již vložen do zdroje. Použijeme funkci '''Upravit obrázek''' u souboru ve zdroji. Tato funkce je dostupná pouze pro soubory, které nejsou nebyly vloženy do zdroje jako první (interně jsou označeny jako ''master'').
# Chceme vytvořit novou variantu obrázku – zmenšeninu, ořez apod. Použijeme tlačítko '''Vytvořit novou variantu obrázku'''.

V obou případech se zobrazí editor obrázků podle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img065.png|center]]

V horní části okna je informační lišta (velikosti souborů apod.). Je zde rovněž funkce '''Zoom''' – ta umožňuje pouze zvětšit či zmenšit opticky obrázek. Funkce toto provádí pouze na straně klienta a s obrázkem fyzicky nijak nemanipuluje. Je vhodná v případě, že chcete pomocí myši přesněji vytvořit rámeček pro oříznutí.

Dále je k dispozici nabídka '''Akce''', která specifikuje, co se má provést. Jedná se o následující volby:

# '''Zmenšit na předdefinovanou velikost''' – v nabídce vpravo je seznam možných předdefinovaných velikostí, obsah této nabídky se definuje v globálních předvolbách WebToDate.
# '''Zmenšit na zadanou velikost''' – vpravo jsou políčka '''šířka''' a '''výška''', které je třeba vyplnit. Pokud jsou zadány oba rozměry, obrázek se zmenší tak, aby oba zadané rozměry nebyly překročeny a aby byl zachován poměr stran. Lze zadat pouze jeden z rozměrů, pak se druhý automaticky dopočítá opět tak, aby byl zachován poměr stran.
# '''Doostřit''' - provádí doostření obrázku podle zadaných parametrů (poloměr, míra, sigma, práh). Výchozí hodnoty všech těchto parametrů lze nastavit v globálních předvolbách WebToDate.
# '''Vodoznak''' - vkládá do obrázku soubor s vodoznakem, lze zvolit umístění a jas vodoznaku. Seznam souborů, které lze vložit jako vodoznak, se definuje v globálních předvolbách WebToDate, stejně tak v těchto předvolbách lze nastavit výchozí hodnoty pro umístění a jas.
# '''Oříznout podle výběru''' – pomocí myši vytvořte v náhledu rámeček pro oříznutí a použijte tlačítko '''Provést akci'''.
# '''Oříznout podle výběru se zadáním rozměrů''' – zadejte oba rozměry požadovaného výřezu a klepněte myší na místo v obrázku, kde má být levý horní roh výběru, pak použijte tlačítko '''Provést akci'''.
# '''Otočit o 90 stupňů''' – vpravo se vybírá otočení doleva nebo doprava
# '''Nahradit kopií souboru master''' – jedná se o jakýsi návrat zpět, použijte v případě, že jste vytvořili obrázek v nevyhovující podobě.
# '''Návrat k uložené variantě''' - je k dispozici pouze v případě, že se jedná o editaci existující varianty, nikoliv o vytváření nové varianty. Funkce vrací editovaný obrázek zpět k souboru, který je aktuálně uložen jako daná upravovaná varianta, je to tedy jakýsi návrat zpět pro případ, že provedené operace při úpravách obrázku neodpovídají žádoucímu výsledku.

<div class="note">Všechny tyto volby je vždy třeba potvrdit tlačítkem '''Provést akci'''. Je možné provést i několik akcí za sebou – např. nejprve obrázek oříznout a pak zmenšit. V takovém případě použijte několikrát funkci '''Provést akci''' a nakonec tlačítko '''Uložit'''.</div>

Možnosti pro změnu velikosti mají následující vlastnosti:

* Je podporováno pouze zmenšování, nikoliv zvětšování. Pokud zadáte větší rozměry, než má obrázek, žádná akce se neprovede.
* Zmenšování se vždy provádí se zachováním poměrů stran obrázku. Provede se tak, že ani jeden rozměr nesmí ve výsledku přesáhnout požadované rozměry.

Význam parametrů pro funkci '''Doostřit''' je zhruba tento:

* ''Poloměr'' - udává se v obrazových bodech a říká, jak široká oblast kolem hrany bude doostřením zasažena. Jinými slovy v jak široké oblasti kolem hrany se kontrast plynule zvýší podle hodnoty ''Míra''. Musí jít o nezáporné číslo (může být i desetinné).
* ''Míra'' - určuje, jak moc bude hrana zvýrazněna. 100% znamená, že původní kontrast hrany bude zvýšen o 100% (tj. na dvojnásobek). Jedná se o celé nezáporné číslo v procentech (může být i více než 100%).
* ''Sigma'' - směrodatná odchylka Gaussova rozložení, udává se v obrazových bodech. Musí jít o nezáporné číslo (může být i desetinné), musí být menší než ''Poloměr''.
* ''Práh'' - říká, jak velký musí být absolutní rozdíl jasů mezi sousedními body obrazu, aby se považovaly za hranu, a tudíž se zostřily filtrem. Jedná se o celé nezáporné číslo v procentech.

Ve funkci '''Vodoznak''' se v prvé řadě vybírá obrázek ze seznamu definovaného v globálních předvolbách, který se má vložit jako vodoznak. Dále se vybírá umístění, které je popsáno jako výběr světových stran, tj. má následující možnosti:

* severozápad
* sever
* severovýchod
* západ
* střed
* východ
* jihozápad
* jih
* jihovýchod

Volba ''jihovýchod'' tedy např. znamená pravý spodní okraj obrázku apod.

Poslední volbou je jas vodoznaku - zadává se jako údaj v procentech v rozsahu 0 až 100%.

== Konverze souborů ==
=== Konverzní pravidla ===

Administrátor může pro obrázky, audia a videa nadefinovat konverzní pravidla. To znamená, že při vložení souboru do zdroje se může spustit nějaká konverzní funkce, která změní formát souboru či jej jinak upraví.

Při vložení souboru do zdroje se vyhodnocuje, zda pro vkládaný formát souboru existuje nějaké konverzní pravidlo a pokud ano, zda jsou splněny podmínky pro konverzi definované v pravidle (např. rozměry obrázku přesahují definovanou velikost apod.). Pokud je zjištěno, že existuje alespoň jedno relevantní pravidlo, zobrazí se dialog pro potvrzení konverze.

[[Image:redaktorska-zdroje-img047.png|center]]

V dialogu se vypíše seznam relevantních pravidel. Pravidla, která jsou volitelná, mají vedle názvu zaškrtávací okénko, kterým lze zvolit, zda se konverzní pravidlo aplikuje. Automaticky spouštěná pravidla tuto volbu nemají. Tlačítko '''OK''' spouští postupně všechna pravidla. Tlačítko '''Storno''' stornuje proces konverze. Platí zde následující:

* Pokud jsou všechna nabízená pravidla pouze volitelná a použije se '''Storno''', vloží se do zdroje původní nekonvertovaný soubor.
* Pokud je alespoň jedno nabízené pravidlo automatické a použije se '''Storno''', žádné konverze se neprovádějí, ale zároveň se do zdroje žádný soubor nevkládá - původní soubor se ze serveru smaže a zdroj zůstává beze změny.

=== Konverzní funkce ===

Ikona '''Úprava vlastností souboru''' ve formuláři pro úpravy zdroje vyvolává následující dialog. Pokud existuje alespoň jedna konverzní funkce pro daný formát souboru, zobrazí se v dialogu tlačítko '''Konvertovat'''.

[[Image:redaktorska-zdroje-img048.png|center]]

Tlačítko '''Konvertovat''' zobrazí dialog pro výběr a spuštění konverzní funkce. Na rozdíl od pravidel konverze se takto spouští vždy právě jedna konverzní funkce, která se vybírá radiopřepínačem.

[[Image:redaktorska-zdroje-img049.png|center]]

Tlačítko '''OK''' spouští zvolenou konverzní funkci, tlačítko '''Storno''' ruší volbu a soubor ve zdroji zůstává beze změny.

== Uživatelský výběr ==
Pro to, aby byl soubor připojen a nějak použit ve zprávě, se postupuje ve dvou až třech krocích.

V prvním kroku se vybere soubor z databáze zdrojů, který chceme ke zprávě připojit. To se prování klepnutím na ikonu '''Soubory''' v seznamu zdrojů nebo ikonou '''Přidat do výběru''' ve formuláři pro úpravu zdroje (záložka '''Soubory''', sloupec ''Úpravy'' v seznam souborů ve zdroji). Je-li ve zdroji uložen více než jeden soubor, zobrazí se v případě potřeby dialog, ve kterém je třeba vybrat, který soubor ze zdroje se do výběru přidává (lze vybrat i více než jeden soubor). Tento dialog je na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img050.png|center]]

<div class="note">Doporučujeme nejprve postupně vybrat všechny soubory, které mají být ke zprávě použity, zamezí se tím nutnosti opakovaně přecházet na jiné obrazovky mezí databází zpráv a zdrojů.</div>

V dalších formulářích je možné zpracovávaný soubor rovnou přidat (kromě jiné akce realizované daným dialogem) do výběru. Jedná se o:

* Vložení prvního či dalšího souboru do zdroje
* Obrazovku pro úpravy obrázků

Co je aktuálně v uživatelském výběru lze kdykoliv zobrazit. To je možné buď odkazem '''Výběr''' v seznamu zdrojů, nebo tlačítkem '''Zobrazit výběr souborů''' ve formuláři pro editaci zpráv (v záložce '''Soubory'''). Tento dialog je zobrazen na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img051.png|center]]

V tomto okně lze případně nějaké soubory z výběru odstranit, buď pouze vybrané, nebo případně všechny (tlačítko '''Smazat z výběru všechny'''). Soubory se tím samozřejmě nemažou z databáze zdrojů, ale pouze z výběru.

<div class="note">Do výběru si můžete vložit i soubory, které chcete připojit k více zprávám. Ve chvíli připojování ke zprávě lze specifikovat, které soubory z výběru se připojují a které ne.</div>

== Připojení souborů ke zprávě ==
Druhým krokem je připojení souborů, které jsou ve výběru, ke zprávě. Když máte všechny potřebné soubory umístěny do uživatelského výběru, přejděte do formuláře pro úpravu rozpracované zprávy a použijte tlačítko '''Připojit výběr souborů'''. Zobrazí se následující dialog.

[[Image:redaktorska-zdroje-img052.png|center]]

V tomto dialogu jsou vypsány všechny soubory, které se aktuálně nacházejí v uživatelském výběru. Pro každý soubor jsou tři možnosti:

* '''Připojit pod vybraným stylem''' – tato volba se použije v případě, že chceme soubor použít samostatně (typicky v těle zprávy nebo např. v poli obrázek). Je třeba zde vybrat vhodný styl, kterým se data ze zdroje formátují – styl může např. definovat, že HTML element pro obrázek má atributy jako zarovnání, rozměry, ohraničení atd.
* '''Připojit jako přílohu''' – soubor chceme zobrazit v automaticky generovaném seznamu příloh ke zprávě. Těchto seznamů může být více druhů (seznam souborů ke stažení, fotogalerie apod.), proto je zde nutné vybrat druh seznamu.
* '''Tento soubor nepřipojovat''' – soubor se ke zprávě nepřipojí.

<div class="note">Administrátor WebToDate by vám měl poskytnout potřebné informace – který styl je třeba vybrat, když má být obrázek v textu, který seznam pro připojení ke zprávě jako soubor ke stažení apod.</div>

Když pro každý soubor ve výběru provedete správnou volbu, použijte tlačítko '''Připojit ke zprávě''' (připojí všechny soubory ke zprávě a obsah uživatelského výběru ponechá beze změny) nebo '''Připojit ke zprávě a smazat výběr''' (stejná akce jako předchozí tlačítko, ale navíc odstraní celý obsah výběru). Tato druhá varianta je vhodnější v případě, že vybrané soubory už nechcete použít u jiné zprávy, není pak třeba ručně explicitně smazat obsah výběru vyvoláním dalšího dialogu.

Pokud jste chtěli soubor zařadit jen jako položku do seznamu příloh, není třeba provádět nic dalšího. Pokud chcete např. použít soubor jako obrázek v textu zprávy, jedná se o třetí krok popsaný v následující kapitole.

== Vložení obrázku do textu ==
Seznam připojených souborů v záložce '''Zdroje''' (ve formuláři pro úpravu zprávy) obsahuje pro každý soubor název zdroje a souboru a informace o souboru (velikost a případně rozměry obrázku). Dále jsou v každém řádku ikony pro manipulaci s těmito soubory (resp. s jejich instancemi ve zprávě). Jedná se o následující možnosti:

* '''Náhled''' – zobrazuje v novém okně soubor. Ikona pro náhled má dvě různé varianty, jedna (se sponkou) se zobrazuje v případě, že je souboru připojen jako příloha k nějakému seznamu, druhá (bez sponky) se zobrazuje, pokud je soubor připojen přímo pod nějakým WebToDate stylem.
* '''Úprava vlastností instance''' – otevírá dialog pro nastavení vlastností instance (specifikuje se zde v podstatě buď příslušnost k určitému seznamu příloh, nebo styl, kterým se soubor ve zprávě formátuje)
* '''Odstranit''' – po potvrzení odstraňuje připojení souboru ke zprávě
* '''Vložit klíčové slovo pro instanci do schránky''' (systémového ''clipboardu'')
* '''Vložit klíčové slovo pro instanci do pole Obrázek'''

Poslední dvě funkce slouží pro vložení klíčového slova instance, tj. značky, za kterou se dosazuje soubor ze zdroje zformátovaný vybraným WebToDate stylem. Značku můžete umístit do kteréhokoliv textového pole zprávy, typicky se ovšem jedná buď o tělo zprávy, nebo pole Obrázek. Pro pole Obrázek existuje jednoduchá metoda – stačí použít ikonu '''Vložit klíčové slovo pro instanci do pole Obrázek'''. Pro vložení do těla zprávy je třeba nejprve nakopírovat značku do systémové schránky ('''Vložit klíčové slovo pro instanci do schránky'''), pak se ve formuláři přepnout do záložky '''Základní''' a nakopírovat (z klávesnice Ctrl + V) na vhodné místo v textu.

Poslední funkce – vložení klíčového slova pro instanci do těla zprávy – je podporována i ve WYSIWYG editoru. Postup je následující:

Pomocí ikony [[Image:redaktorska-zdroje-img053.png]] se otevře dialogové okno zobrazující seznam relevantních souborů připojených z databáze zdrojů ke zprávě. Jednotlivé řádky zde odpovídají těmto souborům. V každém řádku naleznete informace o tomto souboru – náhled nebo ikonu, název zdroj, název souboru, jeho velikost a případně rozměry.

[[Image:redaktorska-zdroje-img054.png|center]]

Klepnutím na řádek v tomto seznamu se na pozici kurzoru v textu vloží odpovídající značka. V textu se tato značka zobrazuje následující způsobem.

[[Image:redaktorska-zdroje-img055.png|center]]

Značka je odlišena jinou barvou a obsahuje název zdroje a případně další informace o souboru.

Poklepáním na značku lze znovu otevřít seznam připojených souborů a případně vybrat jiný soubor. Jinak lze značku jednoduše přetahovat myší nebo jedním klepnutím a klávesou ''Del'' odstranit,

Ve WYSIWYG editoru se nezobrazují vlastní soubory, ale pouze tyto značky. Výhodné je proto používat vizuální režim úpravy zpráv – jakmile text uložíte, v tomto režimu se již zobrazí soubor v odpovídajícím formátování, jak je zobrazeno na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img056.png|center]]

WebToDate/Redaktorská/Zdroje

2019-08-30T07:39:38Z

Jardac: /* Uživatelská schránka - multiupload*/

[[Category:WebToDate Redaktorská]]
[[Category:Redaktorská]]
== Co jsou zdroje ==
Zdroje využijete v případě, že chcete ve zprávě použít jakýkoliv soubor – obrázek uvnitř textu, přílohu ke stažení, obrázek do fotogalerie apod. Databáze zdrojů je jakýsi sklad souborů k dalšímu použití na webové prezentaci, přičemž tyto soubory jsou opatřeny doprovodnými informacemi (metadaty) podobně jako zprávy tak, aby bylo možné zdroje prohledávat a efektivně spravovat.

Redaktor vytvářející zprávu, ke které patří i nějakou soubory, postupuje následovně:

# vybere potřebné soubory z databáze zdrojů, případně je do této databáze vloží, pokud se tam ještě nenacházejí.
# Vytvoří zprávu
# Připojí vybrané soubory ze ke zprávě, v rámci tohoto připojování musí označit, zda se jedná o obrázek v textu, obrázek do fotogalerie, soubor ke stažení apod.
# Pokud je nějaký připojený soubor potřeba umístit na nějaké konkrétní místo v textu, provede to.
== Procházení databáze zdrojů ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). V pravé horní části okna se zobrazí seznam podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img053.png|center]]

V prvním řádku seznamu jsou k dispozici odkazy pro přidání nového zdroje, stránkování seznamu a zobrazení uživatelského výběru a uživatelské schránky.

V prvním sloupci se zobrazují ikony pro náhled, uzamčení / odemčení zdroje a vyznačení stavu zdroje. V druhém sloupci se zobrazují textové informace o zdroji – název, popis, výchozí kategorie, datum a údaje o souboru (formát, velikost, případně rozměry).

Třetí sloupec zobrazuje počet souborů ve zdroji. Kliknutím na ikonu se navíc přidává soubor do výběru. Pokud je soubor ve zdroji jen jeden, provede se akce okamžitě, pokud je zde souborů víc, zobrazí se dialog, ve kterém se vybírá, které soubory do výběru vložit. Více o uživatelském výběru se dozvíte v kapitole '''Uživatelský výběr'''.

Poslední sloupec zobrazuje náhled (v případě, že se jedná o obrázek) nebo ikonu (v případě že se jedná o soubor). Klepnutím na náhled či ikonu se zobrazí v novém okně prohlížeče náhled ''master'' varianty, čili fotografie v původní velikosti apod.

Vyhledávání zdrojů funguje analogicky jako vyhledávání zpráv.

[[Image:redaktorska-zdroje-img038.png|center]]

Vyhledávání zde opět nefunguje jednorázově, ale jako filtr nastavený v rámci daného připojení. Pokud se tedy nezobrazují v seznamu všechny očekávané položky, použijte odkaz '''Vyhledat''' a ujistěte se, že není aplikován nějaký filtr, který zobrazuje pouze část obsahu databáze zdrojů.

== Vytvoření nového zdroje ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). Použijte odkaz '''Přidat''' v pravém horním rohu obrazovky.

Formulář pro vkládání zdrojů se skládá ze tří záložek – '''Základní''' – '''Zařazení''' – '''Položky'''. Záložka '''Položky''' je pro nový zdroj nepřístupná a zobrazí se až po prvním uložení, to znamená, že soubory lze do zdrojů vkládat, až když je zdroj vytvořen.

[[Image:redaktorska-zdroje-img039.png|center]]

Vytvoření zdroje je velmi podobné vytvoření zprávy, v první záložce se vyplní především Nadpis, v druhé záložce se zvolí vhodná metadata.

[[Image:redaktorska-zdroje-img040.png|center]]

<div class="note">Věnujte pozornost stavu zdroje – soubory ze zdrojů jsou prezentovány na veřejné části pouze, pokud je stav zdroje '''Publikováno'''.</div>

== Vložení nového souboru do zdroje ==
Soubor se do zdroje vkládá tlačítkem '''Přidat položku''' v záložce '''Položky''' vstupního formuláře.

[[Image:Referencniprirucka-zdroje-img050.png|center]]

Zobrazí se dialogové okno podle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img051.png|center]]

Soubory lze do zdroje vložit buď z lokálního disku, nebo z uživatelské schránky. Pokud máte soubor na svém lokálním disku, vyberte jej pomocí volby '''Vložit soubor z lokálního počítače'''. Funkce schránky jsou popsány v následující kapitole.

== Uživatelská schránka ==
Uživatelská schránka je místo, kam může uživatel vkládat soubory, které ještě nejsou zařazeny do databáze a nejsou zařazeny do žádného zdroje. Pokud si chcete nejprve na serveru připravit více souborů a ty potom do zdrojů zařadit (tj. zadat popisky apod.), použijte nejprve schránku.

[[Image:referencniprirucka-zdroje-img055.png|center]]

Obsah schránky vyvolejte odkazem '''Schránka''' v seznamu zdrojů. Otevře se dialogové okno, ve kterém lze buď přidat soubory z lokálního disku do schránky, nebo naopak odstranit vybraný soubor či všechny soubory ze schránky. Pro odstranění jednoho souboru klepněte na radiopřepínač pod náhledem či ikonou souboru a použijte tlačítko '''OK'''. Pro odstranění všech souborů ze schránky použijte tlačítko '''Smazat vše'''.

V dialogu pro vložení souboru do zdroje se obsah schránky zobrazuje rovněž. V tomto dialogu lze vybrat buď soubor z lokálního disku, nebo ze schránky. Pokud je vybrán soubor ze schránky, soubor se ze schránky nekopíruje, ale přesouvá, což znamená, že po vložení souboru ze schránky do zdroje tento soubor ze schránky mizí.

== Rychlé vytvoření více zdrojů z obsahu schránky ==
Z okna pro zobrazení schránky lze vyvolat funkci pro hromadné vložení souborů ve schránce do databáze zdrojů. Tato funkce je určena především k vytvoření více zdrojů najednou s obrázky, které pak tvoří např. fotogalerii k dané zprávě, lze ji ale s výhodou použít i na vkládání jednotlivých obrázků, protože umožňuje automaticky v jednom kroku vytvořit i druhou variantu obrázku – náhled vhodný pro další použití ve webové prezentaci.

Funkce se spouští tlačítkem '''Vytvořit zdroje''' ve okně zobrazujícím obsah schránky. Zobrazí se formulář dle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img056.png|center]]

Funkce zařadí do databáze zdrojů všechny obrázky aktuálně umístěné do schránky, každý obrázek jako samostatný zdroj. Pro funkci platí následující:

* Všechny takto vytvořené zdroje mají stejná metadata, výjimkou je pouze možnost zvolit jako název zdroje název souboru (první radiopřepínač ve formuláři)
* Všechny soubory budou umístěny na serveru v jednom adresáři, který je ve formuláři uveden
* Hromadně je nastavitelná pro jednoduchost pouze vybraná množina metadat, ve formuláři tedy chybí např. datum ''Publikovat dne'', ''Témata'' apod.
* Vytvořené zdroje mají stav zvolený ve formuláři a vždy jsou odemčené.

Volby dále zrychlující celou práci jsou ve formuláři dole:

* '''Vytvořit pro obrázky další variantu''' – funkce vytvoří automaticky pro všechny obrázky druhou variantu uloženou vždy ve stejném zdroji jako původní obrázek, rozměry této varianty se vybírají v příslušné rozevírací nabídce. Nová varianta se nezakládá, pokud jsou rozměry obrázku ve schránce menší než nastavený požadovaný rozměr.
* '''Přidat soubory do uživatelského výběru''' – naplní uživatelský výběr právě vloženými soubory. Pokud je zvoleno vytváření nové varianty, do výběru se vloží vždy tato druhá varianta, v opačném případě původní (''master'') soubor.

Když úloha skončí, okno se schránkou se uzavírá a obnovuje se seznam zdrojů, typický výsledek je na následujícím otisku obrazovky:

[[Image:redaktorska-zdroje-img045.png|center]]

Zdroje jsou vytvořené a obrázky v nich požadovaným způsobem uložené, stačí vybrat nějakou konkrétní zprávu a připojit k ní výběr souborů, obsah fotogalerie (či příloh ke zprávě apod.) je takto rychle sestaven.

== Úpravy obrázků ==
WebToDate obsahuje zabudovaný editor, kterým lze měnit vložené obrázky nebo vytvářet nové varianty (zmenšeniny, ořezy apod.). Použití zabudovaného editoru pro obrázky je v zásadě možné ve dvou případech:

# Chceme editovat obrázek, který je již vložen do zdroje. Použijeme funkci '''Upravit obrázek''' u souboru ve zdroji. Tato funkce je dostupná pouze pro soubory, které nejsou nebyly vloženy do zdroje jako první (interně jsou označeny jako ''master'').
# Chceme vytvořit novou variantu obrázku – zmenšeninu, ořez apod. Použijeme tlačítko '''Vytvořit novou variantu obrázku'''.

V obou případech se zobrazí editor obrázků podle následujícího otisku obrazovky.

[[Image:Referencniprirucka-zdroje-img065.png|center]]

V horní části okna je informační lišta (velikosti souborů apod.). Je zde rovněž funkce '''Zoom''' – ta umožňuje pouze zvětšit či zmenšit opticky obrázek. Funkce toto provádí pouze na straně klienta a s obrázkem fyzicky nijak nemanipuluje. Je vhodná v případě, že chcete pomocí myši přesněji vytvořit rámeček pro oříznutí.

Dále je k dispozici nabídka '''Akce''', která specifikuje, co se má provést. Jedná se o následující volby:

# '''Zmenšit na předdefinovanou velikost''' – v nabídce vpravo je seznam možných předdefinovaných velikostí, obsah této nabídky se definuje v globálních předvolbách WebToDate.
# '''Zmenšit na zadanou velikost''' – vpravo jsou políčka '''šířka''' a '''výška''', které je třeba vyplnit. Pokud jsou zadány oba rozměry, obrázek se zmenší tak, aby oba zadané rozměry nebyly překročeny a aby byl zachován poměr stran. Lze zadat pouze jeden z rozměrů, pak se druhý automaticky dopočítá opět tak, aby byl zachován poměr stran.
# '''Doostřit''' - provádí doostření obrázku podle zadaných parametrů (poloměr, míra, sigma, práh). Výchozí hodnoty všech těchto parametrů lze nastavit v globálních předvolbách WebToDate.
# '''Vodoznak''' - vkládá do obrázku soubor s vodoznakem, lze zvolit umístění a jas vodoznaku. Seznam souborů, které lze vložit jako vodoznak, se definuje v globálních předvolbách WebToDate, stejně tak v těchto předvolbách lze nastavit výchozí hodnoty pro umístění a jas.
# '''Oříznout podle výběru''' – pomocí myši vytvořte v náhledu rámeček pro oříznutí a použijte tlačítko '''Provést akci'''.
# '''Oříznout podle výběru se zadáním rozměrů''' – zadejte oba rozměry požadovaného výřezu a klepněte myší na místo v obrázku, kde má být levý horní roh výběru, pak použijte tlačítko '''Provést akci'''.
# '''Otočit o 90 stupňů''' – vpravo se vybírá otočení doleva nebo doprava
# '''Nahradit kopií souboru master''' – jedná se o jakýsi návrat zpět, použijte v případě, že jste vytvořili obrázek v nevyhovující podobě.
# '''Návrat k uložené variantě''' - je k dispozici pouze v případě, že se jedná o editaci existující varianty, nikoliv o vytváření nové varianty. Funkce vrací editovaný obrázek zpět k souboru, který je aktuálně uložen jako daná upravovaná varianta, je to tedy jakýsi návrat zpět pro případ, že provedené operace při úpravách obrázku neodpovídají žádoucímu výsledku.

<div class="note">Všechny tyto volby je vždy třeba potvrdit tlačítkem '''Provést akci'''. Je možné provést i několik akcí za sebou – např. nejprve obrázek oříznout a pak zmenšit. V takovém případě použijte několikrát funkci '''Provést akci''' a nakonec tlačítko '''Uložit'''.</div>

Možnosti pro změnu velikosti mají následující vlastnosti:

* Je podporováno pouze zmenšování, nikoliv zvětšování. Pokud zadáte větší rozměry, než má obrázek, žádná akce se neprovede.
* Zmenšování se vždy provádí se zachováním poměrů stran obrázku. Provede se tak, že ani jeden rozměr nesmí ve výsledku přesáhnout požadované rozměry.

Význam parametrů pro funkci '''Doostřit''' je zhruba tento:

* ''Poloměr'' - udává se v obrazových bodech a říká, jak široká oblast kolem hrany bude doostřením zasažena. Jinými slovy v jak široké oblasti kolem hrany se kontrast plynule zvýší podle hodnoty ''Míra''. Musí jít o nezáporné číslo (může být i desetinné).
* ''Míra'' - určuje, jak moc bude hrana zvýrazněna. 100% znamená, že původní kontrast hrany bude zvýšen o 100% (tj. na dvojnásobek). Jedná se o celé nezáporné číslo v procentech (může být i více než 100%).
* ''Sigma'' - směrodatná odchylka Gaussova rozložení, udává se v obrazových bodech. Musí jít o nezáporné číslo (může být i desetinné), musí být menší než ''Poloměr''.
* ''Práh'' - říká, jak velký musí být absolutní rozdíl jasů mezi sousedními body obrazu, aby se považovaly za hranu, a tudíž se zostřily filtrem. Jedná se o celé nezáporné číslo v procentech.

Ve funkci '''Vodoznak''' se v prvé řadě vybírá obrázek ze seznamu definovaného v globálních předvolbách, který se má vložit jako vodoznak. Dále se vybírá umístění, které je popsáno jako výběr světových stran, tj. má následující možnosti:

* severozápad
* sever
* severovýchod
* západ
* střed
* východ
* jihozápad
* jih
* jihovýchod

Volba ''jihovýchod'' tedy např. znamená pravý spodní okraj obrázku apod.

Poslední volbou je jas vodoznaku - zadává se jako údaj v procentech v rozsahu 0 až 100%.

== Konverze souborů ==
=== Konverzní pravidla ===

Administrátor může pro obrázky, audia a videa nadefinovat konverzní pravidla. To znamená, že při vložení souboru do zdroje se může spustit nějaká konverzní funkce, která změní formát souboru či jej jinak upraví.

Při vložení souboru do zdroje se vyhodnocuje, zda pro vkládaný formát souboru existuje nějaké konverzní pravidlo a pokud ano, zda jsou splněny podmínky pro konverzi definované v pravidle (např. rozměry obrázku přesahují definovanou velikost apod.). Pokud je zjištěno, že existuje alespoň jedno relevantní pravidlo, zobrazí se dialog pro potvrzení konverze.

[[Image:redaktorska-zdroje-img047.png|center]]

V dialogu se vypíše seznam relevantních pravidel. Pravidla, která jsou volitelná, mají vedle názvu zaškrtávací okénko, kterým lze zvolit, zda se konverzní pravidlo aplikuje. Automaticky spouštěná pravidla tuto volbu nemají. Tlačítko '''OK''' spouští postupně všechna pravidla. Tlačítko '''Storno''' stornuje proces konverze. Platí zde následující:

* Pokud jsou všechna nabízená pravidla pouze volitelná a použije se '''Storno''', vloží se do zdroje původní nekonvertovaný soubor.
* Pokud je alespoň jedno nabízené pravidlo automatické a použije se '''Storno''', žádné konverze se neprovádějí, ale zároveň se do zdroje žádný soubor nevkládá - původní soubor se ze serveru smaže a zdroj zůstává beze změny.

=== Konverzní funkce ===

Ikona '''Úprava vlastností souboru''' ve formuláři pro úpravy zdroje vyvolává následující dialog. Pokud existuje alespoň jedna konverzní funkce pro daný formát souboru, zobrazí se v dialogu tlačítko '''Konvertovat'''.

[[Image:redaktorska-zdroje-img048.png|center]]

Tlačítko '''Konvertovat''' zobrazí dialog pro výběr a spuštění konverzní funkce. Na rozdíl od pravidel konverze se takto spouští vždy právě jedna konverzní funkce, která se vybírá radiopřepínačem.

[[Image:redaktorska-zdroje-img049.png|center]]

Tlačítko '''OK''' spouští zvolenou konverzní funkci, tlačítko '''Storno''' ruší volbu a soubor ve zdroji zůstává beze změny.

== Uživatelský výběr ==
Pro to, aby byl soubor připojen a nějak použit ve zprávě, se postupuje ve dvou až třech krocích.

V prvním kroku se vybere soubor z databáze zdrojů, který chceme ke zprávě připojit. To se prování klepnutím na ikonu '''Soubory''' v seznamu zdrojů nebo ikonou '''Přidat do výběru''' ve formuláři pro úpravu zdroje (záložka '''Soubory''', sloupec ''Úpravy'' v seznam souborů ve zdroji). Je-li ve zdroji uložen více než jeden soubor, zobrazí se v případě potřeby dialog, ve kterém je třeba vybrat, který soubor ze zdroje se do výběru přidává (lze vybrat i více než jeden soubor). Tento dialog je na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img050.png|center]]

<div class="note">Doporučujeme nejprve postupně vybrat všechny soubory, které mají být ke zprávě použity, zamezí se tím nutnosti opakovaně přecházet na jiné obrazovky mezí databází zpráv a zdrojů.</div>

V dalších formulářích je možné zpracovávaný soubor rovnou přidat (kromě jiné akce realizované daným dialogem) do výběru. Jedná se o:

* Vložení prvního či dalšího souboru do zdroje
* Obrazovku pro úpravy obrázků

Co je aktuálně v uživatelském výběru lze kdykoliv zobrazit. To je možné buď odkazem '''Výběr''' v seznamu zdrojů, nebo tlačítkem '''Zobrazit výběr souborů''' ve formuláři pro editaci zpráv (v záložce '''Soubory'''). Tento dialog je zobrazen na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img051.png|center]]

V tomto okně lze případně nějaké soubory z výběru odstranit, buď pouze vybrané, nebo případně všechny (tlačítko '''Smazat z výběru všechny'''). Soubory se tím samozřejmě nemažou z databáze zdrojů, ale pouze z výběru.

<div class="note">Do výběru si můžete vložit i soubory, které chcete připojit k více zprávám. Ve chvíli připojování ke zprávě lze specifikovat, které soubory z výběru se připojují a které ne.</div>

== Připojení souborů ke zprávě ==
Druhým krokem je připojení souborů, které jsou ve výběru, ke zprávě. Když máte všechny potřebné soubory umístěny do uživatelského výběru, přejděte do formuláře pro úpravu rozpracované zprávy a použijte tlačítko '''Připojit výběr souborů'''. Zobrazí se následující dialog.

[[Image:redaktorska-zdroje-img052.png|center]]

V tomto dialogu jsou vypsány všechny soubory, které se aktuálně nacházejí v uživatelském výběru. Pro každý soubor jsou tři možnosti:

* '''Připojit pod vybraným stylem''' – tato volba se použije v případě, že chceme soubor použít samostatně (typicky v těle zprávy nebo např. v poli obrázek). Je třeba zde vybrat vhodný styl, kterým se data ze zdroje formátují – styl může např. definovat, že HTML element pro obrázek má atributy jako zarovnání, rozměry, ohraničení atd.
* '''Připojit jako přílohu''' – soubor chceme zobrazit v automaticky generovaném seznamu příloh ke zprávě. Těchto seznamů může být více druhů (seznam souborů ke stažení, fotogalerie apod.), proto je zde nutné vybrat druh seznamu.
* '''Tento soubor nepřipojovat''' – soubor se ke zprávě nepřipojí.

<div class="note">Administrátor WebToDate by vám měl poskytnout potřebné informace – který styl je třeba vybrat, když má být obrázek v textu, který seznam pro připojení ke zprávě jako soubor ke stažení apod.</div>

Když pro každý soubor ve výběru provedete správnou volbu, použijte tlačítko '''Připojit ke zprávě''' (připojí všechny soubory ke zprávě a obsah uživatelského výběru ponechá beze změny) nebo '''Připojit ke zprávě a smazat výběr''' (stejná akce jako předchozí tlačítko, ale navíc odstraní celý obsah výběru). Tato druhá varianta je vhodnější v případě, že vybrané soubory už nechcete použít u jiné zprávy, není pak třeba ručně explicitně smazat obsah výběru vyvoláním dalšího dialogu.

Pokud jste chtěli soubor zařadit jen jako položku do seznamu příloh, není třeba provádět nic dalšího. Pokud chcete např. použít soubor jako obrázek v textu zprávy, jedná se o třetí krok popsaný v následující kapitole.

== Vložení obrázku do textu ==
Seznam připojených souborů v záložce '''Zdroje''' (ve formuláři pro úpravu zprávy) obsahuje pro každý soubor název zdroje a souboru a informace o souboru (velikost a případně rozměry obrázku). Dále jsou v každém řádku ikony pro manipulaci s těmito soubory (resp. s jejich instancemi ve zprávě). Jedná se o následující možnosti:

* '''Náhled''' – zobrazuje v novém okně soubor. Ikona pro náhled má dvě různé varianty, jedna (se sponkou) se zobrazuje v případě, že je souboru připojen jako příloha k nějakému seznamu, druhá (bez sponky) se zobrazuje, pokud je soubor připojen přímo pod nějakým WebToDate stylem.
* '''Úprava vlastností instance''' – otevírá dialog pro nastavení vlastností instance (specifikuje se zde v podstatě buď příslušnost k určitému seznamu příloh, nebo styl, kterým se soubor ve zprávě formátuje)
* '''Odstranit''' – po potvrzení odstraňuje připojení souboru ke zprávě
* '''Vložit klíčové slovo pro instanci do schránky''' (systémového ''clipboardu'')
* '''Vložit klíčové slovo pro instanci do pole Obrázek'''

Poslední dvě funkce slouží pro vložení klíčového slova instance, tj. značky, za kterou se dosazuje soubor ze zdroje zformátovaný vybraným WebToDate stylem. Značku můžete umístit do kteréhokoliv textového pole zprávy, typicky se ovšem jedná buď o tělo zprávy, nebo pole Obrázek. Pro pole Obrázek existuje jednoduchá metoda – stačí použít ikonu '''Vložit klíčové slovo pro instanci do pole Obrázek'''. Pro vložení do těla zprávy je třeba nejprve nakopírovat značku do systémové schránky ('''Vložit klíčové slovo pro instanci do schránky'''), pak se ve formuláři přepnout do záložky '''Základní''' a nakopírovat (z klávesnice Ctrl + V) na vhodné místo v textu.

Poslední funkce – vložení klíčového slova pro instanci do těla zprávy – je podporována i ve WYSIWYG editoru. Postup je následující:

Pomocí ikony [[Image:redaktorska-zdroje-img053.png]] se otevře dialogové okno zobrazující seznam relevantních souborů připojených z databáze zdrojů ke zprávě. Jednotlivé řádky zde odpovídají těmto souborům. V každém řádku naleznete informace o tomto souboru – náhled nebo ikonu, název zdroj, název souboru, jeho velikost a případně rozměry.

[[Image:redaktorska-zdroje-img054.png|center]]

Klepnutím na řádek v tomto seznamu se na pozici kurzoru v textu vloží odpovídající značka. V textu se tato značka zobrazuje následující způsobem.

[[Image:redaktorska-zdroje-img055.png|center]]

Značka je odlišena jinou barvou a obsahuje název zdroje a případně další informace o souboru.

Poklepáním na značku lze znovu otevřít seznam připojených souborů a případně vybrat jiný soubor. Jinak lze značku jednoduše přetahovat myší nebo jedním klepnutím a klávesou ''Del'' odstranit,

Ve WYSIWYG editoru se nezobrazují vlastní soubory, ale pouze tyto značky. Výhodné je proto používat vizuální režim úpravy zpráv – jakmile text uložíte, v tomto režimu se již zobrazí soubor v odpovídajícím formátování, jak je zobrazeno na následujícím otisku obrazovky.

[[Image:redaktorska-zdroje-img056.png|center]]

WebToDate/Referenční/Zdroje

2019-08-30T07:36:16Z

Jardac: /* Multiupload souborů */

[[Category:WebToDate Referenční]]
[[Category:Referenční]]
== Co jsou zdroje ==
Drtivá většina webových prezentací se neskládá jen z textových informací ve formě HTML stránek, ale i většího množství souborů v nejrůznějších formátech. Může jít o grafiku vloženou do textu (obrázky zpravidla ve formátech JPEG, GIF či PNG, flash animace apod.), častá je i nabídka nejrůznějších souborů ke stažení (PDF dokumenty, ceníky ve formátech XLS či DBF atd.).

Databáze zdrojů zavedená od verze WebToDate 4.0 zásadním způsobem rozšiřuje možnosti správy souborů v jiných než značkovacích formátech (HTML, XML apod.). Jedná se o databázové úložiště souborů v libovolných formátech (obrázků, PDF, ….), které slouží jako sklad objektů použitelných na jednotlivých stránkách a to buď přímým vložením do stránky (typicky obrázky) nebo jako odkazy na soubory (typicky třeba stažení příloh ve formátu PDF). Cíle této funkce jsou:

* Mít k dispozici databázově organizované úložiště externích souborů, tj. kromě vlastních souborů mít k dispozici prohledávatelná metadata (název, popis, formát, klíčová slova, datum vložení, autor,…)
* Přiřazovat tyto záznamy ke zprávám tak, aby bylo možno zobrazit seznam přiřazených položek (např. seznam odkazů na PDF soubory) včetně omezení na určité typy (odděleně seznam PDF, MS Word souborů apod.). Jeden soubor může být použit vícekrát.
* Vkládat objekty z této databáze do zpráv (do těla, do jednotlivých polí, týká se hlavně obrázků, flash animací apod.)
* Volitelně zajistit možnost stahování podle přístupových práv a ne pouze všem anonymním uživatelům, tedy aby např. externí soubor nebylo možno stáhnout přímo (např. pouze pro registrované uživatele)
* Zajistit možnost publikace a expirace v určitý čas
* Vytvořit možnost vytvářet katalogy zobrazitelné automaticky i z veřejné části (funkce fotoalbum)
* Mít možnost základních operací s obrázky na serveru, obrázkové soubory v administračním rozhraní zobrazovat ve formě náhledů
* Zaručit konzistenci dané webové prezentace z hlediska odkazů na soubory – databáze zdrojů brání tomu, aby bylo např. možné odstranit obrázek, který je někde použitý apod.

Z hlediska uživatele se úložiště souborů jeví tak, že ukládá soubory do stromové struktury kategorií podobným způsobem jako zprávy či fragmenty. Položky souborového archívu se nazývají '''zdroje'''. Objekt "zdroj" má následující vlastnosti:

* Metadata – k souborům lze vložit řadu metadat, která jsou ekvivalentní s metadaty zpráv, např. nadpis, popis, data (vložení, aktualizace, platnosti), autor, klíčová slova apod.
* Položky – každý zdroj má jeden nebo více souborů, tj. variant daného souboru a "technických" informací o nich. Např. jeden obrázek může být uložen ve více variantách (originální obrázek, zmenšený obrázek, náhled, výřez apod.), ke každé variantě jsou k dispozici v databázi údaje jako rozměry, velikost, URL apod. Všechny variantu souborů sdílejí v rámci zdroje společná metadata. Položkou nemusí být jen soubor fyzicky umístěný na serveru, ale i libovolné URL směřující dovnitř dané prezentace i na jiný server.
* Vlastnosti v rámci workflow – každý zdroj má stejně jako zprávy stav a příznak uzamčení / odemčení. Přístup k nim podléhá přístupovým právům podobně jako u zpráv.

Primárním nástrojem publikování souborů na veřejné části je pak přiřazování ke zprávám, tj. vytváření tzv. instancí. Instance je přiřazení položky z daného zdroje ke zprávě, instance má dále vlastnosti specifikující její grafickou podobu ve zprávě, tj. buď WebToDate styl formátující tuto instanci nebo příslušnost k seznamu souborů (příloh), kde grafika je pak dána stylem seznamu.

K dispozici je pomocný nástroj – uživatelská schránka pro soubory. Při zpracování souborů je možný v zásadě dvojí přístup – buď máme jeden soubor, který chceme umístit na server, opatřit jej metadaty a opublikovat, nebo máme víc souborů, které chceme do archívu postupně zařadit, pak je vhodné je nejprve všechny překopírovat na server a pak postupně opatřovat metadaty a publikovat. Pro druhý případ je k dispozici uživatelská schránka pro soubory. Jedná se o místo, do kterého si uživatel může vložit soubory, které ještě nejsou opatřeny metadaty, nemají příslušné záznamy v databázi, a tudíž se ještě nejedná o zdroje, které lze publikovat. Z této schránky si pak může uživatel vybírat soubory a vytvářet z nich postupně zdroje, případně soubor ze schránky zase vymazat bez toho, že by jej k něčemu použil.

Zdroj se tedy v zásadě skládá ze společných metadat a z libovolného počtu položek. V daném zdroji existují dva soubory s pevně daným významem. Jedná se o

* Soubor označovaný jako ''master'' – to je výchozí varianta souboru, např. originál obrázku či MS Word soubor ke stažení
* ''Náhled'' – soubor určený pouze k zobrazování v administračním rozhraní, malý náhled zobrazující daný obrázek, případně ikonu formátu apod.
* Další varianty – lze přidat libovolný počet další položek jako variant, může jít o zmenšeniny či výřezy obrázku nebo o jiné formáty téhož souboru (master může být např. formát MS Word, další varianta formát PDF apod.)

[[Image:referencniprirucka-zdroje-img045.png|center]]

<div class="note">Varianta ''náhled'' je určena pouze pro potřeby administračního rozhraní, na veřejné části webu ji nelze použít.</div>

Důležité je, že existuje více konfigurovatelných způsobů ukládání vlastních souborů. Z hlediska uživatelů se jedná o možnost umístění do veřejné či privátní zóny – analogicky jako u stránek lze soubory, které mají být buď přístupné pouze pro registrované uživatele, nebo které ještě nejsou publikovány, vložit do privátní zóny, ze které je možné je stahovat pouze přes skript ověřující přístupová práva. Více o veřejné a privátní zóně naleznete v kapitole [[../Strom kategorií#Veřejná a privátní zóna|Veřejná a privátní zóna]].

== Možnosti využití zdrojů na veřejné části serveru ==
=== Co jsou instance položek ze zdrojů ===

Instance položek zdrojů se vytvářejí k tomu, aby se ve zprávách zobrazovaly soubory z archívu zdrojů či odkazy na ně. Ke zprávě redaktor pořizuje seznam souborů, které zpráva nějak využívá, tj. buď je má vložené někam do textu (typicky obrázky v těle zprávy) nebo figurují v seznamu příloh ke stažení. Seznam položek ze zdrojů spolu s informací o způsobu formátování ve zprávě tvoří tedy seznam instancí zdrojů ve zprávě.

Chceme-li využít na webu nějaký připravený soubor (obrázek či přílohu), typicky postupujeme tak, že založíme zdroj, vložíme do něj soubor, založíme zprávu a soubor ze zdroje vložíme jako instanci do zprávy.

Instance se vyskytuje buď v některém poli zprávy (typicky ''tělo'' či ''obrázek'') jako vložený soubor či odkaz, nebo se vyskytuje v seznamu příloh (mohou to být přílohy ke stažení či obrázky formátované jako fotogalerie). V prvním případě je třeba mít k dispozici nějaký WebToDate styl, ve druhém případě informaci o tom, že se jedná o přílohu (celý seznam příloh je pak formátován jedním stylem). Těchto seznamů může být i více, druhy seznamů a způsob jejich zobrazování se definuje v rámci implementace designu a struktury webu.

=== Zobrazování položek databáze zdrojů na webu ===

Na následujících obrázcích je schematicky naznačeno možné využití zdrojů ve veřejné části serveru.

[[Image:referencniprirucka-zdroje-img046.png|center]]

[[Image:referencniprirucka-zdroje-img047.png|center]]

Jedná se zejména o následující případy:

# Ve stránce se zprávou se mají zobrazit obrázky vložené do textu (zpravidla těla) zprávy.
# Ve stránce se zprávou se mají v textu nacházet odkazy na soubory, které lze stáhnout.
# Ve stránce se zprávou se mají zobrazit seznamy příloh ke zprávám, které lze stáhnout.
# Ve stránce se zprávou se má zobrazit fotogalerie, která je případně i stránkovaná. Designově lze toto pojmout různým způsobem, buď např. pod tělem zprávy rovnou zobrazit fotogalerii formou mozaiky náhledů, nebo zobrazit tu samou zprávu v jiné předloze, která obsahuje fotogalerii ale ne třeba tělo zprávy, nebo vytvářet samostatné zprávy, jejichž účelem je pouze prezentace nějaké fotogalerie.
# V rubrikové (statické či dynamické stránce) generovat ke zprávám formátovaným nějakým stylem např. obrázek či odkaz na stažení výchozí přílohy.
# Zobrazit větší obrázek s textovými popisky po kliknutí na nějaký obrázek či jiný element (typicky obrázek v textu či ve fotogalerii).
== Struktura zdrojů ==
V databázi zdrojů jsou k dispozici následující položky:

* '''Nadpis''' – název zdroje
* '''Popis''' – stručná anotace ke zdroji
* '''Klíčová slova''' – klíčová slova ke zdroji, pracuje se se stejným slovníkem klíčových slov jako u zpráv
* '''Autor''' – autor zdroje
* '''Tým''' – každý zdroj patří jednomu konkrétnímu týmu, který může obsah zdroje měnit
* '''Časové údaje''' – stejné jako u databáze zpráv (datum zdroje, datum aktualizace, platnost)
* '''Kategorie''' – řazení do kategorií má identické chování jako u zpráv
* '''Témata''' – řazení k tématům má identické chování jako u zpráv
* '''Publikace''' – každý zdroj patří do právě jedné publikace
* '''Priorita''' – celé číslo udávající důležitost zdroje
* '''Předloha''' – předloha, pomocí které lze zobrazit obsah zdroje, je důležitá hlavně v případě, kdy chceme pracovat na stránkách s menšími obrázky, které po kliknutí zobrazí stránku s větším obrázkem včetně zvolených textových popisků
* '''Odkaz nadpisu''' – uplatní se stejně jako předchozí případ (volba předlohy)
* '''Zkratka''' - stejná funkce jako v databázi zpráv.

Povinně je třeba vyplnit nadpis, tým, datum, alespoň jednu kategorii a publikaci.

Každý zdroj má navíc vlastnosti používané při zpracování, tj. '''Stav''' a příznak uzamčení / odemčení.

Ve zdroji se dále nacházejí položky, z vlastností, které uživatel pro soubory může měnit, jsou k dispozici pro soubory:

* '''Adresář''' – adresář na www serveru, ve kterém bude soubor uložen, fyzické umístění navíc závisí na volbě zóny
* '''Název souboru'''
* '''Umístění''' – veřejná nebo privátní zóna

Pokud daná položka není souborem ale odkazem, jsou k dispozici vlastnosti jako

* '''URL''' – adresa odkazu
* '''Název souboru''' – název, který se může zobrazovat ve stránkách
* '''Typ souboru''' – typ je daný koncovkou
* '''Velikost a rozměry''' – i zde lze specifikovat velikost cílové stránky či souboru, pokud odkaz směřuje na obrázek, tak i rozměry

== Založení nového zdroje ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). Použijte odkaz '''Přidat''' v pravém horním rohu obrazovky.

Formulář pro vkládání zdrojů se skládá ze tří záložek – '''Základní''' – '''Zařazení''' – '''Položky'''. Záložka '''Položky''' je pro nový zdroj nepřístupná a zobrazí se až po prvním uložení, to znamená, že položky lze do zdrojů vkládat až když je zdroj vytvořen.

[[Image:referencniprirucka-zdroje-img048.png|center]]

Vytvoření zdroje je velmi podobné vytvoření zprávy, v první záložce se vyplní především Nadpis, v druhé záložce se zvolí vhodná metadata.

[[Image:referencniprirucka-zdroje-img049.png|center]]

<div class="note">Věnujte pozornost stavu zdroje – soubory ze zdrojů jsou prezentovány na veřejné části pouze pokud je stav zdroje '''Publikováno'''..</div>

== Vkládání položek do zdroje ==
=== Přidání nového souboru ===

Soubor se do zdroje vkládá tlačítkem '''Přidat položku''' v záložce '''Položky''' vstupního formuláře.

[[Image:referencniprirucka-zdroje-img050.png|center]]

Zobrazí se dialogové okno podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img051.png|center]]

Soubory lze do zdroje vložit buď z lokálního disku, nebo z uživatelské schránky. Pokud máte soubor na svém lokálním disku, vyberte jej pomocí volby '''Vložit soubor z lokálního počítače'''. Soubory přetahujte do části dialogu pr nahrávání myší nebo použijte tlačítko '''Přidat soubory''', následně spusťte nahrávání na server tlačítkem '''Spustit nahrávání'''.

<div class="note">Maximální velikost souboru vkládaného z lokálního disku je vždy omezena nějakou hodnotou dle konfigurace PHP. Tato maximální velikost se vypisuje jako informace ve WebToDate všude tam, kde je možné na server přes webový formulář odesílat nějaký soubor.</div>

Funkce schránky jsou popsány v kapitole [[../Zdroje#Uživatelská schránka|Uživatelská schránka]]. Dále se v tomto dialogu volí:

* Adresář – adresář je předvyplněn podle složek v definici výchozí kategorie, ve které se zdroj nachází
* Umístění – volí se veřejná či privátní zóna. Tato volba nemusí být k dispozici, záleží na nastavení chování databáze zdrojů v globálních předvolbách WebToDate.
* Přidat do výběru – zaškrtnutím lze zvolit, že se soubor ihned zároveň vloží i do uživatelského výběru.

Po vložení souboru se stane následující:

* Pokud se jedná o první soubor vkládaný do zdroje, označí se jako ''master'' a případně se k němu vytvoří náhled (pokud se jedná o obrázek)
* Pokud se ve zdroji již nějaký soubor nachází, nový soubor se připojí k tomuto stávajícímu, žádný další náhled se již nevytváří.
* Interně se v databázi uloží další "technické" informace o souboru (velikost, rozměry apod.), které pak jsou v systému k dispozici např. pro prezentaci na veřejných stránkách.

<div class="note">Přidat první položku do zdroje je možné vždy, přidávání dalších položek může být zakázáno v konfiguračním souboru WebToDate. Jedná se o konstantu ASSETS_ALLOW_MULTIPLE_FILES v souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]''.</div>

=== Přidání nového odkazu do zdroje ===

Změnou radiopřepínač '''Druh položky''' na '''Externí URL odkaz''' lze místo souboru do zdroje vložit odkaz. Dialogové okno se změní dle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img052.png|center]]

Zde se nejprve do pole '''URL''' zadává cílová adresa. Pod tímto polem jsou k dispozici tlačítka '''Náhled''' a '''Test'''. Funkce '''Náhled''' pouze otevírá v novém okně zadané URL. Tlačítko '''Test''' může kromě kontroly toho, zda zadané URL vůbec existuje vyplnit některá další pole. Tato funkce pracuje následovně:

* Z URL se extrahuje '''Název souboru''' (řetězec mezi posledním lomítkem a případným otazníkem)
* Vyplní se '''Velikost''' (z http hlavičky testovaného URL)
* Vyplní se Typ souboru – z http hlavičky se zjistí MIME typ, porovná se se seznamem typů souborů pro zdroje v pokud je to možné, zvolí se automaticky z nabídky tento typ. Typ nemusí být identifikován jednoznačně, pak se automaticky nevolí.
* Rozměry se automaticky nedoplňují nikdy.

Ve formuláři je třeba povinně zadat pouze URL, vyplnění ostatních polí je volitelné.

=== Úpravy existujícího souboru ===

V záložce '''Položky''' ve formuláři pro úpravy zdroje se nachází seznam souborů ve zdroji. V každém řádku jsou informace o souboru (název, velikost apod.) a nástrojová lišta pro úpravy souboru. V této liště se mohou nacházet následující položky:

* '''Náhled''' – zobrazuje soubor v novém okně prohlížeče.
* '''Úprava vlastností položky''' – vyvolá dialogové okno, kde lze změnit adresář, název souboru a umístění pro soubory, resp. odpovídající vlastnosti pro odkazy. Pokud je zdroj odemčen, lze tento dialog zobrazit také (pro informace o umístění apod.), ale chybí zde tlačítko '''Uložit'''.
* '''Smazat''' – odstraní položku ze zdroje. Položku lze smazat, jen pokud není použita (není vytvořena nějaká instance ve zprávě). Soubor označený jako ''master'' lze smazat, jen pokud ve zdroji nejsou další položky.
* '''Upravit obrázek''' – je k dispozici v případě, že soubor je obrázek a nejedná se o variantu ''master'' (''master'' soubory nelze měnit).

== Seznam zdrojů ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). V pravé horní části okna se zobrazí seznam podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img053.png|center]]

V prvním řádku seznamu jsou k dispozici odkazy pro přidání nového zdroje, stránkování seznamu a zobrazení uživatelského výběru a uživatelské schránky. Dále je zde odkaz '''Ke zpracování''' vypisující zdroje, který čekají na nějaký úkon daného uživatele – funkce pracuje analogicky jako v databázi zpráv.

V levém horním rohu seznamu je prvek '''Zprávy''' / '''Zdroje''', kde '''Zprávy''' je aktivní odkaz. Tato funkce slouží k snadnému přechodu mezi databází zpráv a zdrojů. Při klepnutí na '''Zprávy''' je možno pracovat s databází zpráv, přičemž v rámci session je zapamatován stav seznamu databáze zdrojů i aktuálně otevřený zdroj. V interface pro [[../Zprávy|databázi zpráv]] pak existuje stejný prvek, kterým lze přejít zpět do databáze zdrojů, která se zobrazí přesně tak, jak byla přechodem do zpráv opuštěna. Funkce je vhodná např. pro výběr položek ze zdrojů, které mají být k aktuálně zpracovávané zprávě připojeny.

V prvním sloupci se zobrazují ikony pro náhled, uzamčení / odemčení zdroje a vyznačení stavu zdroje. V druhém sloupci se zobrazují textové informace o zdroji – název, popis, výchozí kategorie, datum a údaje o ''master'' souboru (formát, velikost, případně rozměry).

Třetí sloupec zobrazuje počet souborů ve zdroji (náhled se nepočítá). Kliknutím na ikonu se navíc přidává soubor do výběru. Pokud je soubor ve zdroji jen jeden, provede se akce okamžitě, pokud je zde souborů víc, zobrazí se dialog, ve kterém se vybírá, které soubory do výběru vložit. Více o uživatelském výběru se dozvíte v kapitole [[../Zdroje#Použití zdrojů ve zprávách|Použití zdrojů ve zprávách]].

Poslední sloupec zobrazuje náhled (v případě, že se jedná o obrázek) nebo ikonu (v případě že se jedná o soubor). To se vztahuje vždy na variantu ''master'' – pokud je např. jako master soubor vložen PDF formát a jako další soubor MS Word formát, zobrazí se zde ikona pro PDF soubory apod. Klepnutím v tomto sloupci se opět otevírá v novém okně náhled varianty ''master''.

== Vyhledávání zdrojů ==
Vyhledávání zdrojů funguje analogicky jako vyhledávání zpráv, podrobnější popis naleznete v kapitole [[../Zprávy#Vyhledávání zpráv|Vyhledávání zpráv]].

[[Image:referencniprirucka-zdroje-img054.png|center]]

Vyhledávání zde opět nefunguje jednorázově, ale jako filtr nastavený v rámci daného připojení. Pokud se tedy nezobrazují v seznamu všechny očekávané položky, použijte odkaz '''Vyhledat''' a ujistěte se, že není aplikován nějaký filtr, který zobrazuje pouze část obsahu databáze zdrojů.

== Duplikace zdrojů ==
Tlačítkem '''Duplikovat''' ve formuláři pro úpravu zdrojů lze vytvářet kopie zdrojů. Vzniká duplikát, který je nadále samostatným nezávislým zdrojem a který nemá žádnou návaznost na původně duplikovaný zdroj, což znamená, že jakékoliv následné změny v duplikátu se nijak nepromítají do duplikovaného zdroje. Tato funkce je oproti možnosti duplikování jiných objektů (zpráv, stylů apod.) složitější v tom, že fyzicky duplikuje i všechny soubory ve zdroji. Vznikají kopie všech souborů ve zdroji, které mají stejný obsah, ale samozřejmě jiný název (aby např. nedošlo k pokusu o vytvoření souborů s duplicitním názvem ve stejném adresáři na disku serveru). Při vytváření nových jmen souborů se používají stejná pravidla jako při pokusu o vložení nového souboru do zdrojů pod názvem, který již existuje – seznam konfiguračních parametrů ovlivňujících generování těchto názvů souborů je uveden v kapitole [[../Zdroje#Možnosti konfigurace databáze zdrojů|Možnosti konfigurace databáze zdrojů]].

== Uživatelská schránka ==
=== Co je uživatelská schránka ===

Uživatelská schránka je místo, kam může uživatel vkládat soubory, které ještě nejsou zařazeny do databáze a nejsou zařazeny do žádného zdroje. Do této schránky může uživatel vkládat soubory či je zde mazat bez omezení, ze schránky může vybrat soubor ve chvíli vkládání souboru do zdroje. Každý uživatel má svoji schránku, která není nijak sdílena s ostatními.

Při použití příslušného www formuláře lze vkládat jeden nebo více souborů přes volbu '''Vložit soubor z lokálního počítače do schránky'''. Další způsob jak zpřístupnit práci s více soubory najednou je volitelná možnost konfigurace přístupu do schránky přes ftp protokol. Tato funkce vyžaduje patřičnou konfiguraci ftp serveru a zadání adresy ftp serveru v globálních předvolbách – to se pak projeví tlačítkem pro FTP přístup ke schránce v okně pro schránku.

<div class="note">Od verze 7.0 prohlížeče Internet Explorer není z bezpečnostních důvodů možné přepnout dané okno prohlížeče do FTP režimu zobrazujícího obsah daného adresáře. Pro tuto verzi prohlížeče se proto po použití tohoto tlačítka nabídne místo přímého zobrazení nakopírování příslušného URL pro FTP přístup do schránky. Toto URL vložte (Ctrl+V) buď do svého oblíbené aplikace pro připojení k FTP serverům nebo do adresní řádky Průzkumníka Windows, kde již je připojení s požadovaným zobrazením podporováno.</div>

[[Image:referencniprirucka-zdroje-img055.png|center]]

Obsah schránky vyvolejte odkazem '''Schránka''' v seznamu zdrojů. Otevře se dialogové okno, ve kterém lze buď přidat soubory z lokálního disku do schránky, nebo naopak odstranit vybraný soubor či všechny soubory ze schránky. Pro odstranění jednoho souboru klepněte na radiopřepínač pod náhledem či ikonou souboru a použijte tlačítko '''OK'''. Pro odstranění všech souborů ze schránky použijte tlačítko '''Smazat vše'''.

V dialogu pro vložení souboru do zdroje se obsah schránky zobrazuje rovněž. V tomto dialogu lze vybrat buď soubor z lokálního disku, nebo ze schránky. Pokud je vybrán soubor ze schránky, soubor se ze schránky nekopíruje, ale přesouvá, což znamená, že po vložení souboru ze schránky do zdroje tento soubor ze schránky mizí.

=== Rychlé vytvoření více zdrojů z obsahu schránky ===

Z okna pro zobrazení schránky lze vyvolat funkci pro hromadné vložení souborů ve schránce do databáze zdrojů. Tato funkce je určena především k vytvoření více zdrojů najednou s obrázky, které pak tvoří např. fotogalerii k dané zprávě, lze ji ale s výhodou použít i na vkládání jednotlivých obrázků, protože umožňuje automaticky v jednom kroku vytvořit i druhou variantu obrázku – náhled vhodný pro další použití ve webové prezentaci.

Funkce se spouští tlačítkem '''Vytvořit zdroje''' v okně zobrazujícím obsah schránky. Zobrazí se formulář dle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img056.png|center]]

Funkce zařadí do databáze zdrojů všechny obrázky aktuálně umístěné do schránky, každý obrázek jako samostatný zdroj. Pro funkci platí následující:

* Všechny takto vytvořené zdroje mají stejná metadata, výjimkou je pouze možnost zvolit jako název zdroje název souboru (první radiopřepínač ve formuláři)
* Všechny soubory budou umístěny na serveru v jednom adresáři, který je ve formuláři uveden
* Hromadně je nastavitelná pro jednoduchost pouze vybraná množina metadat, ve formuláři tedy chybí např. datum ''Publikovat dne'', ''Témata'' apod.
* Vytvořené zdroje mají stav zvolený ve formuláři a vždy jsou odemčené.

Volby dále zrychlující celou práci jsou ve formuláři dole:

* '''Vytvořit pro obrázky další variantu''' – funkce vytvoří automaticky pro všechny obrázky druhou variantu uloženou vždy ve stejném zdroji jako původní obrázek, rozměry této varianty se vybírají v příslušné rozevírací nabídce. Nová varianta se nezakládá, pokud jsou rozměry obrázku ve schránce menší než nastavený požadovaný rozměr.
* '''Přidat soubory do uživatelského výběru''' – naplní uživatelský výběr právě vloženými soubory. Pokud je zvoleno vytváření nové varianty, do výběru se vloží vždy tato druhá varianta, v opačném případě původní (''master'') soubor.

Když úloha skončí, okno se schránkou se uzavírá a obnovuje se seznam zdrojů, typický výsledek je na následujícím otisku obrazovky:

[[Image:referencniprirucka-zdroje-img057.png|center]]

Zdroje jsou vytvořené a obrázky v nich požadovaným způsobem uložené, stačí vybrat nějakou konkrétní zprávu a připojit k ní výběr souborů, obsah fotogalerie (či příloh ke zprávě apod.) je takto rychle sestaven.

== Použití zdrojů ve zprávách ==
=== Připojení položek ze zdrojů ke zprávě ===

Principiální způsob využití obsahu databáze zdrojů při vytváření webové prezentace je vysvětlen v kapitole [[../Zdroje#Možnosti využití zdrojů na veřejné části serveru|Možnosti využití zdrojů na veřejné části serveru]].

Při použití souboru ve zprávě se postupuje ve dvou až třech krocích.

V prvním kroku se vybere položka z databáze zdrojů, který chceme ke zprávě připojit. To se prování klepnutím na ikonu '''Položky''' v seznamu zdrojů nebo tlačítkem '''Přidat do výběru''' ve formuláři pro úpravu zdroje. Je-li ve zdroji uložena více než jedna položka, zobrazí se dialog, ve kterém je třeba vybrat, která položka ze zdroje se do výběru přidává (lze vybrat i více než jednu položku). Tento dialog je na následujícím otisku obrazovky.

[[Image:referencniprirucka-zdroje-img058.png|center]]

<div class="note">Doporučujeme nejprve postupně vybrat všechny položky, které mají být ve zprávě použity, zamezí se tím nutnosti opakovaně přecházet na jiné obrazovky mezí databází zpráv a zdrojů.</div>

V dalších formulářích je možné zpracovávaný soubor rovnou přidat (kromě jiné akce realizované daným dialogem) do výběru. Jedná se o:

* Vložení prvního či dalšího souboru do zdroje
* Obrazovku pro úpravy obrázků

Co je aktuálně v uživatelském výběru lze kdykoliv zobrazit. To je možné buď odkazem '''Výběr''' v seznamu zdrojů nebo tlačítkem '''Zobrazit výběr souborů''' ve formuláři pro editaci zpráv (v záložce '''Soubory'''). Tento dialog je zobrazen na následujícím otisku obrazovky.

[[Image:referencniprirucka-zdroje-img059.png|center]]

V tomto okně lze případně nějaké položky z výběru odstranit, buď pouze vybrané, nebo případně všechny (tlačítko '''Smazat z výběru všechny'''). Položky se tím samozřejmě nemažou z databáze zdrojů, ale pouze z výběru.

<div class="note">Do výběru si můžete vložit i položky, které chcete připojit k více zprávám. Ve chvíli připojování ke zprávě lze specifikovat, které položky z výběru se připojují a které ne.</div>

Uživatelský výběr je struktura, která se uchovává perzistentně v databázi systému. To znamená, že po opětovném přihlášení najde uživatel ve svém výběru přesně to, co tam dříve vložil.

Druhým krokem je připojení položek, které jsou ve výběru, ke zprávě. Když máte všechny potřebné soubory umístěny do uživatelského výběru, přejděte do formuláře pro úpravu rozpracované zprávy a použijte tlačítko '''Připojit výběr položek'''. Zobrazí se následující dialog.

[[Image:referencniprirucka-zdroje-img060.png|center]]

V tomto dialogu jsou vypsány všechny položky, které se aktuálně nacházejí v uživatelském výběru. Pro každou položku jsou tři možnosti:

* '''Připojit pod vybraným stylem''' – tato volba se použije v případě, že chceme položku použít samostatně (typicky v těle zprávy nebo např. v poli obrázek. Je třeba zde vybrat vhodný styl, kterým se data ze zdroje formátují – styl může např. definovat, že HTML element pro obrázek má atributy jako zarovnání, rozměry, ohraničení atd.
* '''Připojit jako přílohu''' – soubor chceme zobrazit v automaticky generovaném seznamu příloh ke zprávě. Těchto seznamů může být více druhů (seznam souborů ke stažení, fotogalerie apod.), proto je zde nutné vybrat druh seznamu.
* '''Tento soubor nepřipojovat''' – soubor se ke zprávě nepřipojí.

Navíc je k dispozici tlačítko '''Nastavit pro všechny''', které nastaví způsob připojení stejně pro všechny soubory v seznamu podle toho, jak je nastavená první položka v seznamu. Pokud tedy např. chcete všechny uvedené položky připojit jako přílohy ke stažení, není třeba toto volit u každé položky zvlášť, ale pouze u první a pak použít toto tlačítko. Tlačítko provádí změnu pouze v okně formuláře, tj. jeho použití nevyvolává žádné uložení těchto vlastností na serveru – vždy je následně třeba použít '''Připojit ke zprávě''' resp. '''Připojit ke zprávě a smazat výběr'''.

Když pro každou položku ve výběru provedete správnou volbu, použijte tlačítko '''Připojit ke zprávě''' (připojí všechny položky ke zprávě a obsah uživatelského výběru ponechá beze změny) nebo '''Připojit ke zprávě a smazat výběr''' (stejná akce jako předchozí tlačítko, ale navíc odstraní celý obsah výběru). Tato druhá varianta je vhodnější v případě, že vybrané soubory už nechcete použít u jiné zprávy, není pak třeba ručně explicitně smazat obsah výběru vyvoláním dalšího dialogu.

Pokud jste chtěli položku zařadit jen jako položku do seznamu příloh, není třeba provádět nic dalšího. Pokud chcete např. použít soubor jako obrázek v textu zprávy, jedná se o třetí krok popsaný v následující kapitole.

=== Práce s již připojenými položkami ===

Seznam připojených souborů v záložce '''Zdroje''' (ve formuláři pro úpravu zprávy) obsahuje pro každou položku ID instance, název zdroje a souboru a informace o souboru (velikost a případně rozměry obrázku). Klepnutím na tento řádek se přechází do formuláře pro editaci tohoto zdroje. Dále jsou v každém řádku ikony pro manipulaci s těmito položkami (resp. s jejich instancemi ve zprávě). Jedná se o následující možnosti:

* '''Náhled''' – zobrazuje v novém okně soubor. Ikona pro náhled má dvě různé varianty, jedna (se sponkou) se zobrazuje v případě, že je souboru připojen jako příloha k nějakému seznamu, druhá (bez sponky) se zobrazuje, pokud je soubor připojen přímo pod nějakým WebToDate stylem.
* '''Úprava vlastností instance''' – otevírá dialog pro nastavení vlastností instance (specifikuje se zde v podstatě buď příslušnost k určitému seznamu příloh, nebo styl, kterým se soubor ve zprávě formátuje)
* '''Odstranit''' – po potvrzení odstraňuje připojení položky ke zprávě
* '''Vložit klíčové slovo pro instanci do schránky''' (systémového clipboardu)
* '''Vložit klíčové slovo pro instanci do pole Obrázek'''

Úprava vlastnosti instance je na následujícím otisku obrazovky, lze zde v zásadě změnit způsob přiřazení, neboli změnit styl nebo přiřadit k jinému seznamu příloh.

[[Image:referencniprirucka-zdroje-img061.png|center]]

Pokud je zpráva odemčená, nelze ji měnit, tento dialog pro zobrazení vlastností instance se v takovém případě zobrazí, ale chybí zde tlačítko '''Uložit'''.

Poslední dvě funkce slouží pro vložení klíčového slova instance, tj. značky, za kterou se dosazuje soubor ze zdroje zformátovaný vybraným WebToDate stylem. Tato značka má tvar <nowiki></nowiki>, kde xxx je interní číslování instancí. Značku můžete umístit do kteréhokoliv textového pole zprávy, typicky ovšem se jedná buď o tělo zprávy, nebo pole Obrázek. Pro pole Obrázek existuje jednoduchá metoda – stačí použít ikonu '''Vložit klíčové slovo pro instanci do pole Obrázek'''.

Tato funkce se chová odlišně podle toho, zda je definovaná uživatelsky přizpůsobitelná struktura databáze zpráv a tato struktura obsahuje pole typu ''položka databáze zdrojů''. Pokud žádné pole takového typu v uživatelsky definované struktuře není, klepnutím na ikonu se přímo vloží klíčové slovo instance do pole Obrázek. V opačném případě se po klepnutí na ikonu zobrazí kontextová nabídka, ve které lze vybrat, do kterého pole se značka má vložit. První možností je pole Obrázek, pak následují další pole uživatelsky definované struktury databáze zpráv typu ''položka databáze zdrojů''.

Samotné vstupní pole typu ''položka databáze zdrojů'' se pak chová tak, že do něj nelze vložit jiná data než klíčové slovo instance. Pokud je při uložení zprávy detekován obsah jiného typu, je z pole odstraněn a uživateli je zobrazeno hlášení upozorňující na tuto skutečnost.

Pro vložení do těla zprávy je třeba nejprve nakopírovat značku do systémové schránky ('''Vložit klíčové slovo pro instanci do schránky'''), pak se ve formuláři přepnout do záložky '''Základní''' a nakopírovat (z klávesnice Ctrl + V) na vhodné místo v textu.

Poslední funkce – vložení klíčového slova pro instanci do těla zprávy – je podporována i ve [[../../WYSIWYG editor|WYSIWYG editoru]]. Postup je následující:

# vyvolejte editor pro tělo zprávy a použijte ikonu pro vkládání instancí:
#:
#:[[Image:referencniprirucka-zdroje-img062.png|center]]
#:
# V dialogu editoru se zobrazí seznam připojených položek, které nejsou připojeny k nějakému seznamu příloh (tj. jsou naopak připojeny pod nějakým stylem pro zdroje). Klepnutím na položku v tomto seznamu se vloží odpovídající klíčové slovo na pozici kurzoru.

[[Image:referencniprirucka-zdroje-img063.png|center]]

Ve WYSIWYG editoru se zobrazují zástupné značky, nikoliv výsledný kód vzniklý aplikací vybraného stylu na instanci – proto je výhodné použít např. vizuální režim pro úpravu zprávy – po uložení obsahu WYSIWYG editoru se v tomto režimu již ukáže přesný výsledek. Značky obsahují název a případně rozměry obrázku. Poklepáním na značku se otevírá dialog pro výběr položky znovu a lze případně jednoduše do daného místa v textu vložit jinou položku.

[[Image:referencniprirucka-zdroje-img064.png|center]]

Pokud odstraníte soubor ze seznamu instancí ke zprávě, značky pro instance v textu zprávy zůstávají. To znamená, že se na daném místě nebude zobrazovat nic, vzhledem k tomu, že se jedná o formu HTML komentářů, nedojde na stránce k žádné chybě.

<div class="note">Tyto značky, které již nic nezobrazují může vyhledávat a vypisovat modul '''Verifikace''' – více naleznete v příručce k tomuto modulu.</div>

=== Úprava pořadí položek v seznamech příloh ===
Je-li soubor připojen k nějakému seznamu příloh, je pořadí zobrazování v prezentační vrstvě dáno primárně definicí příslušného [[../Seznamy#Seznamy příloh|seznamu příloh]] vloženého do [[../Zprávy#Zprávy a předlohy|předlohy pro zprávy]]. Toto pořadí lze explicitně změnit v dialogu zobrazeném po klepnutí na tlačítko '''Upravit pořadí položek''' v záložce '''Zdroje''' formuláře pro zprávy.

[[Image:referencniprirucka-zdroje-poradi-polozek.png|center]]

V rozevírací nabídce v horní části dialogu se vybírá [[../Seznamy#Druhy seznamů příloh|druh seznamu příloh]], ve kterém chceme pořadí položek změnit. Následně se pořadí mění prostým přetažením zobrazených bloků obsahujících nadpis zdroje a název souboru. Změna pořadí se ukládá automaticky ihned po přetažení bloku myší. Pokud se chceme vrátit zpět k výchozímu pořadí danému definicí zobrazování seznamu příloh, použijeme tlačítko '''Reset''' v tomto formuláři.

== Způsob ukládání souborů, veřejná a privátní zóna ==
Soubory mohou být ukládány do veřejné či privátní zóny. Vysvětlení těchto pojmů najdete v kapitole [[../Strom kategorií#Veřejná a privátní zóna|Veřejná a privátní zóna]].

V rámci konfigurace databáze zdrojů lze nakonfigurovat, která zóna se nabízí jako výchozí, zda vůbec uživatelé mohou tuto volbu měnit a dále je zde možnost vynucení způsobu uložení podle stavu zdroje. To znamená, že i když je soubor ukládán do veřejné zóny, bude uložen v úložišti pro privátní zónu do té doby, než bude stav zdroje změněn na ''Publikováno''. Tato poslední volba je zde z toho důvodu, aby bylo možné eventuálně bránit tomu, aby byly stahovány anonymně neschválené a nepublikované soubory z databáze zdrojů.

== Funkce pro zpracování obrázků ==
Databáze zdrojů podporuje možnost vytváření a editace dalších variant obrázků na serveru se zadáním parametrů přes rozhraní prohlížeče. Touto funkcí lze vytvářet bez grafického bitmapového editoru výřezy či zmenšeniny obrázku.

Aby bylo možné funkci použít, musí být splněny tyto předpoklady:

* Je založen zdroj a má master soubor
* ''Master'' soubor je obrázek

Soubory ''master'' a ''náhled'' těmito nástroji nikdy nelze editovat, lze pouze zakládat a editovat další varianty.

Při založení nové varianty se vychází z kopie souboru ''master''. Ta se načte do nového okna prohlížeče, kde jsou k dispozici následující funkce:

* Zmenšování / zvětšování na klientské straně (tedy pouze vizuálně pro lepší možnost výběru
* Možnost vybrat v obrázku obdélníkový region
* Vytvoření výřezu podle vybraného regionu
* Vytvoření výřezu dle zadaných rozměrů
* Otočení obrázku o 90 stupňů
* Vytvoření zmenšeniny podle možností daných administrátorem či podle zadání rozměrů
* Nahrazení editované varianty kopií master souboru (čili jakýsi návrat zpět)
* Možnost definovat umístění souboru v adresářové struktuře a ve veřejné / privátní zóně.

Použití zabudovaného editoru pro obrázky je v zásadě možné ve dvou případech:

# Chceme editovat obrázek, který je již vložen do zdroje. Použijeme funkci '''Upravit obrázek''' u souboru ve zdroji. Tato funkce je dostupná pouze pro soubory, které nejsou označeny jako ''master''.
# Chceme vytvořit novou variantu obrázku – zmenšeninu, ořez apod. Použijeme tlačítko '''Vytvořit novou variantu obrázku'''.

V obou případech se zobrazí editor obrázků podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img065.png|center]]

V horní části okna je informační lišta (velikosti souborů apod.). Je zde rovněž funkce '''Zoom''' – ta umožňuje pouze zvětšit či zmenšit opticky obrázek. Funkce toto provádí pouze na straně klienta a s obrázkem fyzicky nijak nemanipuluje. Je vhodná v případě, že chcete pomocí myši přesněji vytvořit rámeček pro oříznutí.

Dále je k dispozici nabídka '''Akce''', která specifikuje, co se má provést. Jedná se o následující volby:

# '''Zmenšit na předdefinovanou velikost''' – v nabídce vpravo je seznam možných předdefinovaných velikostí, obsah této nabídky se definuje v globálních předvolbách WebToDate.
# '''Zmenšit na zadanou velikost''' – vpravo jsou políčka '''šířka''' a '''výška''', které je třeba vyplnit. Pokud jsou zadány oba rozměry, obrázek se zmenší tak, aby oba zadané rozměry nebyly překročeny a aby byl zachován poměr stran. Lze zadat pouze jeden z rozměrů, pak se druhý automaticky dopočítá opět tak, aby byl zachován poměr stran.
# '''Doostřit''' - provádí doostření obrázku podle zadaných parametrů (poloměr, míra, sigma, práh). Výchozí hodnoty všech těchto parametrů lze nastavit v globálních předvolbách WebToDate.
# '''Vodoznak''' - vkládá do obrázku soubor s vodoznakem, lze zvolit umístění a jas vodoznaku. Seznam souborů, které lze vložit jako vodoznak, se definuje v globálních předvolbách WebToDate, stejně tak v těchto předvolbách lze nastavit výchozí hodnoty pro umístění a jas.
# '''Otočit o 90 stupňů''' – vpravo se vybírá otočení doleva nebo doprava
# '''Oříznout podle výběru''' – pomocí myši vytvořte v náhledu rámeček pro oříznutí a použijte tlačítko '''Provést akci'''.
# '''Oříznout podle výběru se zadánín rozměrů''' – zadejte oba rozměry požadovaného výřezu a klepněte myší na místo v obrázku, kde má být levý horní roh výběru, pak použijte tlačítko '''Provést akci'''.
# '''Nahradit kopií souboru master''' – jedná se o jakýsi návrat zpět, použijte v případě, že jste vytvořili obrázek v nevyhovující podobě.
# '''Návrat k uložené variantě''' - je k dispozici pouze v případě, že se jedná o editaci existující varianty, nikoliv o vytváření nové varianty. Funkce vrací editovaný obrázek zpět k souboru, který je aktuálně uložen jako daná upravovaná varianta, je to tedy jakýsi návrat zpět pro případ, že provedené operace při úpravách obrázku neodpovídají žádoucímu výsledku.

Všechny tyto volby je vždy třeba potvrdit tlačítkem '''Provést akci'''.

Finální potvrzení uložení změn se provádí tlačítkem '''Uložit''' v pravé spodní části okna. Pokud je zároveň zaškrtnuto '''Přidat do výběru''', upravovaný soubor se při uložené zároveň přidá do uživatelského výběru.

Možnosti pro změnu velikosti mají následující vlastnosti:

* Je podporováno pouze zmenšování, nikoliv zvětšování. Pokud zadáte větší rozměry, než má obrázek, žádná akce se neprovede.
* Zmenšování se vždy provádí se zachováním poměrů stran obrázku. Provede se tak, že ani jeden rozměr nesmí ve výsledku přesáhnout požadované rozměry.

Význam parametrů pro funkci '''Doostřit''' je zhruba tento:

* ''Poloměr'' - udává se v obrazových bodech a říká, jak široká oblast kolem hrany bude doostřením zasažena. Jinými slovy v jak široké oblasti kolem hrany se kontrast plynule zvýší podle hodnoty ''Míra''. Musí jít o nezáporné číslo (může být i desetinné).
* ''Míra'' - určuje, jak moc bude hrana zvýrazněna. 100% znamená, že původní kontrast hrany bude zvýšen o 100% (tj. na dvojnásobek). Jedná se o celé nezáporné číslo v procentech (může být i více než 100%).
* ''Sigma'' - směrodatná odchylka Gaussova rozložení, udává se v obrazových bodech. Musí jít o nezáporné číslo (může být i desetinné), musí být menší než ''Poloměr''.
* ''Práh'' - říká, jak velký musí být absolutní rozdíl jasů mezi sousedními body obrazu, aby se považovaly za hranu, a tudíž se zostřily filtrem. Jedná se o celé nezáporné číslo v procentech.

Ve funkci Vodoznak se v prvé řadě vybírá obrázek ze seznamu definovaného v globálních předvolbách, který se má vložit jako vodoznak. Dále se vybírá umístění, které je popsáno jako výběr světových stran, tj. má následující možnosti:

* severozápad
* sever
* severovýchod
* západ
* střed
* východ
* jihozápad
* jih
* jihovýchod

Volba ''jihovýchod'' tedy např. znamená pravý spodní okraj obrázku apod.

Poslední volbou je jas vodoznaku - zadává se jako údaj v procentech v rozsahu 0 až 100%.

<div class="note">'''Poznámka:''' Všechny funkce pro manipulaci s obrázky využívají knihovnu '''ImageMagick''', která musí být na serveru nainstalovaná a v globálních předvolbách správně nakonfigurovaná. Instalace knihovny není ve WebToDate požadována, ale bez této instalace nejsou dostupné funkce pro manipulaci s obrázky ani vytváření náhledů. Více viz instalační příručka k produktu a kapitola [[../Konfigurace WebToDate#Globální konfigurace WebToDate|Globální konfigurace WebToDate]].
Podpora různých formátů a jejich zpracování je opět plně závislé na knihovně '''ImageMagick'''. Doporučujeme pro obrázky, u kterých se bude vytvářet další varianta pomocí těchto nástrojů, používat formát JPEG. Tento formát je podporován velmi dobře a během testování nebyly zjištěny žádné problémy. Naopak bylo zjištěno, že knihovna '''ImageMagick''' nepracuje správně při ořezávání obrázků ve formátu GIF – je ponechán původní rozměr obrázku a oříznuté plochy jsou pouze převedeny na bílou barvu. V těchto případech je vhodnější další variantu obrázku vytvořit v grafickém editoru na klientském počítači a následně ji do zdroje pouze přidat bez úprav na straně serveru.</div>

== Podpora IPTC metadat==
=== IPTC metadata ===
Soubory JPEG mohou obsahovat textová metadata (klíčová slova, popisky, geografické údaje apod.) ve formátu [http://cs.wikipedia.org/wiki/IPTC IPTC]. Těmito metadaty je možno obrázky opatřovat jak v běžně používaných aplikacích pro úpravy obrázků ([http://www.adobe.com/cz/products/photoshop/photoshop/ Adobe Photoshop] apod.), tak v mnoha volně dostupných aplikacích pro prohlížení a jednoduché úpravy obrázků ([http://www.xnview.com XnView] atd.).

Databáze zdrojů WebToDate má vlastní metadata, která se zadávají do příslušných formulářů. Pokud ale již obrázkový soubor je opatřen IPTC informacemi, nabízí se možnost tyto informace převzít, načíst do databáze zdrojů a tak omezit nutnost opakovaného zadávání těchto metadat.

<div class="note">Funkce pro práci s IPTC jsou dostupné jen v instalacích s PHP 5, ve kterých je aktivní PHP extenze GD2.</div>

=== Struktura IPTC polí ===
Následující tabulka definuje mapování IPTC polí na strukturu databáze zdrojů WebToDate. Jsou uvedeny jen ta nejdůležitější pole, do WebToDate se načítají jen ta metadata, která mají uvedeno, do které části struktury zdroje se načítají.

{| class="prettytable"
! IPTC pole
! <b>Kód pole
! Význam
! WebToDate pole
|-
|
Headline
|
<nowiki>#105</nowiki>
|
Titulek obrázku
|
Nadpis
|-
|
Caption
|
<nowiki>#120</nowiki>
|
Popisek
|
Popis
|-
|
Keywords
|
<nowiki>#025</nowiki>
|
Klíčová slova; může jich být i více, pak se pole #025
opakuje několikrát
|
Klíčová slova
|-
|
Category
|
<nowiki>#015</nowiki>
|
Kategorie; 3 znaky dle definice NAARTNDA, pro zpracování
ve WebToDate se nevyužívá
|
|-
|
Supplemental Category
|
<nowiki>#020</nowiki>
|
Vlastní (uživatelem definované) kategorie; libovolné
množství vlastních názvů kategorií, pro zpracování ve WebToDate se nevyužívá
|
|-
|
By-line
|
<nowiki>#080</nowiki>
|
Jméno autora/fotografa
|
Autor
|-
|
By-line Title
|
<nowiki>#085</nowiki>
|
Titul autora/fotografa
|
|-
|
Copyright
|
<nowiki>#116</nowiki>
|
Autorská práva
|
|-
|
Contact
|
<nowiki>#118</nowiki>
|
Kontakt
|
|-
|
Source
|
<nowiki>#115</nowiki>
|
Zdroj
|
|-
|
Credit
|
<nowiki>#110</nowiki>
|
Zprostředkovatel fotografie
|
|-
|
Object Name
|
<nowiki>#005</nowiki>
|
Krátký popis obrázku, může být i jméno souboru
|
|-
|
City
|
<nowiki>#090</nowiki>
|
Místo pořízení: město
|
|-
|
Sublocation
|
<nowiki>#092</nowiki>
|
Místo pořízení: oblast
|
|-
|
Province/State
|
<nowiki>#095</nowiki>
|
Místo pořízení: nejvyšší správní jednotka
|
|-
|
Country Code
|
<nowiki>#100</nowiki>
|
Místo pořízení: kód státu (3 písmena)
|
|-
|
Country Name
|
<nowiki>#101</nowiki>
|
Místo pořízení: stát
|
|-
|
Created Date
|
<nowiki>#055</nowiki>
|
Datum pořízení ve formátu RRRRMMDD
|
|-
|
Created Time
|
<nowiki>#060</nowiki>
|
Čas pořízení ve formátu HHMMSS±HHMM (čas ± posun vůči UTC)
|
|-
|
Release Date
|
<nowiki>#030</nowiki>
|
Datum zveřejnění ve formátu RRRRMMDD
|
|-
|
Release Time
|
<nowiki>#035</nowiki>
|
Čas zveřejnění ve formátu HHMMSS±HHMM (čas ± posun vůči
GMT)
|
|-
|
Priority
|
<nowiki>#010</nowiki>
|
Důležitost: "1" nejvyšší, "5" normální
a "8" nejnižší. Stupeň "9" je určen pro uživatelem
určenou důležitost, "0" je vyhrazena pro budoucí účely
|
|-
|
Special Instructions
|
<nowiki>#040</nowiki>
|
Zvláštní instrukce
|
|}

=== Funkce podporující práci s IPTC ===
==== Zobrazení IPTC master souboru ====
Při otevírání formuláře pro editaci zdroje se zjišťuje, zda master soubor je obrázek typu JPEG a pokud ano, zda má v sobě IPTC informace. Pokud tomu tak je, zobrazí se v záložce '''Položky''' formuláře pro úpravy zdroje vedle tlačítka '''Užití''' ještě tlačítko '''IPTC'''. Tlačítko '''IPTC''' otevírá nové dialogové okno prohlížeče, kde se v režimu pouze pro čtení zobrazují všechny neprázdné IPTC informace uvedené v tabulce [[#Struktura IPTC polí|Struktura IPTC polí]]. Příklad takového zobrazení těchto metadat je na následujícím obrázku.

[[Image:referencniprirucka-zdroje-iptc.gif|center]]

==== Vkládání souboru do existujícího zdroje ====
Volba '''Načíst IPTC popisky''' se aktivuje, pokud je v [[#Přidání nového souboru|dialogu pro vložení nového souboru do zdroje]] vybrán obrázek typu JPEG. Zaškrtávací okénko se nikdy neaktivuje v případě, že zdroj již má master soubor.

V případě, že se tedy vkládá do zdroje obrázek jako master soubor, načte tato funkce příslušná metadata z IPTC obrázku.

==== Zakládání zdrojů z obsahu schránky ====
V dialogovém okně pro [[#Rychlé vytvoření více zdrojů z obsahu schránky |generování zdrojů z obsahu schránky]] je zaškrtávací okénko '''Načíst IPTC popisky'''. Pokud je tato možnost zvolena, berou se příslušné údaje (nadpis, popis, autor, klíčová slova) jako výchozí, která se použijí, jen když obrázek nemá odpovídající IPTC pole (nebo nemá IPTC vůbec), jinak se pro příslušné položky databáze zdrojů použijí IPTC popisky z načítaného souboru. Jde tedy vůbec o nejrychlejší možnost, jak do zdrojů WebToDate uložit více obrázků najednou s kompletními popisky.

==== Přidání souboru ke zprávě ====
V dialogovém okně pro [[../Zprávy#Soubory patřící ke zprávě|přidání souboru ke zprávě]] je opět možné pro obrázky typu JPEG zvolit načtení IPTC, které se použije ve chvíli, kdy je pro obrázek zakládán nový zdroj.

=== Znaková sada IPTC popisků ===
Za výchozí volbu se považuje to, že IPTC popisky mají stejné kódování, jako je nastaveno ve WebToDate. Toto lze explicitně změnit v konfiguračním souboru [[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]] pomocí volitelné konstanty

<code>
<nowiki>define(' ASSETS_IPTC_CHARSET', 'windows-1250' );</nowiki>
</code>

Pokud je hodnota této konstanty jiná než hodnota CHARSET, provádí se před uložením popisku do databáze příslušná konverze do cílové znakové sady.

== Konverze souborů ==
<div class="note">Funkce popsané v této kapitole jsou závislé na instalaci a konfiguraci aplikací ImageMagick pro obrázky resp. FFmpeg pro videa. Nejsou-li tyto aplikace na serveru instalovány či nejsou-li nastaveny cesty k aplikacím v konfiguračním souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'', nejsou funkce pro konverze souborů k dispozici.</div>

=== Konverzní pravidla a funkce ===

Administrátor ve WebToDate může definovat konverzní pravidla a funkce, pomocí kterých lze měnit (konvertovat) obrázky, zvuky a videosekvence vkládané do databáze zdrojů nebo komprimovat soubory do zip archivů. Administrátor definuje seznam těchto konverzních pravidel a funkcí a jejich parametry (z jakého do jakého formátu funkce provádí převod, jaké je cílové rozlišení videa či obrázku apod.). Tato pravidla a funkce pak mohou nebo musí (pokud se jedná o vynucenou automatickou konverzi) používat všichni uživatelé WebToDate.

Terminologie základního rozdělení těchto funkcí je následující:

* ''Konverzní pravidlo'' - předpis pro konverzi, který se aplikuje ve chvíli vkládání souboru do zdroje. Jedná se buď o automaticky aplikované pravidlo, tj. uživatel si při vložení souboru do zdroje nemůže vybrat, jestli chce danou konverzi souboru provést, nebo o volitelnou konverzi, tj. uživatel si může zvolit, jestli chce nebo nechce takovou konverzi provést.
* ''Konverzní funkce'' - funkce se nabízí jako jedna z možností úpravy souboru ve zdroji. Neaplikuje se při vkládání souboru do zdroje, ale následně při úpravě zdroje ji může uživatel explicitně vyvolat a aplikovat na zvolený soubor.

V každém případě si uživatel při práci se zdroji pouze vybírá, zda dané pravidlo či funkci aplikovat na daný soubor, nemůže ovlivňovat parametry, které funkce použije (tj. pozměnit cílové rozměry obrázku či videa, formát apod.).

Všechna pravidla a funkce se odvozují od formátu souboru, tedy vždy jde o předpis typu pokud je formát souboru ten a ten (JPG, FLV, AVI, BMP apod.), musí nebo lze na něj aplikovat takovou a takovou konverzi. Pro jeden souborový formát je možno definovat více pravidel. V takovém případě se aplikují všechna pravidla existující pro daný typ souborů.

Všechna pravidla se vždy vyhodnocují vzhledem ke zpracovávanému souboru. To znamená, že pokud se např. vkládá obrázek s rozměry 1000x1000 a jedno pravidlo říká, že pokud je rozměr větší než 800x800, má se zmenšit na 600x600 a druhé pravidlo říká, že pokud je rozměr větší než 800x800, má se vytvořit jako nová varianta obrázek 200x200, vyhodnotí se obě podmínky vzhledem k původnímu souboru ještě před vlastním spuštěním pravidel a aplikují se obě pravidla.

=== Vytváření pravidel ===

Definovat konverzní pravidla a funkce může pouze administrátor. Přejděte do nabídky '''Administrace''' – '''Konverze souborů''' a v pravém horním rohu okna klikněte na '''Přidat'''.

Nejprve se vybírá druh souborů ke konverzi - může jít o pravidlo pro obrázek, audio, videosekvenci, kompresi do zip formátu nebo o konverzi souboru na externím serveru. Na této volbě závisí nabídka parametrů konverze v dalším kroku, pro jednou uložené pravidlo již nelze změnit volbu toho, na jaký druh souborů se pravidlo vztahuje.

[[Image:referencniprirucka-zdroje-img066.png|center]]

Po použití tlačítka '''Pokračovat''' se zobrazí formulář pro vyplnění parametrů pravidla. Formulář má dvě záložky - '''Základní''' a '''Konverze'''. První záložka '''Základní''' je vždy stejná, obsah druhé záložky závisí na druhu souborů zvoleném v prvním kroku.

[[Image:referencniprirucka-zdroje-img067.png|center]]

Záložka '''Základní''' obsahuje následující pole (vše je nutno povinně vyplnit):

* '''Název''' - název pravidla tak jak se pak bude uživatelům zobrazovat
* '''Pravidlo pro''' - je automaticky vyplněno dle volby v prvním kroku, zde uvedeno pouze pro informaci
* '''Zdrojový formát''' - vybírá se formát souboru, na který lze pravidlo aplikovat. Nabídka je vyplněna těmi formáty, které jsou ve funkci '''Typy souborů''' označeny daným druhem - pokud se tedy vybere, že jde o konverzi pro video, nabízí se zde všechny formáty, které jsou ve funkci '''Typy souborů''' označeny jako ''video'' apod.
* '''Druh''' - vybírá se způsob, jakým se pravidlo aplikuje. Možnosti jsou
** ''Automatická konverze při vložení souboru do zdroje'' - při vložení souboru vybraného formátu do zdroje se aplikuje nastavená konverze bez možnosti tuto konverzi nespustit
** ''Volitelná konverze při vložení souboru do zdroje'' - při vložení souboru vybraného formátu do zdroje se aplikuje nastavená konverze s možností tuto konverzi nespustit
** ''Konverzní funkce spouštěná ručně'' - funkce pro konverzi se nabízí jako možnost úpravy souboru zvoleného formátu uloženého ve zdroji.
* '''Výsledek konverze''' - Jsou možné následující volby:
** ''Změna souboru'' - konvertuje se zvolený soubor, původně vložený soubor (v původním formátu) tedy nikde nezůstává
** ''Nový soubor ve stejném zdroji'' - původní soubor se ukládá do zdroje bez jakékoli změny, výsledkem konverze je nový soubor (nová varianta) ve stejném zdroji jako původní soubor.

Druhá záložka '''Konverze''' je závislá na zvoleném druhu souborů.

[[Image:referencniprirucka-zdroje-img068.png|center]]

Pro obrázky obsahuje záložka '''Konverze''' sekce '''Podmínky konverze''' a '''Formát výstupního souboru'''. Nastavení v sekci '''Podmínky konverze''' se používá tak, že pravidlo se aplikuje v případě, že alespoň jedna podmínka je splněna; pro konverzní funkce se podmínky konverze nepoužijí. Nastavuje se zde:

* '''Velikost souboru je větší než''' - pravidlo se aplikuje, pokud je soubor větší než zadaná hodnota v kB
* '''Maximální rozměry jsou větší než''' - pravidlo se aplikuje, pokud je překročen alespoň jeden rozměr (v obrazových bodech)
* '''Komprese je větší než''' - pravidlo se aplikuje, pokud je komprese souboru větší než zadaný údaj v procentech

V sekci '''Formát výstupního souboru''' se specifikují požadované výstupní parametry výsledného souboru. Jde o následující volby:

* '''Formát''' - vybírá se z rozevírací nabídky cílový typ souboru, obsahem nabídky jsou formáty souborů pro obrázky
* '''Komprese''' - zadává se cílová komprese v procentech
* '''Maximální rozměry''' - cílové maximální rozměry obrázku
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají funkci ''convert'' aplikace ImageMagick tak, jak jsou zde zadány bez dalších úprav. Seznam možných parametrů je na stránce [http://www.imagemagick.org/script/convert.php http://www.imagemagick.org/script/convert.php ]projektu. Tedy např. zadáním řetězce ''"-contrast"'' se předává parametr pro zvýšení kontrastu fotografie apod.

Pro videa se v záložce '''Konverze''' vyplňuje pouze formát výstupního souboru.

[[Image:referencniprirucka-zdroje-img069.png|center]]

Jde o následující volby:

* '''Formát''' - volí se buď formát videa, nebo možnost vytvoření jednoho snímku ze sekvence ve formátu JPEG (tato volba je vhodná pro generování statických náhledů pro publikované videosoubory použitelných v prezentační části).
* '''Kvalita''' - lze zvolit buď ''Automaticky'' (konverzní aplikace sama volí nejvhodnější nastavení) ''nebo Jako u originálu'' (konverzní aplikaci se předá požadavek na zachování kvality podobné původní videosekvenci).
* '''Maximální rozměry''' - maximální šířka a výška výsledné videosekvence
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají konverzní aplikaci '''FFmpeg''' tak, jak jsou zde zadány, seznam možných parametrů je na [http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html]. Pomocí těchto parametrů lze explicitně nastavit kodeky pro audio i video, samplovací frekvence apod.

<div class="note">Pro zadávání složitějších parametrů pro konverzi videa doporučujeme nejprve stáhnout aplikaci FFmpeg na lokální disk a odladit všechny parametry konverze na samostatném počítači - proces zpravidla vyžaduje několikanásobné opakování s různými parametry a posouzení výsledku (přehrání výsledného videa), což na webovém serveru není příliš vhodné provádět.</div>

Pro audia se v záložce '''Konverze''' vyplňuje pouze formát výstupního souboru.

[[Image:referencniprirucka-zdroje-img070.png|center]]

Jde o následující volby:

* '''Formát''' - volí se jeden z formátů, který je v typech souborů označen jako audio nebo video
* '''Bitrate''' - zadává se, pokud má jít o konstantní datový tok v bit/s. Je povolen zápis se znakem "k" na konci, čili hodnoty "128000" a "128k" jsou ekvivalentní.
* '''Kvalita''' - zadává se požadovaná kvalita v případě, že má jít o proměnlivý datový tok (VBR). Interpretace parametru závisí na formátu, např. pro formát ''ogg vorbis'' hodnota 60 odpovídá průměrnému bitrate 160 kbit/s apod.
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají konverzní aplikaci '''FFmpeg''' tak, jak jsou zde zadány, seznam možných parametrů je na [http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html]. Pomocí těchto parametrů lze explicitně nastavit např. kodeky apod. Např. -''acodec libmp3lame'' vynutí použití kodeku LAME pro mp3, ''-ar 22050'' vynutí samplovací frekvenci 22050 Hz apod.

<div class="note">Poznámka: Seznam podporovaných audio kodeků je na adrese http://ffmpeg.mplayerhq.hu/general.html#SEC7, na vstupu je podporováno několik desítek zvukových formátů, na výstupu jsou z běžně používaných formátů podporovány AAC, FLAC, MP3, OGG, WMA (FLV používá pro zvukovou stopu MP3 kodek)</div>

Pro kompresi do formátu zip se v záložce '''Konverze''' vyplňují pouze podmínky konverze.

[[Image:referencniprirucka-zdroje-img071.png|center]]

Nastavuje se zde:

* '''Velikost souboru je větší než''' - pravidlo se aplikuje, pokud je soubor větší než zadaná hodnota v kB

<div class="note">Možnost vytvářet pravidla pro kompresi do zip formátu je dostupná pouze v případě, že aplikace WebToDate je instalována na serveru, na kterém je provozováno PHP verze 5 s podporou práce se zip archivy (např. na platformě MS Windows PHP extenze php_zip.dll). Na instalaci s PHP 4 není tato funkce k dispozici.</div>

=== Spouštění konverzních pravidel ===

Při vložení souboru do zdroje se vyhodnocuje, zda pro vkládaný formát souboru existuje nějaké konverzní pravidlo a pokud ano, zda jsou splněny podmínky pro konverzi definované v pravidle (např. rozměry obrázku přesahují definovanou velikost apod.). Pokud je zjištěno, že existuje alespoň jedno relevantní pravidlo, zobrazí se dialog pro potvrzení konverze.

[[Image:referencniprirucka-zdroje-img072.png|center]]

V dialogu se vypíše seznam relevantních pravidel. Pravidla, která jsou volitelná, mají vedle názvu zaškrtávací okénko, kterým lze zvolit, zda se konverzní pravidlo aplikuje. Automaticky spouštěná pravidla tuto volbu nemají. Tlačítko '''OK''' spouští postupně všechna pravidla. Tlačítko '''Storno''' stornuje proces konverze. Platí zde následující:

* Pokud jsou všechna nabízená pravidla pouze volitelná a použije se '''Storno''', vloží se do zdroje původní nekonvertovaný soubor.
* Pokud je alespoň jedno nabízené pravidlo automatické a použije se '''Storno''', žádné konverze se neprovádějí, ale zároveň se do zdroje žádný soubor nevkládá - původní soubor se ze serveru smaže a zdroj zůstává beze změny.

=== Spouštění konverzních funkcí ===

Ikona '''Úprava vlastností souboru''' ve formuláři pro úpravy zdroje vyvolává následující dialog. Pokud existuje alespoň jedna konverzní funkce pro daný formát souboru, zobrazí se v dialogu tlačítko '''Konvertovat'''.

[[Image:referencniprirucka-zdroje-img073.png|center]]

Tlačítko '''Konvertovat''' zobrazí dialog pro výběr a spuštění konverzní funkce. Na rozdíl od pravidel konverze se takto spouští vždy právě jedna konverzní funkce, která se vybírá radiopřepínačem.

[[Image:referencniprirucka-zdroje-img074.png|center]]

Tlačítko '''OK''' spouští zvolenou konverzní funkci, tlačítko '''Storno''' ruší volbu a soubor ve zdroji zůstává beze změny.

=== Externí konverze ===

V praxi může nastat případ, kdy je požadována konverze videosouborů, která má negativní vliv na výkonnost webového serveru (konvertují se dlouhá videa, velké množství videosouborů apod.). V takovém případě je možné nasadit konverzi na externím serveru. Princip je znázorněn na následujícím diagramu.

[[Image:referencniprirucka-zdroje-img075.png|center]]

Na externím serveru musí být nadefinovány dva adresáře:

* Vstupní adresář, do kterého se kopírují soubory, které se mají konvertovat
* Výstupní adresář, do kterého aplikace na externím serveru umístí výsledek konverze a ze kterého si konverzní funkce WebToDate tento výsledek stáhne.

Ve chvíli spuštění pravidla se soubor kopíruje do vstupního adresáře externího serveru. Na tomto serveru se pomocí procesu cron v pravidelných intervalech kontroluje obsah adresáře. Pokud je zjištěn soubor očekávaného typu, spustí se pomocí shell skriptu konverzní proces, který uloží výsledek do výstupního adresáře a vstupní soubor smaže.

Po zkopírování vstupního souboru na externí server PHP skript v pravidelných intervalech kontroluje výstupní adresář externího serveru. Ve chvíli, kdy zde nalezne zkonvertovaný soubor, jej stáhne a vloží do zdroje, který se zpracovává.

Externímu zdroji se nepředávají žádné parametry konverze. Pokud je třeba konverzi nějak parametrizovat (např. vytvořit jedno pravidlo pro konverzi do původního rozměru videa a jedno pravidlo pro konverzi do polovičního rozměru), založí se dva vstupní a dva výstupní adresáře - do jednoho vstupního adresáře jdou videa, která se mají zkonvertovat do původní velikosti, do druhého videa, která se mají zkonvertovat do poloviční velikosti atd.

<div class="note">Skripty či aplikace, které spouštějí konverzi na externím serveru, nejsou součástí dodávky WebToDate, toto je třeba zajistit individuálně dle požadavků toho kterého řešení.</div>

Při volbě této možnost konverze má záložka '''Konverze''' následující podobu:

[[Image:referencniprirucka-zdroje-img076.png|center]]

* '''Koncovka výstupního souboru''' - výběr formátu souboru (koncovky), který je očekáván ve výstupním adresáři
* '''Vstupní adresář''' - plná cesta k adresáři, kam se kopíruje soubor ke konverzi
* '''Výstupní adresář''' - plná cesta k adresáři, odkud se stahují zkonvertované soubory
* '''Timeout''' - timeout v sekundách, po tuto dobu PHP skript čeká, zda se ve výstupním adresáři objeví zkonvertovaný souboru

Z hlediska zpracování na serveru s WebToDate je postup následující:

# Dojde k uploadu zdrojového souboru běžným způsobem a vyhodnocení pravidel
# Spuštěné pravidlo nejprve kopíruje soubor pod náhodným unikátním jménem do vstupního adresáře konverze. Vkládaný soubor ''video1.avi'' se tedy kopíruje pod jménem např. ''10675455.avi''.
# Po nakopírování se v cyklu kontroluje výstupní adresář, hledá se soubor ''10675455.flv'' (tedy stejná jméno, ale koncovka dle nastavení parametrů pravidla).
# Kontrola se provádí po dobu daného nastavením timeoutu; pokud je doba překročena, vloží se do zdroje původní nekonvertovaný soubor
# Pokud vše proběhne v pořádku, je přesunut soubor ''10675455.flv'' na odpovídající místo na serveru WebToDate, přejmenován na cílové jméno (tomto příkladu ''video1.flv'') a vložen do zdroje.

Z hlediska externího serveru je třeba pro každé nasazení adhoc vytvořit konverzní shell skript spouštěný z cronu. V případě video souborů bude '''FFmpeg''' instalován i na cílový server a skript bude používat tuto aplikaci pro konverzi. Parametry pro '''FFmpeg''' budou vždy pevně dané a z vnějšku nejsou ovlivnitelné (nebo případně logika bude uložena přímo v tomto skriptu - např. pokud video přesahuje nějaké rozměry, zmenšit na zvolenou velikost apod.).

Doporučujeme, aby tento skript pro shell zajistil následující:

* Provedl vlastní konverzi
* Odstranil původní soubor ze vstupního adresáře
* Umístil výstupní soubor do cílového adresáře
* Mazal z cílového adresáře staré soubory (např. starší než jeden den), které mohly vzniknout tak, že na serveru WebToDate nastal timeout, přestože konverze proběhla v pořádku, ale trvala pouze příliš dlouho
* Vytvářel jednoduchý protokol pro hledání případných problémů

== Výměna souboru ve zdroji ==
V praxi se lze potkat s potřebou výměny souboru (např. obrázku či dokumentu ke stažení) za jiný, přičemž daný soubor je již použit v několika různých instancích ve zprávách. Můžeme mít např. ceník v PDF souboru, na nějž vedou odkazy z různých částí webu, tj. je připojen k více různým zprávám. Bez přímé podpory výměny tohoto souboru by bylo nutné odstranit všechna připojení ke všem zprávám, pak buď vyměnit soubor v existujícím zdroji, nebo přidat nový zdroj s novou podobou ceníku a pak tento zdroj ke všem zmíněným zprávám zase připojit, celkově by šlo o časově náročnou ruční práci.

V tomto příkladu si navíc lze představit dva typy požadavků:

# Jde skutečně o pouhou výměnu souboru – stará verze ceníku již není nikde potřeba a může se na webové prezentaci přepsat novou podobou.
# Jde o umístění nové verze ceníku na stejných místech na webové prezentaci, jako byla umístěna předchozí verze, ale původní verzi potřebujeme zachovat, buď pouze v databázi zdrojů WebToDate pro interní účely, nebo v nějaké stránce veřejně přístupné prezentace zobrazující nějaký archív dokumentů.

Obě tyto možnosti jsou podporovány, jedná se buď o fyzickou výměnu jednoho souboru ve vybraném zdroji, nebo o zachování původního souboru a přidání nového, na který jsou přesměrovány všechny existující instance původního souboru, tj. všechny odkazy ve zprávách, které původně vedly na starý soubor nyní vedou na nový soubor, ale původní soubor je uchován v databázi zdrojů, přičemž se může nacházet buď ve stejném zdroji jako původní soubor nebo v jiném.

Fyzická výměna souborů se provádí tlačítkem '''Vyměnit tento soubor''' v dialogu ''Úprava vlastnosti souboru'' (vyvolá se z formuláře pro úpravu zdroje v záložce '''Položky''' ikonou v řádku daného souboru).

[[Image:referencniprirucka-zdroje-img077.png|center]]

Použití tohoto tlačítka vyvolá nejprve funkci pro kontrolu možnosti výměny tohoto souboru. Soubor nelze vyměnit z hlediska přístupových práv v následujících případech:

* Soubor je připojen k alespoň jedné zprávě, ke které uživatel nemá přístup z hlediska týmů a rolí. To znamená, že buď zpráva patří týmu, jehož není uživatel členem, nebo zprávu nemůže modifikovat, protože je v daném týmu pouze redaktorem a zpráva je v takovém stavu, kdy ji redaktor modifikovat nemůže.
* Zpráva je uzamčena a má ji uzamčenu někdo jiný než aktuálně přihlášený uživatel.

Člen týmu ''Administrátoři'' může vyměnit soubor vždy.

Pokud tato kontrola zjistí, že soubor vyměnit nelze, zobrazí se chybové hlášení a výměna je odmítnuta jako celek, v opačném případě se zobrazí okno pro výběr souboru. Tento dialog je podobný dialogu pro přidání souboru do zdroje, chybí pouze část, ve které lze definovat umístění (adresář, název souboru) – soubor se nahrazuje, bude tedy umístěn do stejného adresáře pod stejným jménem jako původní soubor. Cílový soubor lze tedy vybrat z lokálního disku nebo ze schránky.

[[Image:referencniprirucka-zdroje-img078.png|center]]

Po výběru souboru se navíc kontroluje jeho typ. Není dovoleno vyměnit soubor za jiný typ (ani administrátorovi). Pokud je zjištěno, že uživatel vybral soubor jiného typu, opět je zobrazeno chybové hlášení "Při výměně souborů lze měnit pouze soubory stejného typu." a operace se neprovede. Dopadnou-li všechny kontroly dobře, je následně soubor nahrazen, pokud se nahrazuje varianta ''master'', může dojít k přegenerování interního náhledu a nakonec se zobrazí potvrzení o provedení záměny souboru.

Druhou možností je přesměrování instancí. V tomto případě se žádný soubor fyzicky nepřepisuje, ale všechny odkazy ze zpráv směřující na daný soubor se touto funkcí zamění na odkazy na jiný soubor, který je ve stejném nebo v jiném zdroji. Přesměrování instancí na jiný soubor se provádí takto:

* Nejprve se nový soubor vloží do databáze zdrojů, je jedno, zda se jedná o nový zdroj nebo stávající zdroj.
* V původním zdroji se vyvolá funkce '''Užití'''. Tato funkce obsahuje informace nejen o zprávách, ve kterých jsou soubory z daného zdroje použity, ale i o tom, který soubor ve které zprávě je použit, aby bylo jasné, čeho se výměna týká.
* Z okna '''Užití''' se vyvolá funkce pro přesměrování instancí. Zde se musí určit, instance kterého souboru v daném zdroji se mají nahradit (výběrem jedné z variant v tomto zdroji) a na který soubor mají po náhradě ukazovat. Je to možné buď zadáním ID souboru, nebo lze nastavit, že se jedná o soubor umístěný v uživatelském výběru, to ovšem za předpokladu, že ve výběru je právě jeden soubor. Pro uživatele je tedy jednodušší po vložení nového souboru do databáze zdrojů tento soubor přidat do výběru.
* Přesměrování se provádí na rozdíl od funkce pro fyzickou výměnu souboru postupně. Opět se vyhodnocují přístupová práva ke zprávě, pokud uživatel nemá práva danou zprávu měnit, pro tuto zprávu se instance nemění a pokračuje se na další zprávu. Může tedy dojít pouze k částečné výměně, a to u těch zpráv, u kterých uživatel výměnu provést může. Nekontroluje se zde typ, lze vyměnit jeden typ souboru (resp. odkaz na soubor z dané instance) za jiný.
* Zobrazí se detailní výpis informující o tom, které instance změněny byly a které eventuálně ne.

V prvním kroku je tedy třeba stanovit cílový soubor, na který se mají odkazy přesměrovat. Nejjednodušší je umístit tento soubor do uživatelského výběru, aby tato možnost byla použitelná, musí být do výběru vložen právě jeden soubor. Druhou možností je zapamatovat si ID souboru, toto ID se zobrazuje např. v záložce '''Položky''' formuláře pro úpravu zdrojů ve sloupci '''ID''' seznamu souborů ve zdroji.

Ve druhém kroku se přejde do formuláře pro úpravu zdroje, kde se nachází soubor, který je aktuálně připojen k nějakým zprávám, a instance ukazující na tento soubor chceme přesměrovat na jiný vybraný v předchozím kroku. Zde se použije tlačítko '''Užití''', zobrazí se následující dialogové okno.

[[Image:referencniprirucka-zdroje-img079.png|center]]

V horní části se zobrazí seznam položek z tohoto zdroje a seznam zpráv, kde je každá položka použita. Tučně je vyznačen soubor a základní informace o něm, pod ním se vždy nachází seznam zpráv, kde je daná položka použita. Klepnutím na název zprávy zde lze přejít do formuláře pro úpravu vybrané zprávy.

Ve spodní části okna jsou pak prvky, kterými lze nadefinovat popisované přesměrování odkazů. Nejprve se v rozevírací nabídce '''Soubor z tohoto zdroje''' vybere jeden ze souborů v aktuálně otevřeném zdroji, jehož existující instance chceme přesměrovat na jiný soubor. Dále se v radiopřepínači '''Změnit na''' vybere cílový soubor. Pokud je v uživatelském výběru právě jeden soubor, je aktivní možnost '''Soubor ve výběru''', v opačném případě je třeba vyplnit pole '''Soubor s ID'''.

Spuštění procesu přesměrování instancí se provede tlačítkem '''Změnit'''. V okně se začne vypisovat průběh funkce pro záměnu odkazů.

[[Image:referencniprirucka-zdroje-img080.png|center]]

Záměna je provázena vyhodnocováním přístupu ke zprávě stejně jako u funkce pro výměnu souboru ve zdroji, tj. uživatel musí mít ke zprávě přístup pro změny, zpráva nesmí být zamčená jiným uživatelem atd. Přístup se vyhodnocuje u každé zprávy zvlášť, vypisuje se nadpis zprávy a vedle toho buď text "Provedeno" nebo "Přístup odmítnut". Klepnutím na nadpis zprávy v tomto výpisu lze přejít na formulář pro editaci této zprávy, tlačítkem '''OK''' se výpis uzavírá.

Tato funkce povoluje přesměrování instancí na jiný typ souboru a jak je z výše uvedeného patrné, může dojít i k částečné záměně pouze tam, kde má uživatel přístup. Funkci lze vyvolat tlačítkem '''Užití''' i ze zdroje, který není uzamčen, protože s vlastními daty zdroje tato funkce nijak nemanipuluje.

== Změna master souboru ve zdroji ==
Pokud je ve zdroji více souborů, právě jeden z nich je vždy označen jako master. V rámci jednoho zdroje lze eventuálně vybrat jiný soubor ve zdroji a označit jej jako master. Funkce (bez dalšího potvrzování) označí daný soubor jako master daného zdroje a původní master "přesune" na jeho místo. Žádný soubor při tom nemění URL ani interní ID souboru.

Změna master souboru zdroje se provádí tlačítkem '''Označit jako master''' v dialogu ''Úprava vlastnosti souboru'' (vyvolá se z formuláře pro úpravu zdroje v záložce '''Položky''' ikonou v řádku daného souboru). Tlačítko je v dialogu jen v případě, že není tento dialog právě otevřen pro master soubor.

== Postup při publikování souborů a další doporučení ==
=== Doporučený pracovní postup ===

Doporučený nejméně pracný postup při vytváření zprávy, která pracuje s jedním nebo několika soubory je následující:

# Vložte soubory patřící ke zprávě do databáze zdrojů (pokud se tam ještě nenacházejí)
# V databázi zdrojů naplňte uživatelský výběr tak, aby obsahoval všechny soubory, které mají patřit ke zprávě.
# Založte zprávu, vytvořte její text, opatřete ji metadaty apod.
# Připojte výběr souborů ke zprávě, všechny soubory připojte v jednom kroku
# Otevřete tělo zprávy v zabudovaném celostránkovém editoru a na příslušná místa v textu vložte pomocí metody táhni a pusť instance (nejčastěji půjde o obrázky v těle textu zprávy)

Pokud chcete do databáze zdrojů vložit více obrázků najednou a ty pak použít v nějaké zprávě jako fotogalerii, přílohy či jednotlivé fotografie v textu, využijte možnosti hromadného vložení více souborů do zdrojů z uživatelské schránky.

=== Kdy je vhodné do jednoho zdroje vložit více položek ===

Nevkládejte do jednoho zdroje soubory, které k sobě nijak nepatří. Tato možnost je vhodná v následujících případech:

# Chceme dát k dispozici ke stažení stejný dokument, ale v různých formátech (MS Word, PDF, ZIP apod.). Tyto různé formáty je vhodné vložit do jednoho zdroje, vzhledem k tomu, že se jedná o stejný dokument by se na něj stejně měla vztahovat identická metadata apod.
# Chceme vytvořit více variant stejného obrázku. Typicky se jako ''master'' varianta vloží obrázek v tom nejvyšším rozlišení (resp. rozměrech), které chceme použít a následně se vytvářejí výřezy či zmenšeniny.

Výřezy a zmenšeniny není nutné vytvářet zabudovaným editorem, je možné si je připravit i na straně klienta v kvalitním bitmapovém editoru a následně do zdroje uložit. Zde ale nezapomeňte, že pro tento případ musí být v globálních předvolbách povoleno ukládat do zdroje více než jeden soubor.

=== Kdy je vhodné vytvořit ve zprávě více instancí souborů z jednoho zdroje ===

Vkládání více souborů ze stejného zdroje k jedné zprávě nebo dokonce více instancí stejného souboru se v podstatě kryje s předchozí kapitolou.

<code>
<nowiki>'''Příklad''': chceme v upoutávce zprávy zobrazit malý náhled a v těle zprávy větší obrázek. V jednom zdroji vytvoříme dvě varianty – jako master uložíme větší
obrázek a následně vytvoříme jako druhou variantu zmenšeninu. Oba tyto soubory dáme do uživatelského výběru a připojíme ke zprávě, každý pod jiným stylem (jeden styl bude pro
zobrazení obrázku jako upoutávky, druhý pro obrázek v textu).</nowiki>
</code>

Můžeme potřebovat i připojení stejného souboru dvakrát. Pokud např. chceme připojit ke zprávě PDF soubor a zobrazit jej jak v seznamu souborů ke stažení, tak jako odkaz uprostřed textu zprávy, je potřeba vytvořit dvě instance stejného souboru, jednu připojit k danému druhu seznamu, druhou pod vhodným stylem a klíčové slovo této druhé instance vložit do textu zprávy.

== Možnosti konfigurace databáze zdrojů ==
=== Globální konfigurace ===

Možnosti globální konfigurace databáze zdrojů ve WebToDate jsou shrnuty v následující tabulce.

{| class="prettytable"
| Konfigurace konverzní aplikace '''ImageMagick'''
| Pro nastavení vytváření náhledů jsou k dispozici následující volby:

*Vytvářet náhledy k obrázkům
*Maximální šířka a výška náhledu
*Cesta k adresáři s konverzní aplikací
*Vynucení stupně JPEG komprese pro náhledy obrázků

Dále je k dispozici konstanta pro seznam předdefinovaných velikostí obrázků používaná při vytváření nových variant obrázků a konstanta se seznamem URL obrázků, které lze vkládat jako vodoznak.
Několika konstantami lze nastavit výchozí hodnoty pro všechny parametry funkcí '''Doostřit''' a '''Vodoznak'''.

|-
| Konfigurace konverzní aplikace '''FFmpeg'''
| Nastavuje se cesta ke konverzní aplikaci pro videa a konstanta definující, ze kterého snímku videosekvence se vytváří náhledy (např. z páté sekundy videosekvencí)

|-
| Ukládání souborů
| Pro nastavení způsobu ukládání souborů lze nastavit následující volby:

*Způsob sestavení výchozí cesty pro uložení souboru
*Ukládání souborů fyzicky do databáze
*Způsob práce se jmény souborů (řešení duplicitních jmen apod.)
*Režim ukládání do privátní zóny (která zóna je výchozí a zda vůbec nabízet druhou z možností)
*Vynucovat umístění podle stavu zdroje (pokud je zapnuto a zdroj není ve stavu ''Publikováno'', soubory jsou v privátní zóně nezávisle na tom, jaké umístění je v souboru zvoleno).
*Možnost povolit publikování zdrojů i redaktorům
*Lze povolit nebo zakázat ukládání více než jednoho souboru do zdroje

|-
| FTP přístup ke schránce
| Lze nastavit adresu FTP serveru pro přístup ke schránce.

|-
| Funkce '''Obrázky'''
| Lze zvolit, zda je funkce '''Obrázky''' přístupná pouze administrátorům nebo všem.

|}

Podrobný popis konfiguračních konstant naleznete v kapitole [[../Konfigurace WebToDate#Globální konfigurace WebToDate|Globální konfigurace WebToDate]].

=== Typy souborů ===

WebToDate po instalaci obsahuje seznam rozeznávaných typů souborů, jejich ikon a povolených akcí. Typ souboru se rozeznává podle koncovky, podle rozpoznaného typu se určuje:

* Zda se jedná o obrázek, audio nebo videosekvenci v podporovaném formátu a je možné na něj aplikovat obrázkové operace (vytvořit náhled apod.)
* Pokud není možné vytvořit náhled, tak jaká ikona se pro tento obrázek zvolí.
* Jaký MIME typ se eventuálně posílá do prohlížeče (v případě, že se soubor zobrazuje přes prezentační skript a ne přímo).

Změny nastavení lze provádět pomocí funkce '''Administrace''' - '''Typy souborů'''. Po vyvolání této funkce se zobrazí v pravém horním rámci prohlížeče seznam typů daných koncovkami, po klepnutí na název koncovky lze měnit nastavení pro daný typ souboru.

[[Image:referencniprirucka-zdroje-img081.png|center]]

Definuje se zde:

* '''Typ souboru''' - koncovka souboru (malými písmeny)
* '''Druh souboru''' - volba ''obecný'' / ''obrázek'' / ''video'' / ''audio''. Pro typ ''obrázek'' se vytvářejí náhledy, nabízí se konverzní funkce a možnost úprav přes funkci pro zpracování obrázků. Pro typ video se vytvářejí náhledy a nabízí se konverzní funkce. Pro typ ''obecný'' nejsou k dispozici žádné speciální funkce a v seznamu zdrojů se takové soubory prezentují ikonou a nikoli náhledem.
* '''MIME typ''' - nastavení MIME pro daný typ souboru (např. ''application/pdf'' pro PDF soubory apod.)
* '''Soubor s ikonou''' - název souboru s ikonou, která se zobrazuje v redakčním rozhraní v případě, že pro soubor není možné vytvořit náhled.

Odpovídající ikony pro soubory, na které se odkazuje pole '''Soubor s ikonou''' formuláře pro úpravu typu souboru, se nacházejí v adresáři ''offlinedata/assetsicons'' - do tohoto adresáře si můžete v případě potřeby doplnit vlastní ikony.

<div class="note">Poznámka: Pro soubory s koncovkou ''swf'' je speciálně spouštěna funkce pro zjištění rozměrů nezávisle na nastavení konfigurace typů souborů.</div>

=== Konfigurace FTP přístupu ke schránce ===

Pomocí FTP přístupu lze obsah schránky libovolně měnit. Aby byl FTP přístup funkční, musí se správně nakonfigurovat FTP server a konstanta ''ASSETS_USERS_FTP_ACCESS''. Pokud je tato konstanta neprázdná, je aktivní tlačítko '''FTP přístup ke schránce''' v dialogovém okně pro zobrazení obsahu schránky. Tlačítko otevírá nové okno prohlížeče na příslušné ftp adrese.

V tomto okně pak lze manipulovat se soubory ve schránce pomocí rozhraní, které k tomu poskytuje prohlížeč Internet Explorer, tedy metodou táhni a pusť vkládat více souborů z lokálního disku nebo naopak více souborů najednou ze schránky mazat.

<div class="note">Z bezpečnostních důvodů je vhodné nastavit přístupová práva pro každého uživatele zvlášť a to na úrovni OS serveru (resp.FTP serveru), každý uživatel pak musí dostat další uživatelský účet a heslo pro tento ftp přístup. FTP adresa musí být taková, že směřuje na adresář ''offlinedata/assets/users''/.'' V tomto adrtesáři se nacházejí schránky jednotlivých uživatelů, pro každý podadresář zde tudíž budete musit nastavit zvláští přístup přes FTP server.
'''Nikdy pro tyto účely nepoužívejte anonymní ftp server, jednalo by se o mimořádné bezpečnostní riziko.'''</div>

Je možné pro všechny uživatele použít i stejný účet. Konfigurační konstantu lze pak nastavit na tvar

<code>
<nowiki>ftp://uz_jmeno:heslo@ftp.nasserver.cz/</nowiki>
</code>

Přístup ke schránkám je pak funkční, protože aplikace WebToDate pro každého uživatele doplní jeho cestu k jeho vlastní schránce, uživatelé se navíc nemusejí znovu přihlašovat. Nevýhodou ovšem je, že heslo je pak uvedeno v HTML kódu stránky (i když se jedná o redakční rozhraní veřejně nepřístupné) a uživatel WebToDate může teoreticky (přes jinou aplikaci pro ftp přístup) vstoupit do schránky jiného uživatele.

Soubor:Referencniprirucka-zdroje-img055.png

2019-08-30T07:32:59Z

Jardac: Jardac načtena nová verze "Soubor:Referencniprirucka-zdroje-img055.png"

[[Category:WebToDate Referenční]]
Referenční - Zdroje, uživatelská schránka

WebToDate/Referenční/Zdroje

2019-08-30T07:28:50Z

Jardac: /* Přidání nového souboru - multiupload */

[[Category:WebToDate Referenční]]
[[Category:Referenční]]
== Co jsou zdroje ==
Drtivá většina webových prezentací se neskládá jen z textových informací ve formě HTML stránek, ale i většího množství souborů v nejrůznějších formátech. Může jít o grafiku vloženou do textu (obrázky zpravidla ve formátech JPEG, GIF či PNG, flash animace apod.), častá je i nabídka nejrůznějších souborů ke stažení (PDF dokumenty, ceníky ve formátech XLS či DBF atd.).

Databáze zdrojů zavedená od verze WebToDate 4.0 zásadním způsobem rozšiřuje možnosti správy souborů v jiných než značkovacích formátech (HTML, XML apod.). Jedná se o databázové úložiště souborů v libovolných formátech (obrázků, PDF, ….), které slouží jako sklad objektů použitelných na jednotlivých stránkách a to buď přímým vložením do stránky (typicky obrázky) nebo jako odkazy na soubory (typicky třeba stažení příloh ve formátu PDF). Cíle této funkce jsou:

* Mít k dispozici databázově organizované úložiště externích souborů, tj. kromě vlastních souborů mít k dispozici prohledávatelná metadata (název, popis, formát, klíčová slova, datum vložení, autor,…)
* Přiřazovat tyto záznamy ke zprávám tak, aby bylo možno zobrazit seznam přiřazených položek (např. seznam odkazů na PDF soubory) včetně omezení na určité typy (odděleně seznam PDF, MS Word souborů apod.). Jeden soubor může být použit vícekrát.
* Vkládat objekty z této databáze do zpráv (do těla, do jednotlivých polí, týká se hlavně obrázků, flash animací apod.)
* Volitelně zajistit možnost stahování podle přístupových práv a ne pouze všem anonymním uživatelům, tedy aby např. externí soubor nebylo možno stáhnout přímo (např. pouze pro registrované uživatele)
* Zajistit možnost publikace a expirace v určitý čas
* Vytvořit možnost vytvářet katalogy zobrazitelné automaticky i z veřejné části (funkce fotoalbum)
* Mít možnost základních operací s obrázky na serveru, obrázkové soubory v administračním rozhraní zobrazovat ve formě náhledů
* Zaručit konzistenci dané webové prezentace z hlediska odkazů na soubory – databáze zdrojů brání tomu, aby bylo např. možné odstranit obrázek, který je někde použitý apod.

Z hlediska uživatele se úložiště souborů jeví tak, že ukládá soubory do stromové struktury kategorií podobným způsobem jako zprávy či fragmenty. Položky souborového archívu se nazývají '''zdroje'''. Objekt "zdroj" má následující vlastnosti:

* Metadata – k souborům lze vložit řadu metadat, která jsou ekvivalentní s metadaty zpráv, např. nadpis, popis, data (vložení, aktualizace, platnosti), autor, klíčová slova apod.
* Položky – každý zdroj má jeden nebo více souborů, tj. variant daného souboru a "technických" informací o nich. Např. jeden obrázek může být uložen ve více variantách (originální obrázek, zmenšený obrázek, náhled, výřez apod.), ke každé variantě jsou k dispozici v databázi údaje jako rozměry, velikost, URL apod. Všechny variantu souborů sdílejí v rámci zdroje společná metadata. Položkou nemusí být jen soubor fyzicky umístěný na serveru, ale i libovolné URL směřující dovnitř dané prezentace i na jiný server.
* Vlastnosti v rámci workflow – každý zdroj má stejně jako zprávy stav a příznak uzamčení / odemčení. Přístup k nim podléhá přístupovým právům podobně jako u zpráv.

Primárním nástrojem publikování souborů na veřejné části je pak přiřazování ke zprávám, tj. vytváření tzv. instancí. Instance je přiřazení položky z daného zdroje ke zprávě, instance má dále vlastnosti specifikující její grafickou podobu ve zprávě, tj. buď WebToDate styl formátující tuto instanci nebo příslušnost k seznamu souborů (příloh), kde grafika je pak dána stylem seznamu.

K dispozici je pomocný nástroj – uživatelská schránka pro soubory. Při zpracování souborů je možný v zásadě dvojí přístup – buď máme jeden soubor, který chceme umístit na server, opatřit jej metadaty a opublikovat, nebo máme víc souborů, které chceme do archívu postupně zařadit, pak je vhodné je nejprve všechny překopírovat na server a pak postupně opatřovat metadaty a publikovat. Pro druhý případ je k dispozici uživatelská schránka pro soubory. Jedná se o místo, do kterého si uživatel může vložit soubory, které ještě nejsou opatřeny metadaty, nemají příslušné záznamy v databázi, a tudíž se ještě nejedná o zdroje, které lze publikovat. Z této schránky si pak může uživatel vybírat soubory a vytvářet z nich postupně zdroje, případně soubor ze schránky zase vymazat bez toho, že by jej k něčemu použil.

Zdroj se tedy v zásadě skládá ze společných metadat a z libovolného počtu položek. V daném zdroji existují dva soubory s pevně daným významem. Jedná se o

* Soubor označovaný jako ''master'' – to je výchozí varianta souboru, např. originál obrázku či MS Word soubor ke stažení
* ''Náhled'' – soubor určený pouze k zobrazování v administračním rozhraní, malý náhled zobrazující daný obrázek, případně ikonu formátu apod.
* Další varianty – lze přidat libovolný počet další položek jako variant, může jít o zmenšeniny či výřezy obrázku nebo o jiné formáty téhož souboru (master může být např. formát MS Word, další varianta formát PDF apod.)

[[Image:referencniprirucka-zdroje-img045.png|center]]

<div class="note">Varianta ''náhled'' je určena pouze pro potřeby administračního rozhraní, na veřejné části webu ji nelze použít.</div>

Důležité je, že existuje více konfigurovatelných způsobů ukládání vlastních souborů. Z hlediska uživatelů se jedná o možnost umístění do veřejné či privátní zóny – analogicky jako u stránek lze soubory, které mají být buď přístupné pouze pro registrované uživatele, nebo které ještě nejsou publikovány, vložit do privátní zóny, ze které je možné je stahovat pouze přes skript ověřující přístupová práva. Více o veřejné a privátní zóně naleznete v kapitole [[../Strom kategorií#Veřejná a privátní zóna|Veřejná a privátní zóna]].

== Možnosti využití zdrojů na veřejné části serveru ==
=== Co jsou instance položek ze zdrojů ===

Instance položek zdrojů se vytvářejí k tomu, aby se ve zprávách zobrazovaly soubory z archívu zdrojů či odkazy na ně. Ke zprávě redaktor pořizuje seznam souborů, které zpráva nějak využívá, tj. buď je má vložené někam do textu (typicky obrázky v těle zprávy) nebo figurují v seznamu příloh ke stažení. Seznam položek ze zdrojů spolu s informací o způsobu formátování ve zprávě tvoří tedy seznam instancí zdrojů ve zprávě.

Chceme-li využít na webu nějaký připravený soubor (obrázek či přílohu), typicky postupujeme tak, že založíme zdroj, vložíme do něj soubor, založíme zprávu a soubor ze zdroje vložíme jako instanci do zprávy.

Instance se vyskytuje buď v některém poli zprávy (typicky ''tělo'' či ''obrázek'') jako vložený soubor či odkaz, nebo se vyskytuje v seznamu příloh (mohou to být přílohy ke stažení či obrázky formátované jako fotogalerie). V prvním případě je třeba mít k dispozici nějaký WebToDate styl, ve druhém případě informaci o tom, že se jedná o přílohu (celý seznam příloh je pak formátován jedním stylem). Těchto seznamů může být i více, druhy seznamů a způsob jejich zobrazování se definuje v rámci implementace designu a struktury webu.

=== Zobrazování položek databáze zdrojů na webu ===

Na následujících obrázcích je schematicky naznačeno možné využití zdrojů ve veřejné části serveru.

[[Image:referencniprirucka-zdroje-img046.png|center]]

[[Image:referencniprirucka-zdroje-img047.png|center]]

Jedná se zejména o následující případy:

# Ve stránce se zprávou se mají zobrazit obrázky vložené do textu (zpravidla těla) zprávy.
# Ve stránce se zprávou se mají v textu nacházet odkazy na soubory, které lze stáhnout.
# Ve stránce se zprávou se mají zobrazit seznamy příloh ke zprávám, které lze stáhnout.
# Ve stránce se zprávou se má zobrazit fotogalerie, která je případně i stránkovaná. Designově lze toto pojmout různým způsobem, buď např. pod tělem zprávy rovnou zobrazit fotogalerii formou mozaiky náhledů, nebo zobrazit tu samou zprávu v jiné předloze, která obsahuje fotogalerii ale ne třeba tělo zprávy, nebo vytvářet samostatné zprávy, jejichž účelem je pouze prezentace nějaké fotogalerie.
# V rubrikové (statické či dynamické stránce) generovat ke zprávám formátovaným nějakým stylem např. obrázek či odkaz na stažení výchozí přílohy.
# Zobrazit větší obrázek s textovými popisky po kliknutí na nějaký obrázek či jiný element (typicky obrázek v textu či ve fotogalerii).
== Struktura zdrojů ==
V databázi zdrojů jsou k dispozici následující položky:

* '''Nadpis''' – název zdroje
* '''Popis''' – stručná anotace ke zdroji
* '''Klíčová slova''' – klíčová slova ke zdroji, pracuje se se stejným slovníkem klíčových slov jako u zpráv
* '''Autor''' – autor zdroje
* '''Tým''' – každý zdroj patří jednomu konkrétnímu týmu, který může obsah zdroje měnit
* '''Časové údaje''' – stejné jako u databáze zpráv (datum zdroje, datum aktualizace, platnost)
* '''Kategorie''' – řazení do kategorií má identické chování jako u zpráv
* '''Témata''' – řazení k tématům má identické chování jako u zpráv
* '''Publikace''' – každý zdroj patří do právě jedné publikace
* '''Priorita''' – celé číslo udávající důležitost zdroje
* '''Předloha''' – předloha, pomocí které lze zobrazit obsah zdroje, je důležitá hlavně v případě, kdy chceme pracovat na stránkách s menšími obrázky, které po kliknutí zobrazí stránku s větším obrázkem včetně zvolených textových popisků
* '''Odkaz nadpisu''' – uplatní se stejně jako předchozí případ (volba předlohy)
* '''Zkratka''' - stejná funkce jako v databázi zpráv.

Povinně je třeba vyplnit nadpis, tým, datum, alespoň jednu kategorii a publikaci.

Každý zdroj má navíc vlastnosti používané při zpracování, tj. '''Stav''' a příznak uzamčení / odemčení.

Ve zdroji se dále nacházejí položky, z vlastností, které uživatel pro soubory může měnit, jsou k dispozici pro soubory:

* '''Adresář''' – adresář na www serveru, ve kterém bude soubor uložen, fyzické umístění navíc závisí na volbě zóny
* '''Název souboru'''
* '''Umístění''' – veřejná nebo privátní zóna

Pokud daná položka není souborem ale odkazem, jsou k dispozici vlastnosti jako

* '''URL''' – adresa odkazu
* '''Název souboru''' – název, který se může zobrazovat ve stránkách
* '''Typ souboru''' – typ je daný koncovkou
* '''Velikost a rozměry''' – i zde lze specifikovat velikost cílové stránky či souboru, pokud odkaz směřuje na obrázek, tak i rozměry

== Založení nového zdroje ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). Použijte odkaz '''Přidat''' v pravém horním rohu obrazovky.

Formulář pro vkládání zdrojů se skládá ze tří záložek – '''Základní''' – '''Zařazení''' – '''Položky'''. Záložka '''Položky''' je pro nový zdroj nepřístupná a zobrazí se až po prvním uložení, to znamená, že položky lze do zdrojů vkládat až když je zdroj vytvořen.

[[Image:referencniprirucka-zdroje-img048.png|center]]

Vytvoření zdroje je velmi podobné vytvoření zprávy, v první záložce se vyplní především Nadpis, v druhé záložce se zvolí vhodná metadata.

[[Image:referencniprirucka-zdroje-img049.png|center]]

<div class="note">Věnujte pozornost stavu zdroje – soubory ze zdrojů jsou prezentovány na veřejné části pouze pokud je stav zdroje '''Publikováno'''..</div>

== Vkládání položek do zdroje ==
=== Přidání nového souboru ===

Soubor se do zdroje vkládá tlačítkem '''Přidat položku''' v záložce '''Položky''' vstupního formuláře.

[[Image:referencniprirucka-zdroje-img050.png|center]]

Zobrazí se dialogové okno podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img051.png|center]]

Soubory lze do zdroje vložit buď z lokálního disku, nebo z uživatelské schránky. Pokud máte soubor na svém lokálním disku, vyberte jej pomocí volby '''Vložit soubor z lokálního počítače'''. Soubory přetahujte do části dialogu pr nahrávání myší nebo použijte tlačítko '''Přidat soubory''', následně spusťte nahrávání na server tlačítkem '''Spustit nahrávání'''.

<div class="note">Maximální velikost souboru vkládaného z lokálního disku je vždy omezena nějakou hodnotou dle konfigurace PHP. Tato maximální velikost se vypisuje jako informace ve WebToDate všude tam, kde je možné na server přes webový formulář odesílat nějaký soubor.</div>

Funkce schránky jsou popsány v kapitole [[../Zdroje#Uživatelská schránka|Uživatelská schránka]]. Dále se v tomto dialogu volí:

* Adresář – adresář je předvyplněn podle složek v definici výchozí kategorie, ve které se zdroj nachází
* Umístění – volí se veřejná či privátní zóna. Tato volba nemusí být k dispozici, záleží na nastavení chování databáze zdrojů v globálních předvolbách WebToDate.
* Přidat do výběru – zaškrtnutím lze zvolit, že se soubor ihned zároveň vloží i do uživatelského výběru.

Po vložení souboru se stane následující:

* Pokud se jedná o první soubor vkládaný do zdroje, označí se jako ''master'' a případně se k němu vytvoří náhled (pokud se jedná o obrázek)
* Pokud se ve zdroji již nějaký soubor nachází, nový soubor se připojí k tomuto stávajícímu, žádný další náhled se již nevytváří.
* Interně se v databázi uloží další "technické" informace o souboru (velikost, rozměry apod.), které pak jsou v systému k dispozici např. pro prezentaci na veřejných stránkách.

<div class="note">Přidat první položku do zdroje je možné vždy, přidávání dalších položek může být zakázáno v konfiguračním souboru WebToDate. Jedná se o konstantu ASSETS_ALLOW_MULTIPLE_FILES v souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]''.</div>

=== Přidání nového odkazu do zdroje ===

Změnou radiopřepínač '''Druh položky''' na '''Externí URL odkaz''' lze místo souboru do zdroje vložit odkaz. Dialogové okno se změní dle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img052.png|center]]

Zde se nejprve do pole '''URL''' zadává cílová adresa. Pod tímto polem jsou k dispozici tlačítka '''Náhled''' a '''Test'''. Funkce '''Náhled''' pouze otevírá v novém okně zadané URL. Tlačítko '''Test''' může kromě kontroly toho, zda zadané URL vůbec existuje vyplnit některá další pole. Tato funkce pracuje následovně:

* Z URL se extrahuje '''Název souboru''' (řetězec mezi posledním lomítkem a případným otazníkem)
* Vyplní se '''Velikost''' (z http hlavičky testovaného URL)
* Vyplní se Typ souboru – z http hlavičky se zjistí MIME typ, porovná se se seznamem typů souborů pro zdroje v pokud je to možné, zvolí se automaticky z nabídky tento typ. Typ nemusí být identifikován jednoznačně, pak se automaticky nevolí.
* Rozměry se automaticky nedoplňují nikdy.

Ve formuláři je třeba povinně zadat pouze URL, vyplnění ostatních polí je volitelné.

=== Úpravy existujícího souboru ===

V záložce '''Položky''' ve formuláři pro úpravy zdroje se nachází seznam souborů ve zdroji. V každém řádku jsou informace o souboru (název, velikost apod.) a nástrojová lišta pro úpravy souboru. V této liště se mohou nacházet následující položky:

* '''Náhled''' – zobrazuje soubor v novém okně prohlížeče.
* '''Úprava vlastností položky''' – vyvolá dialogové okno, kde lze změnit adresář, název souboru a umístění pro soubory, resp. odpovídající vlastnosti pro odkazy. Pokud je zdroj odemčen, lze tento dialog zobrazit také (pro informace o umístění apod.), ale chybí zde tlačítko '''Uložit'''.
* '''Smazat''' – odstraní položku ze zdroje. Položku lze smazat, jen pokud není použita (není vytvořena nějaká instance ve zprávě). Soubor označený jako ''master'' lze smazat, jen pokud ve zdroji nejsou další položky.
* '''Upravit obrázek''' – je k dispozici v případě, že soubor je obrázek a nejedná se o variantu ''master'' (''master'' soubory nelze měnit).

== Seznam zdrojů ==
Vyvolejte seznam zdrojů (buď v hlavní nabídce '''Obsah''' – '''Zdroje''', nebo funkcí '''Zdroje''' ze stromu kategorií). V pravé horní části okna se zobrazí seznam podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img053.png|center]]

V prvním řádku seznamu jsou k dispozici odkazy pro přidání nového zdroje, stránkování seznamu a zobrazení uživatelského výběru a uživatelské schránky. Dále je zde odkaz '''Ke zpracování''' vypisující zdroje, který čekají na nějaký úkon daného uživatele – funkce pracuje analogicky jako v databázi zpráv.

V levém horním rohu seznamu je prvek '''Zprávy''' / '''Zdroje''', kde '''Zprávy''' je aktivní odkaz. Tato funkce slouží k snadnému přechodu mezi databází zpráv a zdrojů. Při klepnutí na '''Zprávy''' je možno pracovat s databází zpráv, přičemž v rámci session je zapamatován stav seznamu databáze zdrojů i aktuálně otevřený zdroj. V interface pro [[../Zprávy|databázi zpráv]] pak existuje stejný prvek, kterým lze přejít zpět do databáze zdrojů, která se zobrazí přesně tak, jak byla přechodem do zpráv opuštěna. Funkce je vhodná např. pro výběr položek ze zdrojů, které mají být k aktuálně zpracovávané zprávě připojeny.

V prvním sloupci se zobrazují ikony pro náhled, uzamčení / odemčení zdroje a vyznačení stavu zdroje. V druhém sloupci se zobrazují textové informace o zdroji – název, popis, výchozí kategorie, datum a údaje o ''master'' souboru (formát, velikost, případně rozměry).

Třetí sloupec zobrazuje počet souborů ve zdroji (náhled se nepočítá). Kliknutím na ikonu se navíc přidává soubor do výběru. Pokud je soubor ve zdroji jen jeden, provede se akce okamžitě, pokud je zde souborů víc, zobrazí se dialog, ve kterém se vybírá, které soubory do výběru vložit. Více o uživatelském výběru se dozvíte v kapitole [[../Zdroje#Použití zdrojů ve zprávách|Použití zdrojů ve zprávách]].

Poslední sloupec zobrazuje náhled (v případě, že se jedná o obrázek) nebo ikonu (v případě že se jedná o soubor). To se vztahuje vždy na variantu ''master'' – pokud je např. jako master soubor vložen PDF formát a jako další soubor MS Word formát, zobrazí se zde ikona pro PDF soubory apod. Klepnutím v tomto sloupci se opět otevírá v novém okně náhled varianty ''master''.

== Vyhledávání zdrojů ==
Vyhledávání zdrojů funguje analogicky jako vyhledávání zpráv, podrobnější popis naleznete v kapitole [[../Zprávy#Vyhledávání zpráv|Vyhledávání zpráv]].

[[Image:referencniprirucka-zdroje-img054.png|center]]

Vyhledávání zde opět nefunguje jednorázově, ale jako filtr nastavený v rámci daného připojení. Pokud se tedy nezobrazují v seznamu všechny očekávané položky, použijte odkaz '''Vyhledat''' a ujistěte se, že není aplikován nějaký filtr, který zobrazuje pouze část obsahu databáze zdrojů.

== Duplikace zdrojů ==
Tlačítkem '''Duplikovat''' ve formuláři pro úpravu zdrojů lze vytvářet kopie zdrojů. Vzniká duplikát, který je nadále samostatným nezávislým zdrojem a který nemá žádnou návaznost na původně duplikovaný zdroj, což znamená, že jakékoliv následné změny v duplikátu se nijak nepromítají do duplikovaného zdroje. Tato funkce je oproti možnosti duplikování jiných objektů (zpráv, stylů apod.) složitější v tom, že fyzicky duplikuje i všechny soubory ve zdroji. Vznikají kopie všech souborů ve zdroji, které mají stejný obsah, ale samozřejmě jiný název (aby např. nedošlo k pokusu o vytvoření souborů s duplicitním názvem ve stejném adresáři na disku serveru). Při vytváření nových jmen souborů se používají stejná pravidla jako při pokusu o vložení nového souboru do zdrojů pod názvem, který již existuje – seznam konfiguračních parametrů ovlivňujících generování těchto názvů souborů je uveden v kapitole [[../Zdroje#Možnosti konfigurace databáze zdrojů|Možnosti konfigurace databáze zdrojů]].

== Uživatelská schránka ==
=== Co je uživatelská schránka ===

Uživatelská schránka je místo, kam může uživatel vkládat soubory, které ještě nejsou zařazeny do databáze a nejsou zařazeny do žádného zdroje. Do této schránky může uživatel vkládat soubory či je zde mazat bez omezení, ze schránky může vybrat soubor ve chvíli vkládání souboru do zdroje. Každý uživatel má svoji schránku, která není nijak sdílena s ostatními.

Při použití příslušného www formuláře lze vkládat vždy jen po jednom souboru. Aby bylo možné zpřístupnit i práci s více soubory najednou, existuje volitelná možnost konfigurace přístupu do schránky přes ftp protokol. Tato funkce vyžaduje patřičnou konfiguraci ftp serveru a zadání adresy ftp serveru v globálních předvolbách – to se pak projeví tlačítkem pro FTP přístup ke schránce v okně pro schránku.

<div class="note">Od verze 7.0 prohlížeče Internet Explorer není z bezpečnostních důvodů možné přepnout dané okno prohlížeče do FTP režimu zobrazujícího obsah daného adresáře. Pro tuto verzi prohlížeče se proto po použití tohoto tlačítka nabídne místo přímého zobrazení nakopírování příslušného URL pro FTP přístup do schránky. Toto URL vložte (Ctrl+V) buď do svého oblíbené aplikace pro připojení k FTP serverům nebo do adresní řádky Průzkumníka Windows, kde již je připojení s požadovaným zobrazením podporováno.</div>

[[Image:referencniprirucka-zdroje-img055.png|center]]

Obsah schránky vyvolejte odkazem '''Schránka''' v seznamu zdrojů. Otevře se dialogové okno, ve kterém lze buď přidat soubor z lokálního disku do schránky, nebo naopak odstranit vybraný soubor či všechny soubory ze schránky. Pro odstranění jednoho souboru klepněte na radiopřepínač pod náhledem či ikonou souboru a použijte tlačítko '''OK'''. Pro odstranění všech souborů ze schránky použijte tlačítko '''Smazat vše'''.

V dialogu pro vložení souboru do zdroje se obsah schránky zobrazuje rovněž. V tomto dialogu lze vybrat buď soubor z lokálního disku, nebo ze schránky. Pokud je vybrán soubor ze schránky, soubor se ze schránky nekopíruje, ale přesouvá, což znamená, že po vložení souboru ze schránky do zdroje tento soubor ze schránky mizí.

=== Rychlé vytvoření více zdrojů z obsahu schránky ===

Z okna pro zobrazení schránky lze vyvolat funkci pro hromadné vložení souborů ve schránce do databáze zdrojů. Tato funkce je určena především k vytvoření více zdrojů najednou s obrázky, které pak tvoří např. fotogalerii k dané zprávě, lze ji ale s výhodou použít i na vkládání jednotlivých obrázků, protože umožňuje automaticky v jednom kroku vytvořit i druhou variantu obrázku – náhled vhodný pro další použití ve webové prezentaci.

Funkce se spouští tlačítkem '''Vytvořit zdroje''' v okně zobrazujícím obsah schránky. Zobrazí se formulář dle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img056.png|center]]

Funkce zařadí do databáze zdrojů všechny obrázky aktuálně umístěné do schránky, každý obrázek jako samostatný zdroj. Pro funkci platí následující:

* Všechny takto vytvořené zdroje mají stejná metadata, výjimkou je pouze možnost zvolit jako název zdroje název souboru (první radiopřepínač ve formuláři)
* Všechny soubory budou umístěny na serveru v jednom adresáři, který je ve formuláři uveden
* Hromadně je nastavitelná pro jednoduchost pouze vybraná množina metadat, ve formuláři tedy chybí např. datum ''Publikovat dne'', ''Témata'' apod.
* Vytvořené zdroje mají stav zvolený ve formuláři a vždy jsou odemčené.

Volby dále zrychlující celou práci jsou ve formuláři dole:

* '''Vytvořit pro obrázky další variantu''' – funkce vytvoří automaticky pro všechny obrázky druhou variantu uloženou vždy ve stejném zdroji jako původní obrázek, rozměry této varianty se vybírají v příslušné rozevírací nabídce. Nová varianta se nezakládá, pokud jsou rozměry obrázku ve schránce menší než nastavený požadovaný rozměr.
* '''Přidat soubory do uživatelského výběru''' – naplní uživatelský výběr právě vloženými soubory. Pokud je zvoleno vytváření nové varianty, do výběru se vloží vždy tato druhá varianta, v opačném případě původní (''master'') soubor.

Když úloha skončí, okno se schránkou se uzavírá a obnovuje se seznam zdrojů, typický výsledek je na následujícím otisku obrazovky:

[[Image:referencniprirucka-zdroje-img057.png|center]]

Zdroje jsou vytvořené a obrázky v nich požadovaným způsobem uložené, stačí vybrat nějakou konkrétní zprávu a připojit k ní výběr souborů, obsah fotogalerie (či příloh ke zprávě apod.) je takto rychle sestaven.

== Použití zdrojů ve zprávách ==
=== Připojení položek ze zdrojů ke zprávě ===

Principiální způsob využití obsahu databáze zdrojů při vytváření webové prezentace je vysvětlen v kapitole [[../Zdroje#Možnosti využití zdrojů na veřejné části serveru|Možnosti využití zdrojů na veřejné části serveru]].

Při použití souboru ve zprávě se postupuje ve dvou až třech krocích.

V prvním kroku se vybere položka z databáze zdrojů, který chceme ke zprávě připojit. To se prování klepnutím na ikonu '''Položky''' v seznamu zdrojů nebo tlačítkem '''Přidat do výběru''' ve formuláři pro úpravu zdroje. Je-li ve zdroji uložena více než jedna položka, zobrazí se dialog, ve kterém je třeba vybrat, která položka ze zdroje se do výběru přidává (lze vybrat i více než jednu položku). Tento dialog je na následujícím otisku obrazovky.

[[Image:referencniprirucka-zdroje-img058.png|center]]

<div class="note">Doporučujeme nejprve postupně vybrat všechny položky, které mají být ve zprávě použity, zamezí se tím nutnosti opakovaně přecházet na jiné obrazovky mezí databází zpráv a zdrojů.</div>

V dalších formulářích je možné zpracovávaný soubor rovnou přidat (kromě jiné akce realizované daným dialogem) do výběru. Jedná se o:

* Vložení prvního či dalšího souboru do zdroje
* Obrazovku pro úpravy obrázků

Co je aktuálně v uživatelském výběru lze kdykoliv zobrazit. To je možné buď odkazem '''Výběr''' v seznamu zdrojů nebo tlačítkem '''Zobrazit výběr souborů''' ve formuláři pro editaci zpráv (v záložce '''Soubory'''). Tento dialog je zobrazen na následujícím otisku obrazovky.

[[Image:referencniprirucka-zdroje-img059.png|center]]

V tomto okně lze případně nějaké položky z výběru odstranit, buď pouze vybrané, nebo případně všechny (tlačítko '''Smazat z výběru všechny'''). Položky se tím samozřejmě nemažou z databáze zdrojů, ale pouze z výběru.

<div class="note">Do výběru si můžete vložit i položky, které chcete připojit k více zprávám. Ve chvíli připojování ke zprávě lze specifikovat, které položky z výběru se připojují a které ne.</div>

Uživatelský výběr je struktura, která se uchovává perzistentně v databázi systému. To znamená, že po opětovném přihlášení najde uživatel ve svém výběru přesně to, co tam dříve vložil.

Druhým krokem je připojení položek, které jsou ve výběru, ke zprávě. Když máte všechny potřebné soubory umístěny do uživatelského výběru, přejděte do formuláře pro úpravu rozpracované zprávy a použijte tlačítko '''Připojit výběr položek'''. Zobrazí se následující dialog.

[[Image:referencniprirucka-zdroje-img060.png|center]]

V tomto dialogu jsou vypsány všechny položky, které se aktuálně nacházejí v uživatelském výběru. Pro každou položku jsou tři možnosti:

* '''Připojit pod vybraným stylem''' – tato volba se použije v případě, že chceme položku použít samostatně (typicky v těle zprávy nebo např. v poli obrázek. Je třeba zde vybrat vhodný styl, kterým se data ze zdroje formátují – styl může např. definovat, že HTML element pro obrázek má atributy jako zarovnání, rozměry, ohraničení atd.
* '''Připojit jako přílohu''' – soubor chceme zobrazit v automaticky generovaném seznamu příloh ke zprávě. Těchto seznamů může být více druhů (seznam souborů ke stažení, fotogalerie apod.), proto je zde nutné vybrat druh seznamu.
* '''Tento soubor nepřipojovat''' – soubor se ke zprávě nepřipojí.

Navíc je k dispozici tlačítko '''Nastavit pro všechny''', které nastaví způsob připojení stejně pro všechny soubory v seznamu podle toho, jak je nastavená první položka v seznamu. Pokud tedy např. chcete všechny uvedené položky připojit jako přílohy ke stažení, není třeba toto volit u každé položky zvlášť, ale pouze u první a pak použít toto tlačítko. Tlačítko provádí změnu pouze v okně formuláře, tj. jeho použití nevyvolává žádné uložení těchto vlastností na serveru – vždy je následně třeba použít '''Připojit ke zprávě''' resp. '''Připojit ke zprávě a smazat výběr'''.

Když pro každou položku ve výběru provedete správnou volbu, použijte tlačítko '''Připojit ke zprávě''' (připojí všechny položky ke zprávě a obsah uživatelského výběru ponechá beze změny) nebo '''Připojit ke zprávě a smazat výběr''' (stejná akce jako předchozí tlačítko, ale navíc odstraní celý obsah výběru). Tato druhá varianta je vhodnější v případě, že vybrané soubory už nechcete použít u jiné zprávy, není pak třeba ručně explicitně smazat obsah výběru vyvoláním dalšího dialogu.

Pokud jste chtěli položku zařadit jen jako položku do seznamu příloh, není třeba provádět nic dalšího. Pokud chcete např. použít soubor jako obrázek v textu zprávy, jedná se o třetí krok popsaný v následující kapitole.

=== Práce s již připojenými položkami ===

Seznam připojených souborů v záložce '''Zdroje''' (ve formuláři pro úpravu zprávy) obsahuje pro každou položku ID instance, název zdroje a souboru a informace o souboru (velikost a případně rozměry obrázku). Klepnutím na tento řádek se přechází do formuláře pro editaci tohoto zdroje. Dále jsou v každém řádku ikony pro manipulaci s těmito položkami (resp. s jejich instancemi ve zprávě). Jedná se o následující možnosti:

* '''Náhled''' – zobrazuje v novém okně soubor. Ikona pro náhled má dvě různé varianty, jedna (se sponkou) se zobrazuje v případě, že je souboru připojen jako příloha k nějakému seznamu, druhá (bez sponky) se zobrazuje, pokud je soubor připojen přímo pod nějakým WebToDate stylem.
* '''Úprava vlastností instance''' – otevírá dialog pro nastavení vlastností instance (specifikuje se zde v podstatě buď příslušnost k určitému seznamu příloh, nebo styl, kterým se soubor ve zprávě formátuje)
* '''Odstranit''' – po potvrzení odstraňuje připojení položky ke zprávě
* '''Vložit klíčové slovo pro instanci do schránky''' (systémového clipboardu)
* '''Vložit klíčové slovo pro instanci do pole Obrázek'''

Úprava vlastnosti instance je na následujícím otisku obrazovky, lze zde v zásadě změnit způsob přiřazení, neboli změnit styl nebo přiřadit k jinému seznamu příloh.

[[Image:referencniprirucka-zdroje-img061.png|center]]

Pokud je zpráva odemčená, nelze ji měnit, tento dialog pro zobrazení vlastností instance se v takovém případě zobrazí, ale chybí zde tlačítko '''Uložit'''.

Poslední dvě funkce slouží pro vložení klíčového slova instance, tj. značky, za kterou se dosazuje soubor ze zdroje zformátovaný vybraným WebToDate stylem. Tato značka má tvar <nowiki></nowiki>, kde xxx je interní číslování instancí. Značku můžete umístit do kteréhokoliv textového pole zprávy, typicky ovšem se jedná buď o tělo zprávy, nebo pole Obrázek. Pro pole Obrázek existuje jednoduchá metoda – stačí použít ikonu '''Vložit klíčové slovo pro instanci do pole Obrázek'''.

Tato funkce se chová odlišně podle toho, zda je definovaná uživatelsky přizpůsobitelná struktura databáze zpráv a tato struktura obsahuje pole typu ''položka databáze zdrojů''. Pokud žádné pole takového typu v uživatelsky definované struktuře není, klepnutím na ikonu se přímo vloží klíčové slovo instance do pole Obrázek. V opačném případě se po klepnutí na ikonu zobrazí kontextová nabídka, ve které lze vybrat, do kterého pole se značka má vložit. První možností je pole Obrázek, pak následují další pole uživatelsky definované struktury databáze zpráv typu ''položka databáze zdrojů''.

Samotné vstupní pole typu ''položka databáze zdrojů'' se pak chová tak, že do něj nelze vložit jiná data než klíčové slovo instance. Pokud je při uložení zprávy detekován obsah jiného typu, je z pole odstraněn a uživateli je zobrazeno hlášení upozorňující na tuto skutečnost.

Pro vložení do těla zprávy je třeba nejprve nakopírovat značku do systémové schránky ('''Vložit klíčové slovo pro instanci do schránky'''), pak se ve formuláři přepnout do záložky '''Základní''' a nakopírovat (z klávesnice Ctrl + V) na vhodné místo v textu.

Poslední funkce – vložení klíčového slova pro instanci do těla zprávy – je podporována i ve [[../../WYSIWYG editor|WYSIWYG editoru]]. Postup je následující:

# vyvolejte editor pro tělo zprávy a použijte ikonu pro vkládání instancí:
#:
#:[[Image:referencniprirucka-zdroje-img062.png|center]]
#:
# V dialogu editoru se zobrazí seznam připojených položek, které nejsou připojeny k nějakému seznamu příloh (tj. jsou naopak připojeny pod nějakým stylem pro zdroje). Klepnutím na položku v tomto seznamu se vloží odpovídající klíčové slovo na pozici kurzoru.

[[Image:referencniprirucka-zdroje-img063.png|center]]

Ve WYSIWYG editoru se zobrazují zástupné značky, nikoliv výsledný kód vzniklý aplikací vybraného stylu na instanci – proto je výhodné použít např. vizuální režim pro úpravu zprávy – po uložení obsahu WYSIWYG editoru se v tomto režimu již ukáže přesný výsledek. Značky obsahují název a případně rozměry obrázku. Poklepáním na značku se otevírá dialog pro výběr položky znovu a lze případně jednoduše do daného místa v textu vložit jinou položku.

[[Image:referencniprirucka-zdroje-img064.png|center]]

Pokud odstraníte soubor ze seznamu instancí ke zprávě, značky pro instance v textu zprávy zůstávají. To znamená, že se na daném místě nebude zobrazovat nic, vzhledem k tomu, že se jedná o formu HTML komentářů, nedojde na stránce k žádné chybě.

<div class="note">Tyto značky, které již nic nezobrazují může vyhledávat a vypisovat modul '''Verifikace''' – více naleznete v příručce k tomuto modulu.</div>

=== Úprava pořadí položek v seznamech příloh ===
Je-li soubor připojen k nějakému seznamu příloh, je pořadí zobrazování v prezentační vrstvě dáno primárně definicí příslušného [[../Seznamy#Seznamy příloh|seznamu příloh]] vloženého do [[../Zprávy#Zprávy a předlohy|předlohy pro zprávy]]. Toto pořadí lze explicitně změnit v dialogu zobrazeném po klepnutí na tlačítko '''Upravit pořadí položek''' v záložce '''Zdroje''' formuláře pro zprávy.

[[Image:referencniprirucka-zdroje-poradi-polozek.png|center]]

V rozevírací nabídce v horní části dialogu se vybírá [[../Seznamy#Druhy seznamů příloh|druh seznamu příloh]], ve kterém chceme pořadí položek změnit. Následně se pořadí mění prostým přetažením zobrazených bloků obsahujících nadpis zdroje a název souboru. Změna pořadí se ukládá automaticky ihned po přetažení bloku myší. Pokud se chceme vrátit zpět k výchozímu pořadí danému definicí zobrazování seznamu příloh, použijeme tlačítko '''Reset''' v tomto formuláři.

== Způsob ukládání souborů, veřejná a privátní zóna ==
Soubory mohou být ukládány do veřejné či privátní zóny. Vysvětlení těchto pojmů najdete v kapitole [[../Strom kategorií#Veřejná a privátní zóna|Veřejná a privátní zóna]].

V rámci konfigurace databáze zdrojů lze nakonfigurovat, která zóna se nabízí jako výchozí, zda vůbec uživatelé mohou tuto volbu měnit a dále je zde možnost vynucení způsobu uložení podle stavu zdroje. To znamená, že i když je soubor ukládán do veřejné zóny, bude uložen v úložišti pro privátní zónu do té doby, než bude stav zdroje změněn na ''Publikováno''. Tato poslední volba je zde z toho důvodu, aby bylo možné eventuálně bránit tomu, aby byly stahovány anonymně neschválené a nepublikované soubory z databáze zdrojů.

== Funkce pro zpracování obrázků ==
Databáze zdrojů podporuje možnost vytváření a editace dalších variant obrázků na serveru se zadáním parametrů přes rozhraní prohlížeče. Touto funkcí lze vytvářet bez grafického bitmapového editoru výřezy či zmenšeniny obrázku.

Aby bylo možné funkci použít, musí být splněny tyto předpoklady:

* Je založen zdroj a má master soubor
* ''Master'' soubor je obrázek

Soubory ''master'' a ''náhled'' těmito nástroji nikdy nelze editovat, lze pouze zakládat a editovat další varianty.

Při založení nové varianty se vychází z kopie souboru ''master''. Ta se načte do nového okna prohlížeče, kde jsou k dispozici následující funkce:

* Zmenšování / zvětšování na klientské straně (tedy pouze vizuálně pro lepší možnost výběru
* Možnost vybrat v obrázku obdélníkový region
* Vytvoření výřezu podle vybraného regionu
* Vytvoření výřezu dle zadaných rozměrů
* Otočení obrázku o 90 stupňů
* Vytvoření zmenšeniny podle možností daných administrátorem či podle zadání rozměrů
* Nahrazení editované varianty kopií master souboru (čili jakýsi návrat zpět)
* Možnost definovat umístění souboru v adresářové struktuře a ve veřejné / privátní zóně.

Použití zabudovaného editoru pro obrázky je v zásadě možné ve dvou případech:

# Chceme editovat obrázek, který je již vložen do zdroje. Použijeme funkci '''Upravit obrázek''' u souboru ve zdroji. Tato funkce je dostupná pouze pro soubory, které nejsou označeny jako ''master''.
# Chceme vytvořit novou variantu obrázku – zmenšeninu, ořez apod. Použijeme tlačítko '''Vytvořit novou variantu obrázku'''.

V obou případech se zobrazí editor obrázků podle následujícího otisku obrazovky.

[[Image:referencniprirucka-zdroje-img065.png|center]]

V horní části okna je informační lišta (velikosti souborů apod.). Je zde rovněž funkce '''Zoom''' – ta umožňuje pouze zvětšit či zmenšit opticky obrázek. Funkce toto provádí pouze na straně klienta a s obrázkem fyzicky nijak nemanipuluje. Je vhodná v případě, že chcete pomocí myši přesněji vytvořit rámeček pro oříznutí.

Dále je k dispozici nabídka '''Akce''', která specifikuje, co se má provést. Jedná se o následující volby:

# '''Zmenšit na předdefinovanou velikost''' – v nabídce vpravo je seznam možných předdefinovaných velikostí, obsah této nabídky se definuje v globálních předvolbách WebToDate.
# '''Zmenšit na zadanou velikost''' – vpravo jsou políčka '''šířka''' a '''výška''', které je třeba vyplnit. Pokud jsou zadány oba rozměry, obrázek se zmenší tak, aby oba zadané rozměry nebyly překročeny a aby byl zachován poměr stran. Lze zadat pouze jeden z rozměrů, pak se druhý automaticky dopočítá opět tak, aby byl zachován poměr stran.
# '''Doostřit''' - provádí doostření obrázku podle zadaných parametrů (poloměr, míra, sigma, práh). Výchozí hodnoty všech těchto parametrů lze nastavit v globálních předvolbách WebToDate.
# '''Vodoznak''' - vkládá do obrázku soubor s vodoznakem, lze zvolit umístění a jas vodoznaku. Seznam souborů, které lze vložit jako vodoznak, se definuje v globálních předvolbách WebToDate, stejně tak v těchto předvolbách lze nastavit výchozí hodnoty pro umístění a jas.
# '''Otočit o 90 stupňů''' – vpravo se vybírá otočení doleva nebo doprava
# '''Oříznout podle výběru''' – pomocí myši vytvořte v náhledu rámeček pro oříznutí a použijte tlačítko '''Provést akci'''.
# '''Oříznout podle výběru se zadánín rozměrů''' – zadejte oba rozměry požadovaného výřezu a klepněte myší na místo v obrázku, kde má být levý horní roh výběru, pak použijte tlačítko '''Provést akci'''.
# '''Nahradit kopií souboru master''' – jedná se o jakýsi návrat zpět, použijte v případě, že jste vytvořili obrázek v nevyhovující podobě.
# '''Návrat k uložené variantě''' - je k dispozici pouze v případě, že se jedná o editaci existující varianty, nikoliv o vytváření nové varianty. Funkce vrací editovaný obrázek zpět k souboru, který je aktuálně uložen jako daná upravovaná varianta, je to tedy jakýsi návrat zpět pro případ, že provedené operace při úpravách obrázku neodpovídají žádoucímu výsledku.

Všechny tyto volby je vždy třeba potvrdit tlačítkem '''Provést akci'''.

Finální potvrzení uložení změn se provádí tlačítkem '''Uložit''' v pravé spodní části okna. Pokud je zároveň zaškrtnuto '''Přidat do výběru''', upravovaný soubor se při uložené zároveň přidá do uživatelského výběru.

Možnosti pro změnu velikosti mají následující vlastnosti:

* Je podporováno pouze zmenšování, nikoliv zvětšování. Pokud zadáte větší rozměry, než má obrázek, žádná akce se neprovede.
* Zmenšování se vždy provádí se zachováním poměrů stran obrázku. Provede se tak, že ani jeden rozměr nesmí ve výsledku přesáhnout požadované rozměry.

Význam parametrů pro funkci '''Doostřit''' je zhruba tento:

* ''Poloměr'' - udává se v obrazových bodech a říká, jak široká oblast kolem hrany bude doostřením zasažena. Jinými slovy v jak široké oblasti kolem hrany se kontrast plynule zvýší podle hodnoty ''Míra''. Musí jít o nezáporné číslo (může být i desetinné).
* ''Míra'' - určuje, jak moc bude hrana zvýrazněna. 100% znamená, že původní kontrast hrany bude zvýšen o 100% (tj. na dvojnásobek). Jedná se o celé nezáporné číslo v procentech (může být i více než 100%).
* ''Sigma'' - směrodatná odchylka Gaussova rozložení, udává se v obrazových bodech. Musí jít o nezáporné číslo (může být i desetinné), musí být menší než ''Poloměr''.
* ''Práh'' - říká, jak velký musí být absolutní rozdíl jasů mezi sousedními body obrazu, aby se považovaly za hranu, a tudíž se zostřily filtrem. Jedná se o celé nezáporné číslo v procentech.

Ve funkci Vodoznak se v prvé řadě vybírá obrázek ze seznamu definovaného v globálních předvolbách, který se má vložit jako vodoznak. Dále se vybírá umístění, které je popsáno jako výběr světových stran, tj. má následující možnosti:

* severozápad
* sever
* severovýchod
* západ
* střed
* východ
* jihozápad
* jih
* jihovýchod

Volba ''jihovýchod'' tedy např. znamená pravý spodní okraj obrázku apod.

Poslední volbou je jas vodoznaku - zadává se jako údaj v procentech v rozsahu 0 až 100%.

<div class="note">'''Poznámka:''' Všechny funkce pro manipulaci s obrázky využívají knihovnu '''ImageMagick''', která musí být na serveru nainstalovaná a v globálních předvolbách správně nakonfigurovaná. Instalace knihovny není ve WebToDate požadována, ale bez této instalace nejsou dostupné funkce pro manipulaci s obrázky ani vytváření náhledů. Více viz instalační příručka k produktu a kapitola [[../Konfigurace WebToDate#Globální konfigurace WebToDate|Globální konfigurace WebToDate]].
Podpora různých formátů a jejich zpracování je opět plně závislé na knihovně '''ImageMagick'''. Doporučujeme pro obrázky, u kterých se bude vytvářet další varianta pomocí těchto nástrojů, používat formát JPEG. Tento formát je podporován velmi dobře a během testování nebyly zjištěny žádné problémy. Naopak bylo zjištěno, že knihovna '''ImageMagick''' nepracuje správně při ořezávání obrázků ve formátu GIF – je ponechán původní rozměr obrázku a oříznuté plochy jsou pouze převedeny na bílou barvu. V těchto případech je vhodnější další variantu obrázku vytvořit v grafickém editoru na klientském počítači a následně ji do zdroje pouze přidat bez úprav na straně serveru.</div>

== Podpora IPTC metadat==
=== IPTC metadata ===
Soubory JPEG mohou obsahovat textová metadata (klíčová slova, popisky, geografické údaje apod.) ve formátu [http://cs.wikipedia.org/wiki/IPTC IPTC]. Těmito metadaty je možno obrázky opatřovat jak v běžně používaných aplikacích pro úpravy obrázků ([http://www.adobe.com/cz/products/photoshop/photoshop/ Adobe Photoshop] apod.), tak v mnoha volně dostupných aplikacích pro prohlížení a jednoduché úpravy obrázků ([http://www.xnview.com XnView] atd.).

Databáze zdrojů WebToDate má vlastní metadata, která se zadávají do příslušných formulářů. Pokud ale již obrázkový soubor je opatřen IPTC informacemi, nabízí se možnost tyto informace převzít, načíst do databáze zdrojů a tak omezit nutnost opakovaného zadávání těchto metadat.

<div class="note">Funkce pro práci s IPTC jsou dostupné jen v instalacích s PHP 5, ve kterých je aktivní PHP extenze GD2.</div>

=== Struktura IPTC polí ===
Následující tabulka definuje mapování IPTC polí na strukturu databáze zdrojů WebToDate. Jsou uvedeny jen ta nejdůležitější pole, do WebToDate se načítají jen ta metadata, která mají uvedeno, do které části struktury zdroje se načítají.

{| class="prettytable"
! IPTC pole
! <b>Kód pole
! Význam
! WebToDate pole
|-
|
Headline
|
<nowiki>#105</nowiki>
|
Titulek obrázku
|
Nadpis
|-
|
Caption
|
<nowiki>#120</nowiki>
|
Popisek
|
Popis
|-
|
Keywords
|
<nowiki>#025</nowiki>
|
Klíčová slova; může jich být i více, pak se pole #025
opakuje několikrát
|
Klíčová slova
|-
|
Category
|
<nowiki>#015</nowiki>
|
Kategorie; 3 znaky dle definice NAARTNDA, pro zpracování
ve WebToDate se nevyužívá
|
|-
|
Supplemental Category
|
<nowiki>#020</nowiki>
|
Vlastní (uživatelem definované) kategorie; libovolné
množství vlastních názvů kategorií, pro zpracování ve WebToDate se nevyužívá
|
|-
|
By-line
|
<nowiki>#080</nowiki>
|
Jméno autora/fotografa
|
Autor
|-
|
By-line Title
|
<nowiki>#085</nowiki>
|
Titul autora/fotografa
|
|-
|
Copyright
|
<nowiki>#116</nowiki>
|
Autorská práva
|
|-
|
Contact
|
<nowiki>#118</nowiki>
|
Kontakt
|
|-
|
Source
|
<nowiki>#115</nowiki>
|
Zdroj
|
|-
|
Credit
|
<nowiki>#110</nowiki>
|
Zprostředkovatel fotografie
|
|-
|
Object Name
|
<nowiki>#005</nowiki>
|
Krátký popis obrázku, může být i jméno souboru
|
|-
|
City
|
<nowiki>#090</nowiki>
|
Místo pořízení: město
|
|-
|
Sublocation
|
<nowiki>#092</nowiki>
|
Místo pořízení: oblast
|
|-
|
Province/State
|
<nowiki>#095</nowiki>
|
Místo pořízení: nejvyšší správní jednotka
|
|-
|
Country Code
|
<nowiki>#100</nowiki>
|
Místo pořízení: kód státu (3 písmena)
|
|-
|
Country Name
|
<nowiki>#101</nowiki>
|
Místo pořízení: stát
|
|-
|
Created Date
|
<nowiki>#055</nowiki>
|
Datum pořízení ve formátu RRRRMMDD
|
|-
|
Created Time
|
<nowiki>#060</nowiki>
|
Čas pořízení ve formátu HHMMSS±HHMM (čas ± posun vůči UTC)
|
|-
|
Release Date
|
<nowiki>#030</nowiki>
|
Datum zveřejnění ve formátu RRRRMMDD
|
|-
|
Release Time
|
<nowiki>#035</nowiki>
|
Čas zveřejnění ve formátu HHMMSS±HHMM (čas ± posun vůči
GMT)
|
|-
|
Priority
|
<nowiki>#010</nowiki>
|
Důležitost: "1" nejvyšší, "5" normální
a "8" nejnižší. Stupeň "9" je určen pro uživatelem
určenou důležitost, "0" je vyhrazena pro budoucí účely
|
|-
|
Special Instructions
|
<nowiki>#040</nowiki>
|
Zvláštní instrukce
|
|}

=== Funkce podporující práci s IPTC ===
==== Zobrazení IPTC master souboru ====
Při otevírání formuláře pro editaci zdroje se zjišťuje, zda master soubor je obrázek typu JPEG a pokud ano, zda má v sobě IPTC informace. Pokud tomu tak je, zobrazí se v záložce '''Položky''' formuláře pro úpravy zdroje vedle tlačítka '''Užití''' ještě tlačítko '''IPTC'''. Tlačítko '''IPTC''' otevírá nové dialogové okno prohlížeče, kde se v režimu pouze pro čtení zobrazují všechny neprázdné IPTC informace uvedené v tabulce [[#Struktura IPTC polí|Struktura IPTC polí]]. Příklad takového zobrazení těchto metadat je na následujícím obrázku.

[[Image:referencniprirucka-zdroje-iptc.gif|center]]

==== Vkládání souboru do existujícího zdroje ====
Volba '''Načíst IPTC popisky''' se aktivuje, pokud je v [[#Přidání nového souboru|dialogu pro vložení nového souboru do zdroje]] vybrán obrázek typu JPEG. Zaškrtávací okénko se nikdy neaktivuje v případě, že zdroj již má master soubor.

V případě, že se tedy vkládá do zdroje obrázek jako master soubor, načte tato funkce příslušná metadata z IPTC obrázku.

==== Zakládání zdrojů z obsahu schránky ====
V dialogovém okně pro [[#Rychlé vytvoření více zdrojů z obsahu schránky |generování zdrojů z obsahu schránky]] je zaškrtávací okénko '''Načíst IPTC popisky'''. Pokud je tato možnost zvolena, berou se příslušné údaje (nadpis, popis, autor, klíčová slova) jako výchozí, která se použijí, jen když obrázek nemá odpovídající IPTC pole (nebo nemá IPTC vůbec), jinak se pro příslušné položky databáze zdrojů použijí IPTC popisky z načítaného souboru. Jde tedy vůbec o nejrychlejší možnost, jak do zdrojů WebToDate uložit více obrázků najednou s kompletními popisky.

==== Přidání souboru ke zprávě ====
V dialogovém okně pro [[../Zprávy#Soubory patřící ke zprávě|přidání souboru ke zprávě]] je opět možné pro obrázky typu JPEG zvolit načtení IPTC, které se použije ve chvíli, kdy je pro obrázek zakládán nový zdroj.

=== Znaková sada IPTC popisků ===
Za výchozí volbu se považuje to, že IPTC popisky mají stejné kódování, jako je nastaveno ve WebToDate. Toto lze explicitně změnit v konfiguračním souboru [[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]] pomocí volitelné konstanty

<code>
<nowiki>define(' ASSETS_IPTC_CHARSET', 'windows-1250' );</nowiki>
</code>

Pokud je hodnota této konstanty jiná než hodnota CHARSET, provádí se před uložením popisku do databáze příslušná konverze do cílové znakové sady.

== Konverze souborů ==
<div class="note">Funkce popsané v této kapitole jsou závislé na instalaci a konfiguraci aplikací ImageMagick pro obrázky resp. FFmpeg pro videa. Nejsou-li tyto aplikace na serveru instalovány či nejsou-li nastaveny cesty k aplikacím v konfiguračním souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'', nejsou funkce pro konverze souborů k dispozici.</div>

=== Konverzní pravidla a funkce ===

Administrátor ve WebToDate může definovat konverzní pravidla a funkce, pomocí kterých lze měnit (konvertovat) obrázky, zvuky a videosekvence vkládané do databáze zdrojů nebo komprimovat soubory do zip archivů. Administrátor definuje seznam těchto konverzních pravidel a funkcí a jejich parametry (z jakého do jakého formátu funkce provádí převod, jaké je cílové rozlišení videa či obrázku apod.). Tato pravidla a funkce pak mohou nebo musí (pokud se jedná o vynucenou automatickou konverzi) používat všichni uživatelé WebToDate.

Terminologie základního rozdělení těchto funkcí je následující:

* ''Konverzní pravidlo'' - předpis pro konverzi, který se aplikuje ve chvíli vkládání souboru do zdroje. Jedná se buď o automaticky aplikované pravidlo, tj. uživatel si při vložení souboru do zdroje nemůže vybrat, jestli chce danou konverzi souboru provést, nebo o volitelnou konverzi, tj. uživatel si může zvolit, jestli chce nebo nechce takovou konverzi provést.
* ''Konverzní funkce'' - funkce se nabízí jako jedna z možností úpravy souboru ve zdroji. Neaplikuje se při vkládání souboru do zdroje, ale následně při úpravě zdroje ji může uživatel explicitně vyvolat a aplikovat na zvolený soubor.

V každém případě si uživatel při práci se zdroji pouze vybírá, zda dané pravidlo či funkci aplikovat na daný soubor, nemůže ovlivňovat parametry, které funkce použije (tj. pozměnit cílové rozměry obrázku či videa, formát apod.).

Všechna pravidla a funkce se odvozují od formátu souboru, tedy vždy jde o předpis typu pokud je formát souboru ten a ten (JPG, FLV, AVI, BMP apod.), musí nebo lze na něj aplikovat takovou a takovou konverzi. Pro jeden souborový formát je možno definovat více pravidel. V takovém případě se aplikují všechna pravidla existující pro daný typ souborů.

Všechna pravidla se vždy vyhodnocují vzhledem ke zpracovávanému souboru. To znamená, že pokud se např. vkládá obrázek s rozměry 1000x1000 a jedno pravidlo říká, že pokud je rozměr větší než 800x800, má se zmenšit na 600x600 a druhé pravidlo říká, že pokud je rozměr větší než 800x800, má se vytvořit jako nová varianta obrázek 200x200, vyhodnotí se obě podmínky vzhledem k původnímu souboru ještě před vlastním spuštěním pravidel a aplikují se obě pravidla.

=== Vytváření pravidel ===

Definovat konverzní pravidla a funkce může pouze administrátor. Přejděte do nabídky '''Administrace''' – '''Konverze souborů''' a v pravém horním rohu okna klikněte na '''Přidat'''.

Nejprve se vybírá druh souborů ke konverzi - může jít o pravidlo pro obrázek, audio, videosekvenci, kompresi do zip formátu nebo o konverzi souboru na externím serveru. Na této volbě závisí nabídka parametrů konverze v dalším kroku, pro jednou uložené pravidlo již nelze změnit volbu toho, na jaký druh souborů se pravidlo vztahuje.

[[Image:referencniprirucka-zdroje-img066.png|center]]

Po použití tlačítka '''Pokračovat''' se zobrazí formulář pro vyplnění parametrů pravidla. Formulář má dvě záložky - '''Základní''' a '''Konverze'''. První záložka '''Základní''' je vždy stejná, obsah druhé záložky závisí na druhu souborů zvoleném v prvním kroku.

[[Image:referencniprirucka-zdroje-img067.png|center]]

Záložka '''Základní''' obsahuje následující pole (vše je nutno povinně vyplnit):

* '''Název''' - název pravidla tak jak se pak bude uživatelům zobrazovat
* '''Pravidlo pro''' - je automaticky vyplněno dle volby v prvním kroku, zde uvedeno pouze pro informaci
* '''Zdrojový formát''' - vybírá se formát souboru, na který lze pravidlo aplikovat. Nabídka je vyplněna těmi formáty, které jsou ve funkci '''Typy souborů''' označeny daným druhem - pokud se tedy vybere, že jde o konverzi pro video, nabízí se zde všechny formáty, které jsou ve funkci '''Typy souborů''' označeny jako ''video'' apod.
* '''Druh''' - vybírá se způsob, jakým se pravidlo aplikuje. Možnosti jsou
** ''Automatická konverze při vložení souboru do zdroje'' - při vložení souboru vybraného formátu do zdroje se aplikuje nastavená konverze bez možnosti tuto konverzi nespustit
** ''Volitelná konverze při vložení souboru do zdroje'' - při vložení souboru vybraného formátu do zdroje se aplikuje nastavená konverze s možností tuto konverzi nespustit
** ''Konverzní funkce spouštěná ručně'' - funkce pro konverzi se nabízí jako možnost úpravy souboru zvoleného formátu uloženého ve zdroji.
* '''Výsledek konverze''' - Jsou možné následující volby:
** ''Změna souboru'' - konvertuje se zvolený soubor, původně vložený soubor (v původním formátu) tedy nikde nezůstává
** ''Nový soubor ve stejném zdroji'' - původní soubor se ukládá do zdroje bez jakékoli změny, výsledkem konverze je nový soubor (nová varianta) ve stejném zdroji jako původní soubor.

Druhá záložka '''Konverze''' je závislá na zvoleném druhu souborů.

[[Image:referencniprirucka-zdroje-img068.png|center]]

Pro obrázky obsahuje záložka '''Konverze''' sekce '''Podmínky konverze''' a '''Formát výstupního souboru'''. Nastavení v sekci '''Podmínky konverze''' se používá tak, že pravidlo se aplikuje v případě, že alespoň jedna podmínka je splněna; pro konverzní funkce se podmínky konverze nepoužijí. Nastavuje se zde:

* '''Velikost souboru je větší než''' - pravidlo se aplikuje, pokud je soubor větší než zadaná hodnota v kB
* '''Maximální rozměry jsou větší než''' - pravidlo se aplikuje, pokud je překročen alespoň jeden rozměr (v obrazových bodech)
* '''Komprese je větší než''' - pravidlo se aplikuje, pokud je komprese souboru větší než zadaný údaj v procentech

V sekci '''Formát výstupního souboru''' se specifikují požadované výstupní parametry výsledného souboru. Jde o následující volby:

* '''Formát''' - vybírá se z rozevírací nabídky cílový typ souboru, obsahem nabídky jsou formáty souborů pro obrázky
* '''Komprese''' - zadává se cílová komprese v procentech
* '''Maximální rozměry''' - cílové maximální rozměry obrázku
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají funkci ''convert'' aplikace ImageMagick tak, jak jsou zde zadány bez dalších úprav. Seznam možných parametrů je na stránce [http://www.imagemagick.org/script/convert.php http://www.imagemagick.org/script/convert.php ]projektu. Tedy např. zadáním řetězce ''"-contrast"'' se předává parametr pro zvýšení kontrastu fotografie apod.

Pro videa se v záložce '''Konverze''' vyplňuje pouze formát výstupního souboru.

[[Image:referencniprirucka-zdroje-img069.png|center]]

Jde o následující volby:

* '''Formát''' - volí se buď formát videa, nebo možnost vytvoření jednoho snímku ze sekvence ve formátu JPEG (tato volba je vhodná pro generování statických náhledů pro publikované videosoubory použitelných v prezentační části).
* '''Kvalita''' - lze zvolit buď ''Automaticky'' (konverzní aplikace sama volí nejvhodnější nastavení) ''nebo Jako u originálu'' (konverzní aplikaci se předá požadavek na zachování kvality podobné původní videosekvenci).
* '''Maximální rozměry''' - maximální šířka a výška výsledné videosekvence
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají konverzní aplikaci '''FFmpeg''' tak, jak jsou zde zadány, seznam možných parametrů je na [http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html]. Pomocí těchto parametrů lze explicitně nastavit kodeky pro audio i video, samplovací frekvence apod.

<div class="note">Pro zadávání složitějších parametrů pro konverzi videa doporučujeme nejprve stáhnout aplikaci FFmpeg na lokální disk a odladit všechny parametry konverze na samostatném počítači - proces zpravidla vyžaduje několikanásobné opakování s různými parametry a posouzení výsledku (přehrání výsledného videa), což na webovém serveru není příliš vhodné provádět.</div>

Pro audia se v záložce '''Konverze''' vyplňuje pouze formát výstupního souboru.

[[Image:referencniprirucka-zdroje-img070.png|center]]

Jde o následující volby:

* '''Formát''' - volí se jeden z formátů, který je v typech souborů označen jako audio nebo video
* '''Bitrate''' - zadává se, pokud má jít o konstantní datový tok v bit/s. Je povolen zápis se znakem "k" na konci, čili hodnoty "128000" a "128k" jsou ekvivalentní.
* '''Kvalita''' - zadává se požadovaná kvalita v případě, že má jít o proměnlivý datový tok (VBR). Interpretace parametru závisí na formátu, např. pro formát ''ogg vorbis'' hodnota 60 odpovídá průměrnému bitrate 160 kbit/s apod.
* '''Další parametry''' - zadávají se možné další parametry konverze. Tyto parametry se předávají konverzní aplikaci '''FFmpeg''' tak, jak jsou zde zadány, seznam možných parametrů je na [http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html http://ffmpeg.mplayerhq.hu/ffmpeg-doc.html]. Pomocí těchto parametrů lze explicitně nastavit např. kodeky apod. Např. -''acodec libmp3lame'' vynutí použití kodeku LAME pro mp3, ''-ar 22050'' vynutí samplovací frekvenci 22050 Hz apod.

<div class="note">Poznámka: Seznam podporovaných audio kodeků je na adrese http://ffmpeg.mplayerhq.hu/general.html#SEC7, na vstupu je podporováno několik desítek zvukových formátů, na výstupu jsou z běžně používaných formátů podporovány AAC, FLAC, MP3, OGG, WMA (FLV používá pro zvukovou stopu MP3 kodek)</div>

Pro kompresi do formátu zip se v záložce '''Konverze''' vyplňují pouze podmínky konverze.

[[Image:referencniprirucka-zdroje-img071.png|center]]

Nastavuje se zde:

* '''Velikost souboru je větší než''' - pravidlo se aplikuje, pokud je soubor větší než zadaná hodnota v kB

<div class="note">Možnost vytvářet pravidla pro kompresi do zip formátu je dostupná pouze v případě, že aplikace WebToDate je instalována na serveru, na kterém je provozováno PHP verze 5 s podporou práce se zip archivy (např. na platformě MS Windows PHP extenze php_zip.dll). Na instalaci s PHP 4 není tato funkce k dispozici.</div>

=== Spouštění konverzních pravidel ===

Při vložení souboru do zdroje se vyhodnocuje, zda pro vkládaný formát souboru existuje nějaké konverzní pravidlo a pokud ano, zda jsou splněny podmínky pro konverzi definované v pravidle (např. rozměry obrázku přesahují definovanou velikost apod.). Pokud je zjištěno, že existuje alespoň jedno relevantní pravidlo, zobrazí se dialog pro potvrzení konverze.

[[Image:referencniprirucka-zdroje-img072.png|center]]

V dialogu se vypíše seznam relevantních pravidel. Pravidla, která jsou volitelná, mají vedle názvu zaškrtávací okénko, kterým lze zvolit, zda se konverzní pravidlo aplikuje. Automaticky spouštěná pravidla tuto volbu nemají. Tlačítko '''OK''' spouští postupně všechna pravidla. Tlačítko '''Storno''' stornuje proces konverze. Platí zde následující:

* Pokud jsou všechna nabízená pravidla pouze volitelná a použije se '''Storno''', vloží se do zdroje původní nekonvertovaný soubor.
* Pokud je alespoň jedno nabízené pravidlo automatické a použije se '''Storno''', žádné konverze se neprovádějí, ale zároveň se do zdroje žádný soubor nevkládá - původní soubor se ze serveru smaže a zdroj zůstává beze změny.

=== Spouštění konverzních funkcí ===

Ikona '''Úprava vlastností souboru''' ve formuláři pro úpravy zdroje vyvolává následující dialog. Pokud existuje alespoň jedna konverzní funkce pro daný formát souboru, zobrazí se v dialogu tlačítko '''Konvertovat'''.

[[Image:referencniprirucka-zdroje-img073.png|center]]

Tlačítko '''Konvertovat''' zobrazí dialog pro výběr a spuštění konverzní funkce. Na rozdíl od pravidel konverze se takto spouští vždy právě jedna konverzní funkce, která se vybírá radiopřepínačem.

[[Image:referencniprirucka-zdroje-img074.png|center]]

Tlačítko '''OK''' spouští zvolenou konverzní funkci, tlačítko '''Storno''' ruší volbu a soubor ve zdroji zůstává beze změny.

=== Externí konverze ===

V praxi může nastat případ, kdy je požadována konverze videosouborů, která má negativní vliv na výkonnost webového serveru (konvertují se dlouhá videa, velké množství videosouborů apod.). V takovém případě je možné nasadit konverzi na externím serveru. Princip je znázorněn na následujícím diagramu.

[[Image:referencniprirucka-zdroje-img075.png|center]]

Na externím serveru musí být nadefinovány dva adresáře:

* Vstupní adresář, do kterého se kopírují soubory, které se mají konvertovat
* Výstupní adresář, do kterého aplikace na externím serveru umístí výsledek konverze a ze kterého si konverzní funkce WebToDate tento výsledek stáhne.

Ve chvíli spuštění pravidla se soubor kopíruje do vstupního adresáře externího serveru. Na tomto serveru se pomocí procesu cron v pravidelných intervalech kontroluje obsah adresáře. Pokud je zjištěn soubor očekávaného typu, spustí se pomocí shell skriptu konverzní proces, který uloží výsledek do výstupního adresáře a vstupní soubor smaže.

Po zkopírování vstupního souboru na externí server PHP skript v pravidelných intervalech kontroluje výstupní adresář externího serveru. Ve chvíli, kdy zde nalezne zkonvertovaný soubor, jej stáhne a vloží do zdroje, který se zpracovává.

Externímu zdroji se nepředávají žádné parametry konverze. Pokud je třeba konverzi nějak parametrizovat (např. vytvořit jedno pravidlo pro konverzi do původního rozměru videa a jedno pravidlo pro konverzi do polovičního rozměru), založí se dva vstupní a dva výstupní adresáře - do jednoho vstupního adresáře jdou videa, která se mají zkonvertovat do původní velikosti, do druhého videa, která se mají zkonvertovat do poloviční velikosti atd.

<div class="note">Skripty či aplikace, které spouštějí konverzi na externím serveru, nejsou součástí dodávky WebToDate, toto je třeba zajistit individuálně dle požadavků toho kterého řešení.</div>

Při volbě této možnost konverze má záložka '''Konverze''' následující podobu:

[[Image:referencniprirucka-zdroje-img076.png|center]]

* '''Koncovka výstupního souboru''' - výběr formátu souboru (koncovky), který je očekáván ve výstupním adresáři
* '''Vstupní adresář''' - plná cesta k adresáři, kam se kopíruje soubor ke konverzi
* '''Výstupní adresář''' - plná cesta k adresáři, odkud se stahují zkonvertované soubory
* '''Timeout''' - timeout v sekundách, po tuto dobu PHP skript čeká, zda se ve výstupním adresáři objeví zkonvertovaný souboru

Z hlediska zpracování na serveru s WebToDate je postup následující:

# Dojde k uploadu zdrojového souboru běžným způsobem a vyhodnocení pravidel
# Spuštěné pravidlo nejprve kopíruje soubor pod náhodným unikátním jménem do vstupního adresáře konverze. Vkládaný soubor ''video1.avi'' se tedy kopíruje pod jménem např. ''10675455.avi''.
# Po nakopírování se v cyklu kontroluje výstupní adresář, hledá se soubor ''10675455.flv'' (tedy stejná jméno, ale koncovka dle nastavení parametrů pravidla).
# Kontrola se provádí po dobu daného nastavením timeoutu; pokud je doba překročena, vloží se do zdroje původní nekonvertovaný soubor
# Pokud vše proběhne v pořádku, je přesunut soubor ''10675455.flv'' na odpovídající místo na serveru WebToDate, přejmenován na cílové jméno (tomto příkladu ''video1.flv'') a vložen do zdroje.

Z hlediska externího serveru je třeba pro každé nasazení adhoc vytvořit konverzní shell skript spouštěný z cronu. V případě video souborů bude '''FFmpeg''' instalován i na cílový server a skript bude používat tuto aplikaci pro konverzi. Parametry pro '''FFmpeg''' budou vždy pevně dané a z vnějšku nejsou ovlivnitelné (nebo případně logika bude uložena přímo v tomto skriptu - např. pokud video přesahuje nějaké rozměry, zmenšit na zvolenou velikost apod.).

Doporučujeme, aby tento skript pro shell zajistil následující:

* Provedl vlastní konverzi
* Odstranil původní soubor ze vstupního adresáře
* Umístil výstupní soubor do cílového adresáře
* Mazal z cílového adresáře staré soubory (např. starší než jeden den), které mohly vzniknout tak, že na serveru WebToDate nastal timeout, přestože konverze proběhla v pořádku, ale trvala pouze příliš dlouho
* Vytvářel jednoduchý protokol pro hledání případných problémů

== Výměna souboru ve zdroji ==
V praxi se lze potkat s potřebou výměny souboru (např. obrázku či dokumentu ke stažení) za jiný, přičemž daný soubor je již použit v několika různých instancích ve zprávách. Můžeme mít např. ceník v PDF souboru, na nějž vedou odkazy z různých částí webu, tj. je připojen k více různým zprávám. Bez přímé podpory výměny tohoto souboru by bylo nutné odstranit všechna připojení ke všem zprávám, pak buď vyměnit soubor v existujícím zdroji, nebo přidat nový zdroj s novou podobou ceníku a pak tento zdroj ke všem zmíněným zprávám zase připojit, celkově by šlo o časově náročnou ruční práci.

V tomto příkladu si navíc lze představit dva typy požadavků:

# Jde skutečně o pouhou výměnu souboru – stará verze ceníku již není nikde potřeba a může se na webové prezentaci přepsat novou podobou.
# Jde o umístění nové verze ceníku na stejných místech na webové prezentaci, jako byla umístěna předchozí verze, ale původní verzi potřebujeme zachovat, buď pouze v databázi zdrojů WebToDate pro interní účely, nebo v nějaké stránce veřejně přístupné prezentace zobrazující nějaký archív dokumentů.

Obě tyto možnosti jsou podporovány, jedná se buď o fyzickou výměnu jednoho souboru ve vybraném zdroji, nebo o zachování původního souboru a přidání nového, na který jsou přesměrovány všechny existující instance původního souboru, tj. všechny odkazy ve zprávách, které původně vedly na starý soubor nyní vedou na nový soubor, ale původní soubor je uchován v databázi zdrojů, přičemž se může nacházet buď ve stejném zdroji jako původní soubor nebo v jiném.

Fyzická výměna souborů se provádí tlačítkem '''Vyměnit tento soubor''' v dialogu ''Úprava vlastnosti souboru'' (vyvolá se z formuláře pro úpravu zdroje v záložce '''Položky''' ikonou v řádku daného souboru).

[[Image:referencniprirucka-zdroje-img077.png|center]]

Použití tohoto tlačítka vyvolá nejprve funkci pro kontrolu možnosti výměny tohoto souboru. Soubor nelze vyměnit z hlediska přístupových práv v následujících případech:

* Soubor je připojen k alespoň jedné zprávě, ke které uživatel nemá přístup z hlediska týmů a rolí. To znamená, že buď zpráva patří týmu, jehož není uživatel členem, nebo zprávu nemůže modifikovat, protože je v daném týmu pouze redaktorem a zpráva je v takovém stavu, kdy ji redaktor modifikovat nemůže.
* Zpráva je uzamčena a má ji uzamčenu někdo jiný než aktuálně přihlášený uživatel.

Člen týmu ''Administrátoři'' může vyměnit soubor vždy.

Pokud tato kontrola zjistí, že soubor vyměnit nelze, zobrazí se chybové hlášení a výměna je odmítnuta jako celek, v opačném případě se zobrazí okno pro výběr souboru. Tento dialog je podobný dialogu pro přidání souboru do zdroje, chybí pouze část, ve které lze definovat umístění (adresář, název souboru) – soubor se nahrazuje, bude tedy umístěn do stejného adresáře pod stejným jménem jako původní soubor. Cílový soubor lze tedy vybrat z lokálního disku nebo ze schránky.

[[Image:referencniprirucka-zdroje-img078.png|center]]

Po výběru souboru se navíc kontroluje jeho typ. Není dovoleno vyměnit soubor za jiný typ (ani administrátorovi). Pokud je zjištěno, že uživatel vybral soubor jiného typu, opět je zobrazeno chybové hlášení "Při výměně souborů lze měnit pouze soubory stejného typu." a operace se neprovede. Dopadnou-li všechny kontroly dobře, je následně soubor nahrazen, pokud se nahrazuje varianta ''master'', může dojít k přegenerování interního náhledu a nakonec se zobrazí potvrzení o provedení záměny souboru.

Druhou možností je přesměrování instancí. V tomto případě se žádný soubor fyzicky nepřepisuje, ale všechny odkazy ze zpráv směřující na daný soubor se touto funkcí zamění na odkazy na jiný soubor, který je ve stejném nebo v jiném zdroji. Přesměrování instancí na jiný soubor se provádí takto:

* Nejprve se nový soubor vloží do databáze zdrojů, je jedno, zda se jedná o nový zdroj nebo stávající zdroj.
* V původním zdroji se vyvolá funkce '''Užití'''. Tato funkce obsahuje informace nejen o zprávách, ve kterých jsou soubory z daného zdroje použity, ale i o tom, který soubor ve které zprávě je použit, aby bylo jasné, čeho se výměna týká.
* Z okna '''Užití''' se vyvolá funkce pro přesměrování instancí. Zde se musí určit, instance kterého souboru v daném zdroji se mají nahradit (výběrem jedné z variant v tomto zdroji) a na který soubor mají po náhradě ukazovat. Je to možné buď zadáním ID souboru, nebo lze nastavit, že se jedná o soubor umístěný v uživatelském výběru, to ovšem za předpokladu, že ve výběru je právě jeden soubor. Pro uživatele je tedy jednodušší po vložení nového souboru do databáze zdrojů tento soubor přidat do výběru.
* Přesměrování se provádí na rozdíl od funkce pro fyzickou výměnu souboru postupně. Opět se vyhodnocují přístupová práva ke zprávě, pokud uživatel nemá práva danou zprávu měnit, pro tuto zprávu se instance nemění a pokračuje se na další zprávu. Může tedy dojít pouze k částečné výměně, a to u těch zpráv, u kterých uživatel výměnu provést může. Nekontroluje se zde typ, lze vyměnit jeden typ souboru (resp. odkaz na soubor z dané instance) za jiný.
* Zobrazí se detailní výpis informující o tom, které instance změněny byly a které eventuálně ne.

V prvním kroku je tedy třeba stanovit cílový soubor, na který se mají odkazy přesměrovat. Nejjednodušší je umístit tento soubor do uživatelského výběru, aby tato možnost byla použitelná, musí být do výběru vložen právě jeden soubor. Druhou možností je zapamatovat si ID souboru, toto ID se zobrazuje např. v záložce '''Položky''' formuláře pro úpravu zdrojů ve sloupci '''ID''' seznamu souborů ve zdroji.

Ve druhém kroku se přejde do formuláře pro úpravu zdroje, kde se nachází soubor, který je aktuálně připojen k nějakým zprávám, a instance ukazující na tento soubor chceme přesměrovat na jiný vybraný v předchozím kroku. Zde se použije tlačítko '''Užití''', zobrazí se následující dialogové okno.

[[Image:referencniprirucka-zdroje-img079.png|center]]

V horní části se zobrazí seznam položek z tohoto zdroje a seznam zpráv, kde je každá položka použita. Tučně je vyznačen soubor a základní informace o něm, pod ním se vždy nachází seznam zpráv, kde je daná položka použita. Klepnutím na název zprávy zde lze přejít do formuláře pro úpravu vybrané zprávy.

Ve spodní části okna jsou pak prvky, kterými lze nadefinovat popisované přesměrování odkazů. Nejprve se v rozevírací nabídce '''Soubor z tohoto zdroje''' vybere jeden ze souborů v aktuálně otevřeném zdroji, jehož existující instance chceme přesměrovat na jiný soubor. Dále se v radiopřepínači '''Změnit na''' vybere cílový soubor. Pokud je v uživatelském výběru právě jeden soubor, je aktivní možnost '''Soubor ve výběru''', v opačném případě je třeba vyplnit pole '''Soubor s ID'''.

Spuštění procesu přesměrování instancí se provede tlačítkem '''Změnit'''. V okně se začne vypisovat průběh funkce pro záměnu odkazů.

[[Image:referencniprirucka-zdroje-img080.png|center]]

Záměna je provázena vyhodnocováním přístupu ke zprávě stejně jako u funkce pro výměnu souboru ve zdroji, tj. uživatel musí mít ke zprávě přístup pro změny, zpráva nesmí být zamčená jiným uživatelem atd. Přístup se vyhodnocuje u každé zprávy zvlášť, vypisuje se nadpis zprávy a vedle toho buď text "Provedeno" nebo "Přístup odmítnut". Klepnutím na nadpis zprávy v tomto výpisu lze přejít na formulář pro editaci této zprávy, tlačítkem '''OK''' se výpis uzavírá.

Tato funkce povoluje přesměrování instancí na jiný typ souboru a jak je z výše uvedeného patrné, může dojít i k částečné záměně pouze tam, kde má uživatel přístup. Funkci lze vyvolat tlačítkem '''Užití''' i ze zdroje, který není uzamčen, protože s vlastními daty zdroje tato funkce nijak nemanipuluje.

== Změna master souboru ve zdroji ==
Pokud je ve zdroji více souborů, právě jeden z nich je vždy označen jako master. V rámci jednoho zdroje lze eventuálně vybrat jiný soubor ve zdroji a označit jej jako master. Funkce (bez dalšího potvrzování) označí daný soubor jako master daného zdroje a původní master "přesune" na jeho místo. Žádný soubor při tom nemění URL ani interní ID souboru.

Změna master souboru zdroje se provádí tlačítkem '''Označit jako master''' v dialogu ''Úprava vlastnosti souboru'' (vyvolá se z formuláře pro úpravu zdroje v záložce '''Položky''' ikonou v řádku daného souboru). Tlačítko je v dialogu jen v případě, že není tento dialog právě otevřen pro master soubor.

== Postup při publikování souborů a další doporučení ==
=== Doporučený pracovní postup ===

Doporučený nejméně pracný postup při vytváření zprávy, která pracuje s jedním nebo několika soubory je následující:

# Vložte soubory patřící ke zprávě do databáze zdrojů (pokud se tam ještě nenacházejí)
# V databázi zdrojů naplňte uživatelský výběr tak, aby obsahoval všechny soubory, které mají patřit ke zprávě.
# Založte zprávu, vytvořte její text, opatřete ji metadaty apod.
# Připojte výběr souborů ke zprávě, všechny soubory připojte v jednom kroku
# Otevřete tělo zprávy v zabudovaném celostránkovém editoru a na příslušná místa v textu vložte pomocí metody táhni a pusť instance (nejčastěji půjde o obrázky v těle textu zprávy)

Pokud chcete do databáze zdrojů vložit více obrázků najednou a ty pak použít v nějaké zprávě jako fotogalerii, přílohy či jednotlivé fotografie v textu, využijte možnosti hromadného vložení více souborů do zdrojů z uživatelské schránky.

=== Kdy je vhodné do jednoho zdroje vložit více položek ===

Nevkládejte do jednoho zdroje soubory, které k sobě nijak nepatří. Tato možnost je vhodná v následujících případech:

# Chceme dát k dispozici ke stažení stejný dokument, ale v různých formátech (MS Word, PDF, ZIP apod.). Tyto různé formáty je vhodné vložit do jednoho zdroje, vzhledem k tomu, že se jedná o stejný dokument by se na něj stejně měla vztahovat identická metadata apod.
# Chceme vytvořit více variant stejného obrázku. Typicky se jako ''master'' varianta vloží obrázek v tom nejvyšším rozlišení (resp. rozměrech), které chceme použít a následně se vytvářejí výřezy či zmenšeniny.

Výřezy a zmenšeniny není nutné vytvářet zabudovaným editorem, je možné si je připravit i na straně klienta v kvalitním bitmapovém editoru a následně do zdroje uložit. Zde ale nezapomeňte, že pro tento případ musí být v globálních předvolbách povoleno ukládat do zdroje více než jeden soubor.

=== Kdy je vhodné vytvořit ve zprávě více instancí souborů z jednoho zdroje ===

Vkládání více souborů ze stejného zdroje k jedné zprávě nebo dokonce více instancí stejného souboru se v podstatě kryje s předchozí kapitolou.

<code>
<nowiki>'''Příklad''': chceme v upoutávce zprávy zobrazit malý náhled a v těle zprávy větší obrázek. V jednom zdroji vytvoříme dvě varianty – jako master uložíme větší
obrázek a následně vytvoříme jako druhou variantu zmenšeninu. Oba tyto soubory dáme do uživatelského výběru a připojíme ke zprávě, každý pod jiným stylem (jeden styl bude pro
zobrazení obrázku jako upoutávky, druhý pro obrázek v textu).</nowiki>
</code>

Můžeme potřebovat i připojení stejného souboru dvakrát. Pokud např. chceme připojit ke zprávě PDF soubor a zobrazit jej jak v seznamu souborů ke stažení, tak jako odkaz uprostřed textu zprávy, je potřeba vytvořit dvě instance stejného souboru, jednu připojit k danému druhu seznamu, druhou pod vhodným stylem a klíčové slovo této druhé instance vložit do textu zprávy.

== Možnosti konfigurace databáze zdrojů ==
=== Globální konfigurace ===

Možnosti globální konfigurace databáze zdrojů ve WebToDate jsou shrnuty v následující tabulce.

{| class="prettytable"
| Konfigurace konverzní aplikace '''ImageMagick'''
| Pro nastavení vytváření náhledů jsou k dispozici následující volby:

*Vytvářet náhledy k obrázkům
*Maximální šířka a výška náhledu
*Cesta k adresáři s konverzní aplikací
*Vynucení stupně JPEG komprese pro náhledy obrázků

Dále je k dispozici konstanta pro seznam předdefinovaných velikostí obrázků používaná při vytváření nových variant obrázků a konstanta se seznamem URL obrázků, které lze vkládat jako vodoznak.
Několika konstantami lze nastavit výchozí hodnoty pro všechny parametry funkcí '''Doostřit''' a '''Vodoznak'''.

|-
| Konfigurace konverzní aplikace '''FFmpeg'''
| Nastavuje se cesta ke konverzní aplikaci pro videa a konstanta definující, ze kterého snímku videosekvence se vytváří náhledy (např. z páté sekundy videosekvencí)

|-
| Ukládání souborů
| Pro nastavení způsobu ukládání souborů lze nastavit následující volby:

*Způsob sestavení výchozí cesty pro uložení souboru
*Ukládání souborů fyzicky do databáze
*Způsob práce se jmény souborů (řešení duplicitních jmen apod.)
*Režim ukládání do privátní zóny (která zóna je výchozí a zda vůbec nabízet druhou z možností)
*Vynucovat umístění podle stavu zdroje (pokud je zapnuto a zdroj není ve stavu ''Publikováno'', soubory jsou v privátní zóně nezávisle na tom, jaké umístění je v souboru zvoleno).
*Možnost povolit publikování zdrojů i redaktorům
*Lze povolit nebo zakázat ukládání více než jednoho souboru do zdroje

|-
| FTP přístup ke schránce
| Lze nastavit adresu FTP serveru pro přístup ke schránce.

|-
| Funkce '''Obrázky'''
| Lze zvolit, zda je funkce '''Obrázky''' přístupná pouze administrátorům nebo všem.

|}

Podrobný popis konfiguračních konstant naleznete v kapitole [[../Konfigurace WebToDate#Globální konfigurace WebToDate|Globální konfigurace WebToDate]].

=== Typy souborů ===

WebToDate po instalaci obsahuje seznam rozeznávaných typů souborů, jejich ikon a povolených akcí. Typ souboru se rozeznává podle koncovky, podle rozpoznaného typu se určuje:

* Zda se jedná o obrázek, audio nebo videosekvenci v podporovaném formátu a je možné na něj aplikovat obrázkové operace (vytvořit náhled apod.)
* Pokud není možné vytvořit náhled, tak jaká ikona se pro tento obrázek zvolí.
* Jaký MIME typ se eventuálně posílá do prohlížeče (v případě, že se soubor zobrazuje přes prezentační skript a ne přímo).

Změny nastavení lze provádět pomocí funkce '''Administrace''' - '''Typy souborů'''. Po vyvolání této funkce se zobrazí v pravém horním rámci prohlížeče seznam typů daných koncovkami, po klepnutí na název koncovky lze měnit nastavení pro daný typ souboru.

[[Image:referencniprirucka-zdroje-img081.png|center]]

Definuje se zde:

* '''Typ souboru''' - koncovka souboru (malými písmeny)
* '''Druh souboru''' - volba ''obecný'' / ''obrázek'' / ''video'' / ''audio''. Pro typ ''obrázek'' se vytvářejí náhledy, nabízí se konverzní funkce a možnost úprav přes funkci pro zpracování obrázků. Pro typ video se vytvářejí náhledy a nabízí se konverzní funkce. Pro typ ''obecný'' nejsou k dispozici žádné speciální funkce a v seznamu zdrojů se takové soubory prezentují ikonou a nikoli náhledem.
* '''MIME typ''' - nastavení MIME pro daný typ souboru (např. ''application/pdf'' pro PDF soubory apod.)
* '''Soubor s ikonou''' - název souboru s ikonou, která se zobrazuje v redakčním rozhraní v případě, že pro soubor není možné vytvořit náhled.

Odpovídající ikony pro soubory, na které se odkazuje pole '''Soubor s ikonou''' formuláře pro úpravu typu souboru, se nacházejí v adresáři ''offlinedata/assetsicons'' - do tohoto adresáře si můžete v případě potřeby doplnit vlastní ikony.

<div class="note">Poznámka: Pro soubory s koncovkou ''swf'' je speciálně spouštěna funkce pro zjištění rozměrů nezávisle na nastavení konfigurace typů souborů.</div>

=== Konfigurace FTP přístupu ke schránce ===

Pomocí FTP přístupu lze obsah schránky libovolně měnit. Aby byl FTP přístup funkční, musí se správně nakonfigurovat FTP server a konstanta ''ASSETS_USERS_FTP_ACCESS''. Pokud je tato konstanta neprázdná, je aktivní tlačítko '''FTP přístup ke schránce''' v dialogovém okně pro zobrazení obsahu schránky. Tlačítko otevírá nové okno prohlížeče na příslušné ftp adrese.

V tomto okně pak lze manipulovat se soubory ve schránce pomocí rozhraní, které k tomu poskytuje prohlížeč Internet Explorer, tedy metodou táhni a pusť vkládat více souborů z lokálního disku nebo naopak více souborů najednou ze schránky mazat.

<div class="note">Z bezpečnostních důvodů je vhodné nastavit přístupová práva pro každého uživatele zvlášť a to na úrovni OS serveru (resp.FTP serveru), každý uživatel pak musí dostat další uživatelský účet a heslo pro tento ftp přístup. FTP adresa musí být taková, že směřuje na adresář ''offlinedata/assets/users''/.'' V tomto adrtesáři se nacházejí schránky jednotlivých uživatelů, pro každý podadresář zde tudíž budete musit nastavit zvláští přístup přes FTP server.
'''Nikdy pro tyto účely nepoužívejte anonymní ftp server, jednalo by se o mimořádné bezpečnostní riziko.'''</div>

Je možné pro všechny uživatele použít i stejný účet. Konfigurační konstantu lze pak nastavit na tvar

<code>
<nowiki>ftp://uz_jmeno:heslo@ftp.nasserver.cz/</nowiki>
</code>

Přístup ke schránkám je pak funkční, protože aplikace WebToDate pro každého uživatele doplní jeho cestu k jeho vlastní schránce, uživatelé se navíc nemusejí znovu přihlašovat. Nevýhodou ovšem je, že heslo je pak uvedeno v HTML kódu stránky (i když se jedná o redakční rozhraní veřejně nepřístupné) a uživatel WebToDate může teoreticky (přes jinou aplikaci pro ftp přístup) vstoupit do schránky jiného uživatele.

Soubor:Referencniprirucka-zdroje-img051.png

2019-08-30T07:15:12Z

Jardac: Jardac načtena nová verze "Soubor:Referencniprirucka-zdroje-img051.png"

[[Category:WebToDate Referenční]]
Referenční - Zdroje, dialog vložení souboru

WebToDate/Referenční/Klíčová slova WebToDate

2018-12-07T14:33:35Z

Jardac: /* Nový parametr pro relativní odkazy */

[[Category:WebToDate Referenční]]
[[Category:Referenční]]
Klíčová slova WebToDate mají vesměs tvar nepárových značek, které jsou HTML komentáři.

== Klíčová slova použitelná ve stylech a předlohách pro zprávy ==
Následující klíčová slova se používají v předlohách pro zprávy a ve stylech formátujících zprávy na stránkách.

{| class="prettytable"
| '''Pole'''
| '''Význam'''

|-
| <nowiki></nowiki>
| ID zprávy

|-
| <nowiki></nowiki>
| Nadpis zprávy

|-
| <nowiki></nowiki>
| Odkaz nadpisu

|-
| <nowiki></nowiki>
| Popis

|-
| <nowiki></nowiki>
| Tělo zprávy

|-
| <nowiki></nowiki>
| Obrázek

|-
| <nowiki></nowiki>
| Alt. obrázek

|-
| <nowiki></nowiki>
| Datum zprávy

|-
| <nowiki></nowiki>
| Čas zprávy

|-
| <nowiki></nowiki>
| Datum a čas aktualizace

|-
| <nowiki></nowiki>
| Autor

|-
| <nowiki></nowiki>
| Rubrika

|-
| <nowiki></nowiki>
| Priorita zprávy

|-
| <nowiki></nowiki>
| Link popisu

|-
| <nowiki></nowiki>
| Podtext

|-
| <nowiki></nowiki>
| Odkaz podtextu

|-
| <nowiki></nowiki>
| Číslo stránky

|-
| <nowiki></nowiki>
| Název publikace

|-
| <nowiki></nowiki>
| Číslo publikace

|-
| <nowiki></nowiki>
| Lokalizovaný název výchozí kategorie

|-
| <nowiki></nowiki>
| Číslo výchozí kategorie

|-
| <nowiki></nowiki>
| Název tématu

|-
| <nowiki></nowiki>
| Číslo tématu

|-
| <nowiki></nowiki>
| Název vydání

|-
| <nowiki></nowiki>
| Číslo vydání

|-
| <nowiki></nowiki>
| Číslo jazyka

|-
| <nowiki></nowiki>
| Zkratka jazyka

|}

Pokud je definována pro zprávy přizpůsobitelná struktura, pro pole v této struktuře se používají klíčová slova <nowiki>, tedy např. </nowiki>.

== Klíčová slova použitelná ve stylech a předlohách pro zprávy - výchozí přílohy ==
Pokud jsou ke zprávě připojeny soubory z databáze zdrojů, může být jedna tato instance (příloha) označena jako výchozí. Výchozí instance se může vyskytovat přímo ve stylu pro zprávu či v předloze, klíčová slova pro tento účel jsou identická jako [[../Klíčová slova WebToDate#Klíčová slova pro zdroje|Klíčová slova pro zdroje]].

== Klíčová slova použitelná ve stylech pro formátování seznamů ==
Klíčová slova pro styly formátující seznamy zpráv jsou stejná jako pro samotné zprávy, navíc lze použít následující konstrukce:

{| class="prettytable"
| <nowiki></nowiki>
| Použije se v případě, že se vkládá skutečná položka seznamu (viz kapitola [[../Seznamy|Seznamy]])

|-
| <nowiki></nowiki>
| Použije se v případě, že se dopočítává na celočíselný násobek (viz kapitola [[../Seznamy|Seznamy]])

|-
| <nowiki></nowiki>
| Vkládá kód, pokud se jedná o lichý řádek seznamu (viz kapitola [[../Seznamy|Seznamy]])

|-
| <nowiki></nowiki>
| Vkládá kód, pokud se jedná o sudý řádek seznamu. Pokud se styl aplikuje na jednu zprávu či zdroj, jedná se vždy o lichý (jakoby první) řádek, takže ROWEVEN nikdy nenastane. Pokud se aplikuje na seznam (zpráv či příloh ke zprávě - zdrojů), bere se interní číslování řádků výsledků od jedničky, čili první řádek je lichý. Pokud je seznam dělený, čísluje se interně od jedničky vždy, pokud se změní úroveň dělení, takže první řádek v dané úrovni je vždy lichý.

|-
| <nowiki></nowiki>
| Reprezentuje místo, kde se vloží navigační lišta; bez uvedení dalšího parametru se zobrazí výchozí navigační lišta, druhým parametrem může být systémový název definice navigační lišty, tedy např. <nowiki></nowiki>

|-
| <nowiki></nowiki>
| Reprezentuje výpis výsledků (např. ''Dokument 1 až 10 z 50'')

|-
| <nowiki></nowiki>
| ID seznamu, který je právě vykreslován (používá se vytváření URL stránky s detailem obrázku ve fotogalerii)

|}

== Klíčová slova použitelná v definici stránkování ==
Klíčová slova uvedená v této kapitole se používají pro definici zobrazování stránkování u stránkovaných seznamů, neboli ve formuláři '''Administrace''' – '''Nastavení - Stránkování'''.

=== Klíčová slova použitelná v definici stránkovací lišty ===

{| class="prettytable"
| <nowiki></nowiki>
| Klíčové slovo je nahrazováno za odkaz na určitou stránku v rámci stránkování seznamu

|-
| <nowiki></nowiki>
| Klíčové slovo je nahrazováno za pořadové číslo určité stránky v rámci stránkování seznamu

|}

=== Klíčová slova použitelná polích pro tvar URL ===
V polích '''URL první stránky''' a '''Suffix URL dalších stránek''' v definic stránkovací lišty lze použít následující výrazy:

{| class="prettytable"
| <nowiki></nowiki>
| Klíčové slovo je nahrazováno za prezentační URL stránky

|-
| <nowiki></nowiki>
| ID zobrazované stránky nebo zprávy

|-
| <nowiki></nowiki>
| zkratka zobrazované zprávy

|-
| <nowiki></nowiki>
| ID stránkovaného seznamu

|-
| <nowiki></nowiki>
| číslo stránky v rámci stránkování seznamu

|-
| <nowiki></nowiki>
| část URL za otazníkem tak jej generuje stránkovací lišta v nativním tvaru, čili např. ''<nowiki>pgid=173&conn=609&pg=4</nowiki>''

|}

=== Klíčová slova použitelná ve výpisu výsledků ===

{| class="prettytable"
| <nowiki></nowiki>
| Počáteční pořadové číslo zprávy na stránce v seznamu

|-
| <nowiki></nowiki>
| Koncové pořadové číslo zprávy na stránce v seznamu

|-
| <nowiki></nowiki>
| Počet nalezených zpráv celkem

|-
| <nowiki></nowiki>
| Pořadové číslo stránky v rámci stránkování

|-
| <nowiki></nowiki>
| Celkový počet stránek v rámci stránkování

|}

Tato klíčová slova umožňují jak výpis typu "Zprávy 1 až 10 z 50", tak vyznačování na úrovni stránkovacích stránek, tedy např. "1/5" (tj. první z pěti stránek).

== Klíčová slova pro zdroje ==
Tato klíčová slova se používají ve stylech formátujících zdroje (tj. instance souborů ze zdrojů ve zprávách, ať už se jedná o seznam příloh nebo samostatné instance v textu zprávy.

{| class="prettytable"
| <nowiki></nowiki>
| ID zdroje

|-
| <nowiki></nowiki>
| Nadpis zdroje

|-
| <nowiki></nowiki>
| Link nadpisu

|-
| <nowiki></nowiki>
| Popis

|-
| <nowiki></nowiki>
| Datum zdroje

|-
| <nowiki></nowiki>
| Čas zdroje

|-
| <nowiki></nowiki>
| Datum a čas aktualizace

|-
| <nowiki></nowiki>
| Autor

|-
| <nowiki></nowiki>
| Priorita zdroje

|-
| <nowiki></nowiki>
| Název publikace

|-
| <nowiki></nowiki>
| ID publikace

|-
| <nowiki></nowiki>
| Lokalizovaný název výchozí kategorie

|-
| <nowiki></nowiki>
| ID výchozí kategorie

|-
| <nowiki></nowiki>
| Číslo jazyka

|-
| <nowiki></nowiki>
| ID souboru

|-
| <nowiki></nowiki>
| Název souboru

|-
| <nowiki></nowiki>
| URL souboru

|-
| <nowiki></nowiki>
| Typ souboru

|-
| <nowiki></nowiki>
| Velikost souboru v B

|-
| <nowiki></nowiki>
| Šířka obrázku (videa, Flash animace,...)

|-
| <nowiki></nowiki>
| Výška obrázku

|-
| <nowiki></nowiki>
| URL souboru master pro aktuální zdroj

|-
| <nowiki></nowiki>
| ID souboru master pro aktuální zdroj

|-
| <nowiki></nowiki>
| Název souboru master pro aktuální zdroj

|-
| <nowiki></nowiki>
| Typ souboru master pro aktuální zdroj

|-
| <nowiki></nowiki>
| Velikost souboru master pro aktuální zdroj v B

|-
| <nowiki></nowiki>
| Šířka obrázku souboru master pro aktuální zdroj

|-
| <nowiki></nowiki>
| Výška obrázku souboru master pro aktuální zdroj

|}

== Podmíněné vkládání polí do stránek ==
=== Test naplnění obsahu pole ===

U všech výše uvedených polí lze využít podmíněného vkládání do stránek. K tomu se používají klíčová slova

<code>
<nowiki></nowiki>
<nowiki></nowiki>
</code>

kde se za jméno_pole dosadí název zvoleného pole. Pokud je toto pole prázdné, zobrazí se na místě podmínky jméno_poleNULL HTML kód který je obsažen v uvozovkách a podmínka jméno_poleNOTNULL se nahradí prázdným řetězcem, pokud pole není prázdné, zobrazí se na místě podmínky jméno_poleNOTNULL HTML kód který je obsažen v uvozovkách, a podmínka jméno_poleNULL se nahradí prázdným řetězcem.

<code>
<nowiki>Příklad užití: </nowiki>
<nowiki> </nowiki>
<nowiki>">")-->.</nowiki>
</code>

Pro zdroje je pak syntaxe podmíněného vkládání následující:

<code>
<nowiki></nowiki>
<nowiki></nowiki>
</code>

Tedy např.:

<code>
<nowiki></nowiki>
<nowiki></nowiki>
</code>

U zdrojů lze rozlišit, zda se jedná o položku – souboru, nebo o položku – odkaz (např. pro účely zobrazení ikon u odkazů):

<code>
<nowiki></nowiki>
<nowiki></nowiki>
</code>

Pro podmíněné vkládání polí z přizpůsobitelné struktury databáze zpráv se používá syntaxe podobná jako u zdrojů:

<code>
<nowiki></nowiki>
<nowiki></nowiki>
</code>

=== Test stavu zprávy ===

Další konstrukcí umožňující vkládat do stránky nějaký text podmíněně je test stavu zprávy. Syntaxe tohoto výrazu je

<code>
<nowiki></nowiki>
</code>

Používají se zde následující názvy stavů:

# ENTERED – vloženo
# PENDING - ke schválení
# APPROVED – schváleno
# PUBLISHED – publikováno
# SCHEDULED – odloženo
# EXPIRED – vypršelo
# ARCHIVED – archivováno

V praxi má smysl použít pouze stavy PUBLISHED nebo ARCHIVED, protože v ostatních případech by se podmíněně vkládaný text zobrazoval pouze v náhledu zprávy, což nemá přílišné využití.

Příkladem využití může být např. zobrazení informace o umístění zprávy do archívu v drobečkové navigaci. Pokud následující konstrukci umístíme v předloze pro zprávy do oblasti, ve které se nachází navíc nachází WebToDate navigace zobrazující tzv. drobečkovou navigaci, výsledek se může zobrazit tak, jak je naznačeno na následujícím otisku obrazovky.

<nowiki> » </nowiki>

[[Image:referencniprirucka-klicovaslovawebtodate-img172.png|center]]

== Klíčová slova pro listování fotogaleriemi ==
V těle stylu pro zdroje se v případě implementace listování fotogaleriemi (tj. možnosti posunu po jednotlivých fotografiích fotogalerie) mohou použít následující klíčová slova:

{| class="prettytable"
| <nowiki></nowiki>
| ID seznamu, který se právě zobrazuje (zde ID seznamu zobrazujícího fotogalerii)

|-
| <nowiki></nowiki>
| ID zprávy, ke které je právě zobrazovaná položka ze zdrojů připojena

|-
| <nowiki></nowiki>
| URL-enkódované URL zprávy převzaté z pole Odkaz nadpisu zprávy

|-
| <nowiki></nowiki>
| URL-enkódované URL právě zobrazované stránky

|}

Celý odkaz na zobrazení jedné fotografie má pak v nejjednodušším případě tvar

<code>
<nowiki><a href="/scripts/detail.php?id=&newsid=&listid="></nowiki>
</code>

Použijeme-li ve stylu pro zdroje formátujícího seznam náhledů obrázků ve fotogalerii výše uvedený výraz, znamená to, že návratová adresa ve stránce s detailem jedné fotografie (tj. v detailu zdroje) bude mít při dosazení za <nowiki></nowiki> výchozí tvar používaný WebToDate, čili ''/scripts/detail.php?id=xxx'', kde xxx je ID zprávy předané přes parametr ''newsid''. To nemusí být vždy žádoucí, např. pokud se zpráva s fotogalerií zobrazuje s vynucením nějaké šablony (přes parametr ''tmplid'' v URL) nebo se používají jiné SEO tvary URL zpráv, návratová adresa by mohla být jiná než původní adresa stránky se zprávou a mohlo by po kliku na návratové URL dojít i k zobrazení nesprávné stránky. Proto je možné uvést ještě parametr ''returnurl'', kterým se uvede, jaká je návratová adresa ze stránky s detailem zdroje. Odkaz má pak kód

<code>
<nowiki><a href="/scripts/detail.php?id=&newsid=&listid=&returnurl="></nowiki>
</code>

kde lze do parametru ''returnurl'' vkládat buď <nowiki> (pokud se má vždy návratová adresa shodovat s URL zprávy uloženém v poli Odkaz nadpisu zprávy) nebo </nowiki> (pokud se požaduje návrat na přesné URL, ze kterého se detail zdroje zobrazil).

V hlavičce a patičce stylu pro zdroje lze použít následující klíčová slova:

{| class="prettytable"
| <nowiki></nowiki>
| ID zprávy, ke které je právě zobrazovaná položka ze zdrojů připojena

|-
| <nowiki></nowiki>
| Odkaz nadpisu zprávy, ke které je právě zobrazovaná položka ze zdrojů připojena

|}

Tuto možnost lze využít k vytvoření odkazu na zobrazení fotogalerie v jiné předloze (např. kompletní fotogalerie) a to pouze v případě, že nějaká fotogalerie ve zprávě existuje.

<code>
<nowiki>Příklad: chceme mít možnost umístit do fotogalerie libovolné množství obrázků. Ve stránce se zprávou ale chceme zobrazit pouze první tři fotografie, kompletní fotogalerii pak
zobrazit až po kliku na nějaký odkaz ve stránce se zprávou. Toto lze řešit tak, že do předlohy pro zprávy umístíme seznam typu přílohy ke zprávě, který zobrazuje položky
z daného druhu seznamů, ale je omezen jen na tři položky. Dále vytvoříme další předlohu pro zprávy, která nemá např. vloženo tělo zprávy apod., ale má připojen seznam typu
přílohy ke zprávě, který zobrazuje položky ze stejného druhu seznamů, ale s neomezeným počtem položek.</nowiki>
</code>

Do hlavičky či patičky stylu zobrazujícího první tři fotografie ve stránce se zprávou pak umístíme odkaz

<code>
<nowiki><a href="&tmplid=255">Kompletní fotogalerie</a></nowiki>
</code>

kde 255 je ID druhé předlohy pro zprávy, která má zobrazit kompletní fotogalerii.

V předloze pro zdroje lze použít následující klíčová slova:

{| class="prettytable"
| <nowiki></nowiki>
| Odkaz na předchozí položku ve fotogalerii

|-
| <nowiki></nowiki>
| Odkaz na následující položku ve fotogalerii

|-
| <nowiki></nowiki>
| Pořadové číslo aktuální položky ve fotogalerii; pokud není v URL stránky uveden parametr ''listid'', dosadí se hodnota 1

|-
| <nowiki></nowiki>
| Celkový počet položek ve fotogalerii; pokud není v URL stránky uveden parametr ''listid'', dosadí se hodnota 1

|-
| <nowiki></nowiki>
| Odkaz na návrat zpět na fotogalerii

|-
| <nowiki></nowiki>
| ID zprávy, která obsahuje fotogalerii, do které aktuálně zobrazovaná položka patří

|}

Dále se mohou použít následující podmíněné výrazy:

<nowiki></nowiki> - kód se vkládá v případě, že existuje předcházející položka v galerii (aktuálně zobrazovaná položka není první)

<nowiki></nowiki> - kód se vkládá v případě, že existuje následující položka v galerii (aktuálně zobrazovaná položka není poslední)

<nowiki></nowiki> - kód se vkládá v případě, že je známá návratová adresa umožňující se vrátit zpět na fotogalerii (stránku s náhledy).

Příklad části předlohy pro zdroje obsahující funkci pro listování fotogalerií, je tedy následující:

<code>
<nowiki><div class="jednofoto"></nowiki>
<nowiki>" title="Předchozí obrázek v této fotogalerii"><< Předchozí</a>  ")--></nowiki>
<nowiki>" title="Následující obrázek v této fotogalerii">Následující >></a>")--></nowiki>
<nowiki> / ) | <a href="" title="Přeskočit na přehled všech obrázků v této
fotogalerii">Zpět na text</a><br /><br />")--></nowiki>
<nowiki><img src="" alt=""></nowiki>
<nowiki><br /></nowiki>
<nowiki><strong></strong></nowiki>
<nowiki>")--></nowiki>
<nowiki>")--></nowiki>
<nowiki></div></nowiki>
</code>

== Klíčová slova pro vkládání navigací ==
Pomocí klíčového slova <nowiki></nowiki> lze vložit WebToDate navigaci do stránky bez nutnosti přiřadit navigaci ze [[../Navigace a transformace|seznamu navigací]] do oblasti na stránce.

Klíčové slovo má dva parametry:

* ID [[../Navigace a transformace|navigace]], tak jak bylo přiděleno při založení nové navigace
* ID [[../Strom kategorií|kategorie]], tedy parametr určující pro příslušnou transformací, která kategorie je pro zobrazení navigace aktuální

Klíčové slovo se použije v těle WebToDate stylu nebo v šabloně stránky či předloze. V praxi se zpravidla v těle stylu použije konstrukce

<code>
<nowiki>)--></nowiki>
</code>

Díky tomu se navigace zobrazí u každé zprávy v závislosti na ID výchozí kategorie zprávy.

Příklad těla stylu využívajícího takto vloženou navigaci je následující:

<code>
<nowiki><div class="p1"></nowiki>
<nowiki></nowiki>
<nowiki><div class="popisek">)--></div></nowiki>
<nowiki><a href=""></a></nowiki>
<nowiki><div class="popisek2"></div></nowiki>
<nowiki></div></nowiki>
</code>

Výsledkem je zobrazení příslušné navigace zhruba tak, jak je vidět na následujícím otisku obrazovky.

[[Image:referencniprirucka-klicovaslova-navigace-priklad1.png|center]]

== Klíčová slova pro formátování ==
=== Velikost souborů ===

Pro speciální formátování je podporována možnost zobrazení velikosti souborů z databáze zdrojů v kB. Standardně je pro zobrazení velikosti k dispozici klíčové slovo <nowiki></nowiki>, které zobrazí velikost souboru v B. Kromě toho lze použít konstrukci, kterou lze zobrazit velikost v kB:

<nowiki>")--></nowiki>

Výraz má tedy tři parametry:

# Druh formátování – SIZE
# Předpis pro formátování – zde "kB" (převod na kB) nebo "MB" (převod na MB)
# Co se formátuje - <nowiki></nowiki> reprezentuje celé číslo – velikost v B, které se pomocí tohoto výrazu převádí na kB či MB.

Tento výraz je použitelný všude tam, kde samotné klíčové slovo <nowiki></nowiki>, tj. ve stylech pro seznamy příloh i pro jednotlivé instance zdrojů ve zprávách i v předloze pro zdroje (zobrazování přes skript ''detail.php'').

Jako třetí parametr nemusí být nutně uvedeno <nowiki>, může tam být jakýkoliv podporovaný výraz včetně konstantního čísla. Výraz </nowiki> tedy vrátí hodnotu 4. Při vyhodnocování se zjišťuje, jestli poslední parametr je celé číslo, pokud tomu tak je, provede se příslušné formátování, v opačném případě se vrací (tj. do stránky vloží) nezměněná hodnota třetího parametru.

Přepočet čísla v bytech na kB se provádí obvyklým zaokrouhlováním, minimum je ale 1, nikdy se tedy nezobrazí hodnota 0 kB. Při přepočtu se počítá 1 kB = 1024 B.

Druhou možností pro formátování velikosti souboru je

<nowiki>")--></nowiki>

Výraz má opět tři parametry:

# Druh formátování – SSIZE
# Oddělovač – znak(y) oddělující číslo a jednotku
# Co se formátuje - <nowiki></nowiki> reprezentuje celé číslo – velikost v B, které se pomocí tohoto výrazu převádí na jiné jednotky.

Formátování SSIZE vrátí zformátovanou velikost v závislosti na skutečné velikosti – velikost malých souborů (< 1 kB) bude velikost v bytech + znak B, středních (< 1 MB) v kilobytech + znak kB, velkých v MB plus znak MB. Druhý parametr definuje, co se vkládá mezi číslo a jednotku (např. mezera). Znaky jednotek (B, kB, MB) jsou zabudovány natvrdo a nejsou v parametrech.

=== Omezení délky vkládaného textu ===

Další možností konstrukce WTD_FORMAT je možnost omezit vložený text na nějaký maximální počet znaků. Typickým použitím je např. to, že chceme vkládat v nějakém seznamu popisy zpráv, ale zajistit, že ve stránce se zobrazí pouze např. prvních 200 znaků popisu. Syntaxe tohoto příkazu je následující:

<nowiki></nowiki>

Formátovací předpis obsahuje maximální výsledný počet znaků, volitelně řetězec, který se doplňuje, pokud dochází k oříznutí, a dále volitelně specifikace toho, zda dochází k převodu vybraných znaků na entity a odstranění HTML tagů (počet znaků je povinný, další údaje ne). Třetím parametrem (ořezávaný text) může být nějaký statický textový řetězec nebo nějaké klíčové slovo WebToDate.

Funkce pracuje tak, že pokud má třetí parametr tolik znaků kolik je uvedeno ve druhém parametru nebo méně, vrací přesně řetězec, který je třetím parametrem. Pokud má text více znaků je oříznut na daný počet znaků a od konce je navíc odříznuto poslední slovo nebo jeho zbytek (aby text nekončil v půli slova), na konec je doplněn řetězec daný druhou částí předpisu (doporučuje se HTML entita &hellip;, tj. 3 tečky, ale může to být cokoliv jiného).

Max. délka se tedy počítá dle znaků, to znamená např. entita &amp; je z 5 znaků z uvedeného počtu. Pro specifikaci převodu na entity a odstranění HTML značek se používají stejné parametry jako u [[#Převod znaků na HTML entity|<nowiki></nowiki>]].

Příkladem použití je výraz

<nowiki>")--></nowiki>

Toto znamená, že do stránky se vkládá popis zprávy. Pokud je popis kratší než 250 znaků, vloží se celý, pokud je delší, ořízne se výše popsaným způsobem a doplní se třemi tečkami.

V případě, že chceme zároveň převést vybrané znaky na entity a odstranit HTML tagy, použijeme následující tvar:

<nowiki>")--></nowiki>

Další příklady použití jsou např.:

<nowiki>")--></nowiki>

<nowiki></nowiki>

Tento výraz lze opět použít ve WebToDate stylech nebo v předlohách pro zprávy či zdroje.

=== Převod textu na malá nebo velká písmena ===
Je k dispozici převod formátovaného textu na malá resp. velká písmena. Příslušný výraz je

<nowiki></nowiki>

Parametry výrazu jsou

* volba formátování CHARCASE
* volba převodu na velká nebo malá písmena - možné hodnoty jsou UPPER a LOWER
* převáděný text

Příklad použití je tedy

<nowiki>")--></nowiki>

Pokud je hodnota druhého parametru jakákoli jiná než UPPER resp. LOWER, formátování vrací nezměněnou hodnotu třetího parametru (tj. formátovaný řetězec se do stránky vloží bez jakékoli změny).

<div class="note">'''Poznámka''': Je-li webová prezentace provozována v kódování utf-8, je pro správný převod znaků s diakritikou vyžadována instalace PHP extenze [http://cz.php.net/manual/en/book.mbstring.php mbstring]. Není-li extenze instalována, převod znaků s diakritikou v tomto případě není funkční. </div>

=== Formát data ===

Ve stránkách (stylech či předlohách pro zprávy) lze nastavit formátování konkrétního časového údaje. Syntaxe tohoto příkazu je následující:

<nowiki></nowiki>

V části formátovací předpis se uvádí formátovací řetězec v syntaxi PHP, kompletní seznam možností je uveden v dokumentaci PHP např. na stránce [http://cz.php.net/date http://cz.php.net/date]. Formátovaný časový údaj je pole WebToDate s datem (<nowiki>, </nowiki> apod.) nebo pevně daný řetězec s datem.

Příklady užití tedy jsou:

<nowiki>")--></nowiki> - zobrazuje datum aktualizace zprávy ve formátu 2007-11-27 (bez času)

<nowiki>")--></nowiki> - zobrazuje datum a čas aktualizace zprávy ve formátu 03.12.2007 11:55:00, tedy s úvodními nulami a s časem včetně sekund, hodiny ve 12ti hodinovém formátu

<nowiki>")--></nowiki> - zobrazuje datum a čas aktualizace zprávy ve formátu 26.11.07 21:16, tedy datum bez úvodních nul, z letopočtu jen poslední dvojčíslí, čas bez vteřin a s hodinami ve 24-hodinovém formátu.

=== Převod znaků na HTML entity ===

V některých případech je žádoucí v prezentační vrstvě automaticky převádět vybrané znaky v HTML kódu stránky na HTML entity, např. pokud má stránka vyhovět XHTML normě. Pomocí konstrukce WTD_FORMAT lze takto převádět následující entity v textu např. zprávy:

{|
|&quot;
| "
|-
|&amp;
| &
|-
|&lt;
| <
|-
|&gt;
| >
|}

Tento způsob formátování dále může z formátovaného textu odstraňovat HTML značky. Výrazem je tedy možné buď převádět vybrané znaky na entity nebo odstranit HTML značky nebo obojí najednou.

Syntaxe tohoto formátovacího příkazu je následující:

<nowiki></nowiki>

Za ''formátování'' lze zadat hodnoty:

* 0 (nebo jakákoli jiná hodnota kromě 1) - znaky " & <nowiki>< ></nowiki> se převádějí na výše uvedené entity
* 1 - kromě výše uvedených čtyřech znaků se ještě převádějí jednoduché uvozovky ' na číselnou entitu &#039;
* 0T - stejně jako hodnota 0, ale navíc se odstraní HTML značky
* 1T - stejně jako hodnota 1, ale navíc se odstraní HTML značky
* T - odstraní se HTML značky, na entity se žádné znaky nepřevádějí

Existuje tedy 5 přípustných hodnot parametru. Pokud je zadána jakákoli jiná hodnota parametru, formátovaný výraz se ve stránce ponechává beze změny.

Za výraz lze zadat nějaké klíčové slovo WebToDate odpovídající např. klíčovému slovu pro texty z databáze zpráv nebo zdrojů, nebo i statický text. Ve stylu či předloze pro zprávy tak lze použít např. výraz

<nowiki>")--></nowiki>

Tento výraz vloží do stránky nadpis zprávy a znaky " & <nowiki>< ></nowiki> vyskytující se případně v nadpisu zprávy převede před vložením do stránky na výše uvedené entity.

=== Převod řetězce na url-encoded tvar ===
V případě, že se má nějaký textový řetězec stát součástí nějakého URL uvedeného ve stránce, je vhodné jej převést na url-encoded tvar. To se dělá pomocí výrazu

<nowiki></nowiki>

Výraz má následující parametry:

* volba formátování URLENCODE
* způsob převodu
* formátovaný text

Pokud je zadán jako druhý parametr prázdný řetězec nebo cokoli jiného kromě hodnoty RAW, volá se na tuto konverzi PHP funkce [http://cz.php.net/manual/en/function.urlencode.php urlencode()], má-li druhý parametr hodnotu RAW, volá se PHP funkce [http://cz.php.net/manual/en/function.rawurlencode.php rawurlencode()].

Typická příklad použití je

<nowiki>")--></nowiki>

=== Formátování reálných čísel ===

Ve stránkách (stylech či předlohách pro zprávy) lze použít formátování reálných čísel, což má smysl zejména pro formátování položek přizpůsobitelné struktury databáze zpráv typu reálné číslo. Syntaxe tohoto příkazu je následující:

<nowiki></nowiki>

Řetězec ''formátovací předpis'' určuje formátování reálného čísla:

* Jako první nepovinný znak se uvádí oddělovač tisíců.
* Jako druhý znak je počet zobrazovaných desetinných míst.
* Jako třetí nepovinný znak se uvádí oddělovač desetinných čísel – desetinná tečka nebo čárka.
* Jako čtvrtý nepovinný znak je znak nahrazující desetinná místa, pokud jsou nulová – např. pomlčka. (pokud není definován, zobrazí se odpovídající počet nul)

Příklady použití výsledek:

<nowiki></nowiki> 9,10

<nowiki></nowiki> 9,-

<nowiki></nowiki> 9.000,00

=== Formátování pomocí regulárních výrazů ===
Ve stylech a předlohách lze použít formátování pomocí regulárních výrazů, což je vůbec nejuniverzálnější možnost, jak vybraný obsah stránek formátovat. Parametry se zadávají stejně jako u PHP funkce [http://cz.php.net/manual/en/function.ereg-replace.php ereg_replace()]. Syntaxe této možnosti formátu je následující:

<nowiki></nowiki>

Funkce nahradí část ''vstupního řetězce'', která vyhovuje regulárnímu výrazu (''pattern'') řetězcem ''náhrada''. V řetězci ''náhrada'' lze použít i metaznak ''\\číslice'', který určuje podvýraz regulárního výrazu. Metaznak ''\\0'' určuje celý řetězec vyhovující regulárnímu výrazu.

Jednoduché příklady použití možnosti formátování typu REGEXP jsou např.:

* Označení prvního znaku nadpisu zprávy tučně:

<nowiki>")--></nowiki>

* Nahrazení slova „Facebook“ v popisu zprávy plným odkazem na www.facebook.com:

<nowiki>")--></nowiki>

* Oříznutí popisu zprávy přesně na 100 znaků a doplnění tří teček na konec:

<nowiki>")--></nowiki>

* Nahrazení znaku @ za řetězec „- zavináč -“ v e-mailové adrese (při publikaci e-mailů např. v seznamu dotazů v modulu Poradny a rozhovory):

<nowiki>")--></nowiki>

* Vypsání jména před znakem @ v e-mailové adrese:

<nowiki>")--></nowiki>

* Vypsání názvu domény z e-mailové adresy za znakem @:

<nowiki>")--></nowiki>

Příklad WebToDate stylu pro zprávy, kde je pomocí tohoto formátování vyznačeno tučně první písmeno nadpisu zprávy, je tedy

<code>
<nowiki><div class="blok1"></nowiki>
<nowiki><a href=""></nowiki>
<nowiki>")--></nowiki>
<nowiki></a></nowiki>
<nowiki><div class="img160"></div></nowiki>
<nowiki><div class="desclarge"></nowiki>
<nowiki></nowiki>
<nowiki></div></nowiki>
<nowiki></div></nowiki>
</code>

== Klíčová slova pro podporu vícejazyčných webů ==
=== Vkládání odkazů na jiné jazykové verze zpráv či stránek ===

{| class="prettytable"
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Odkaz na jazykovou verzi stránky
| Vloží URL jazykové verze stránky zadané pomocí jejího ID, např.
<nowiki></nowiki> vloží odkaz na anglickou jazykovou verzi stránky s ID 20

|-
| <nowiki></nowiki>
| Odkaz na jazykovou verzi aktuální stránky
| Stejné jako v předchozím případě, ale za znak * se při generování vloží ID aktuálně generované stránky

|-
| <nowiki></nowiki>
| Odkaz na jazykovou verzi dané zprávy
| Vloží URL jazykové verze zprávy zadané pomocí jejího ID, např. <nowiki></nowiki> vloží odkaz na anglickou jazykovou verzi zprávy s ID 25

|-
| <nowiki></nowiki>
| Odkaz na jazykovou verzi aktuální zprávy
| Stejné jako v předchozím případě, ale za znak * se při generování vloží ID aktuálně zobrazované zprávy

|-
| <nowiki></nowiki>
| ID jiné jazykové verze aktuální zprávy
| Vloží ID jazykové verze aktuálně zobrazované zprávy v jazyce definovaném uvedenou zkratkou

|}

Pro nahrazování těchto klíčových slov hodnotou platí následující:

* Pokud je uvedeno konkrétní ID zprávy či stránky, nahradí se klíčové slovo odkazem okamžitě při generování stránky.
* Obsahuje-li klíčové slovo typu WTD_ART_LANG jako parametr hvězdičku, při generování stránky (tj. typicky předlohy pro zprávy) se toto klíčové slovo nenahradí a zůstává ve stránce. Konkrétní hodnota je dosazena až prezentačním skriptem při zobrazení celého textu zprávy.
* Obsahuje-li klíčové slovo typu WTD_PG_LANG jako parametr hvězdičku, nahradí se ve stránce hodnotou, jen pokud generovaná stránka nemá následníka ve stromu stránek, jinak ve stránce zůstává beze změny. To umožňuje toto klíčové slovo vložit do stránky, která je šablonou pro více různých stránek.

WebToDate může tato klíčová slova nahrazovat za absolutní odkazy, v závislosti na nastavení v konfiguračním souboru [[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]] nebo [[../Správa více virtuálních serverů|virtuálních serverech]]. Do klíčových slov lze doplnit třetí parametr s hodnotou rel, pak se budou generovat relativní odkazy začínající lomítkem, např.

<code>
<nowiki></nowiki>
</code>

=== Podmíněné vkládání odkazů ===

{| class="prettytable"
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Vloží kód, pokud existuje daná jazyková verze stránky s daným ID
| Vkládaný HTML kód může opět obsahovat značky WebToDate

|-
| <nowiki></nowiki>
| Vloží kód, pokud neexistuje daná jazyková verze stránky s daným ID
| Vkládaný HTML kód může opět obsahovat značky WebToDate

|-
| <nowiki></nowiki>
| Vloží kód, pokud existuje daná jazyková verze zprávy s daným ID
| Vkládaný HTML kód může opět obsahovat značky WebToDate

|-
| <nowiki></nowiki>
| Vloží kód, pokud neexistuje daná jazyková verze zprávy s daným ID
| Vkládaný HTML kód může opět obsahovat značky WebToDate

|}

Pro nahrazování těchto podmíněných výrazů platí stejná pravidla jako v předchozí kapitole, lze je tedy bez problémů použít jako v předlohách pro zprávy tak v šablonách stránek.

Příklady:

<code>
<nowiki>">English version</a>")--></nowiki>
<nowiki></nowiki>
<nowiki>">Anglická verze článku </a>")--></nowiki>
</code>

== Klíčová slova pro upozornění e-mailem ==
Následující klíčová slova se používají v [[../Úkoly#E-maily|definici obsahu e-mailů]] upozorňující uživatele redakční části na [[../Úkoly|úkoly]].

{| class="prettytable"
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID úkolu
|

|-
| <nowiki></nowiki>
| uživatelské jméno uživatele, který provedl akci, o které se informuje
|

|-
| <nowiki></nowiki>
| název úkolu
|

|-
| <nowiki></nowiki>
| popis úkolu
|

|-
| <nowiki></nowiki>
| plné URL, které otevře v prohlížeči formulář pro daný úkol
|

|-
| <nowiki></nowiki>
| plné URL zprávy, ke které se úkol váže
|

|-
| <nowiki></nowiki>
| stav úkolu
| např. ''Probíhá'' apod.

|}

== Další klíčová slova ==
V šabloně stránek lze použít klíčové slovo <nowiki></nowiki>, které reprezentuje titulek stránky. Toto klíčové slovo se ve stránce nahradí titulkem stránky pouze v případě, že stránka nemá následníka ve stromu kategorií. Analogicky funguje i klíčové slovo <nowiki></nowiki>, které reprezentuje URL právě generované stránky.

V šabloně stránek lze rovněž použít klíčové slovo <nowiki></nowiki>, které reprezentuje ID kategorie, ve které se stránka nachází.

WebToDate/Extenze/Extenze pro vkládání obsahu polí jiných objektů

2018-11-22T14:00:52Z

Jardac: /* Hledání objektů podle zkratky */

[[Category:WebToDate Extenze]]
[[Category:Extenze]]
==Funkcionalita==
Extenze je určena pro zprávy, obecně řečeno nahrazuje ve stránce značku obsahující ID objektu (zprávy či fragmentu) zvoleným polem z této zprávy či fragmentu. Ve stránce s celým textem dané zprávy tak lze jednoduše zobrazit obsah nějakého pole struktury jiné zprávy, kde tato vkládaná část jiné zprávy se identifikuje podle ID.

==Instalace==
Do souboru ''config/_modules_inc.php'' vložte následující kód:

<code>
<nowiki>// - extenze pro vkladani obsahu poli jinych objektu</nowiki>
<nowiki>$arrModules[] = 'nobjects/_insertfield_inc.php';</nowiki>
</code>

Ujistěte se, že v instalaci WebToDate existuje soubor ''/scripts/modules/nobjects/_insertfield_inc.php''.

==Reference==
Extenze vyhledává v kódu zprávy či stránky značky typu

<nowiki></nowiki>

Prvním parametrem je ID zprávy či fragmentu, druhý parametr je název pole tak jak se používá v klíčových slovech pro styly pro zprávy. Například

<code>
<nowiki></nowiki>
</code>

vloží nadpis zprávy či fragmentu s ID=1234.

Pro toto vkládání dále platí:

* Název pole v druhém parametru se nejprve vyhledává ve standardní množině polí databáze zpráv, pak v rozšiřující struktuře databáze zpráv, lze takto tedy vkládat i pole rozšiřující struktury.
* Pokud má pole příznak automatického řádkování (tělo zprávy nebo pole rozšiřující struktury, které tento příznak používají) a automatické řádkování je zapnuto, je obsah pole před vložením zformátován dle hodnoty tohoto příznaku.

Pro ladící účely je chování extenze vzhledem k nahrazování značky kódem následující:

# Pokud je ID zprávy či fragmentu v pořádku, objekt je ve stavu ''Publikováno'' nebo ''Archivováno'' a pole v druhém parametru je dle názvu identifikováno, je značka nahrazena příslušným kódem.
# Pokud je první parametr nula nebo prázdný řetězec a pole v druhém parametru je dle názvu identifikováno, je značka nahrazena prázdným řetězcem.
# Ve všech ostatních případech (ID neexistující nebo nepublikované zprávy či fragmentu, název neexistujícího pole v druhém parametru apod.) je značka v HTML kódu stránky ponechána – administrátor tak může prověřit, proč se očekávaný obsah nezobrazuje.

Kromě ID lze použít i zkratku, použitá značka má pak tvar

<nowiki></nowiki>

tedy např.

<code>
<nowiki></nowiki>
</code>

kde ''mojezprava'' je řetězec zadaný do pole '''Zkratka''' zprávy.

Objekt se v takovém případě vyhledává tak, že nejprve se hledá podle zkratky, pokud není objekt nalezen, hledá se podle zadaného ID.

==Příklad využití==
Uvažujme např. požadavek zobrazování různých zpráv, např. informací o produktech, kde u každé zprávy se má vedle popisného textu zobrazit blok s vysvětlivkami či popisky použitých ikon. Přitom je požadavek zobrazovat zprávy s využitím jedné stejné předlohy a používá se několik typů bloků s vysvětlivkami. Pro každou zprávu má smysl zobrazit právě jeden z bloků vysvětlivek, typ tohoto bloku má vybrat uživatel vkládající zprávu.

Založíme nové pole [[../../Referenční/Struktura obsahu|rozšiřující struktury databáze zpráv]], např. VYSVETLIVKY. Vytvoříme několik WebToDate [[../../Referenční/Fragmenty|fragmentů]], každý fragment obsahuje v těle kompletní HTML kód jednoho bloku s vysvětlivkami. Pro pole VYSVETLIVKY nadefinujeme [[../../Referenční/Struktura obsahu#Číselníky|číselník]], kde systémový název odpovídá názvu typu bloku s vysvětlivkami, hodnota odpovídá ID příslušného fragmentu.

Uživatel vkládající zprávu pak ve formuláři pro zprávu pouze pomocí rozevírací nabídky zvolí příslušný typ vysvětlivek. Tím v podstatě volí, který fragment se do stránky vloží.

V předloze pro zprávu použijeme kód

<code>
<nowiki>,BODY)--></nowiki>
</code>

Tento kód vloží do stránky se zprávou tělo fragmentu vybraného redaktorem výše uvedeným postupem.

WebToDate/Extenze/Extenze pro výpis seznamu příloh

2018-11-02T11:11:15Z

Jardac: /* Nové klíčové slovo extenze*/

[[Category:WebToDate Extenze]]
[[Category:Extenze]]
==Funkcionalita==
Touto extenzí lze v seznamu zpráv zobrazit u každé zprávy několik vybraných příloh ke zprávám. Modelovým nasazením je zobrazení seznamu fotogalerií. Každá fotogalerie je WebToDate zpráva, standardními prostředky WebToDate lze jednoduše zobrazit seznam takovýchto zpráv - galerií a u každé zprávy např. jeden náhled fotografie. Náhledy všech fotografií se pak zobrazí až po kliku na detail zprávy. Pokud ale chceme už v seznamu fotogalerií zobrazit např. první tři náhledy, lze to řešit např. pomocí této extenze.

Dále extenze podporuje možnost u zprávy (v seznamu či detailu) vybrat a vložit jeden z obrázků připojených ke zprávě (ať už samostatně nebo např. ke galerii), který je rozměrově nejvhodnější.

==Instalace==
Chcete-li tuto funkci aktivovat ve staticky generovaných stránkách, do souboru ''config/_genmodules_inc.php'' vložte následující kód:

<code>
<nowiki>// - extenze attachmlist</nowiki>
<nowiki>$$arrModules[] = 'nobjects/_attachmlist_inc.php';</nowiki>
</code>

Chcete-li funkci aktivovat v dynamicky vložených seznamech na stránkách, vložte stejný kód do souboru ''config/_modules_inc.php''.

Ujistěte se, že v instalaci WebToDate existuje soubor ''/scripts/modules/nobjects/_attachmlist_inc.php''.

==Reference==
Extenze používá klíčové slovo

<code>
<nowiki></nowiki>
</code>

ID druhu seznamu je zde ID, které lze zjistit v seznamu položek v nabídce '''Administrace''' -''' Druhy seznamů''' (viz [[../../Referenční/Seznamy#Druhy seznamů příloh|Druhy seznamů příloh]]).

V praxi se tedy použije např.

<code>
<nowiki>,2,16,3)--></nowiki>
</code>

Za <nowiki></nowiki> se při sestavování HTML kódu seznamu dosadí ID zprávy. Dále 2 je zde ID druhu seznamu (většinou druh používaný pro fotogalerie), 16 je ID stylu (jedná se o styl pro zdroje, kterým se formátuje seznam příloh - fotografií), zobrazují se max. 3 položky.

Jednoduchý WebToDate styl, který se v tomto příkladu dá použít pro zobrazení několika obrázků z galerie je

Hlavička
<code>
<nowiki><div class="fotogal"></nowiki>
</code>

Tělo
<code>
<nowiki><img src="" alt=""
width="" height="" border="0" hspace="2" vspace="2"></nowiki>
</code>

Patička
<code>
<nowiki></div></nowiki>
</code>

Výsledek pak může (pro jednu položku seznamu zpráv) vypadat cca následovně:

[[Image:extenze-seznamy-priloh-priklad.png|border|center]]

Druhé klíčové slovo které extenze podporuje je

<code>
<nowiki></nowiki>
</code>

Význam parametrů je následující:

* ID_zprávy - ID zprávy u níž se hledají připojené obrázky - vyberou se všechny připojené obrázky které jsou ve zdrojích ve stavu publikováno nebo archivováno; jaké přípony jsou platné pro obrázky se určuje podle funkce [[../../Referenční/Zdroje#Typy souborů|Typy souborů]]
* šířka obrázku - vybere se obrázek s nejbližší zde zadanou šířku, buď touto nebo větší, nebo v případě že žádný takový neexistuje, tak menší, ale jen maximálně dle dalšího parametru
* procenta_možného_zmenšení - např. 70%, znamená, že pokud se bude vkládat menší šířka obrázku, nesmí být menší než zde zadaná procenta, tj. pokud předchozí parametr bude 1000, skutečný obrázek nesmí být na šířku menší než 700
* class - hodnota se vkládá do atributu class obrázku
* alt - hodnota se vkládá do atributu alt obrázku

Za klíčové slovo se dosazuje celý ''img'' tag, pokud se nenajde žádný obrázek dle uvedených kritérií, tak prázdný řetězec.

WebToDate/Formuláře a katalogy/Reference

2018-11-02T10:13:44Z

Jardac: /* Číselníky */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''. Pokud je součástí katalogu pole pro odeslání souboru na server a je nastaveno odesílání mailů s novými záznamy, soubor se odešle jako příloha tohoto e-mailu.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

Číselníky slouží k vytváření vstupních polí pro editaci obsahu katalogu v administrační části, která se zadávají výběrem z možných hodnot; jedná se o analogii funkce [[../../Referenční/Struktura obsahu#Číselníky|Číselníky]] v jádru WebToDate.

Po vyvolání funkce '''Číselníky''' v nabídce modulu se zobrazuje obrazovka, kde lze přidávat a editovat názvy číselníků. Odkazem '''Přidat''' se přidává nový číselník, specifikuje se pouze název a způsob práce s výběrem z číselníku při editaci dat (rozevírací nabídka / text s automatickým doplňováním). Klepnutím na název číselníku lze editovat tato dvě nastavení.

Klenutím na ikonu složky vedle názvu číselníku se zobrazí seznam hodnot číselníku.

[[Image:formulare_a_katalogy-ciselnik.png|center]]

V horní části obrazovky je seznam hodnot, odkazem '''Přidat''' nebo klikem na text ve sloupci ''Hodnota'' se přechází do editace jedné položky číselníku. Zde se vyplňuje:

* '''Hodnota''' - hodnota položky číselníku jak se uloží do databáze při zadávání dat
* '''Systémový název''' - zobrazuje se jako položka číselníku, např. v rozevírací nabídce
* '''pomocný text''' - volitelný pomocný text s nápovědou pro položku číselníku
* '''Lokalizovaný název''' - zadává se text, který se zobrazí pro položku číselníku v prezentační části, lze zadat pro každý jazyk jiný

Číselník se následně propojuje s nějakým polem katalogu v nabídce modulu '''Administrace''' / ''název katalogu'' / '''Pole''', ve formuláři pro nastavení daného pole se zvolí '''Typ pole''': Číselník, a '''Použít číselník''': konkrétní vytvořený číselník.

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

Pro implementaci odesílání souborů na server se postupuje následovně:

* V datové tabulce se nadefinuje pole typu řetězec (např. varchar)
* V katalogu se typ pole označí jako ''Soubor''
* V HTML kódu formuláře se použije ''method="post" enctype="multipart/form-data"''
* Příslušné vstupní pole formuláře bude mít v předloze kód cca

<code>
<nowiki><input type="file" id="PRILOHA" name="PRILOHA" size="30" value=""/></nowiki>
</code>

Po uploadu jsou soubory uloženy do adresáře /offlinedata/catalogue/files/, v příslušném poli datové tabulky se nachází název souboru; může dojít k přejmenování souboru aby se zajistila unikátnost názvu souboru, nežádoucí znaky v názvu souboru apod.

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-02T09:50:37Z

Jardac: /* Číselníky */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''. Pokud je součástí katalogu pole pro odeslání souboru na server a je nastaveno odesílání mailů s novými záznamy, soubor se odešle jako příloha tohoto e-mailu.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

Číselníky slouží k vytváření vstupních polí pro editaci obsahu katalogu v administrační části, která se zadávají výběrem z možných hodnot; jedná se o analogii funkce [[../../Referenční/Struktura obsahu#Číselníky|Číselníky]] v jádru WebToDate.

Po vyvolání funkce '''Číselníky''' v nabídce modulu se zobrazuje obrazovka, kde lze přidávat a editovat názvy číselníků. Odkazem '''Přidat''' se přidává nový číselník, specifikuje se pouze název a způsob práce s výběrem z číselníku při editaci dat (rozevírací nabídka / text s automatickým doplňováním). Klepnutím na název číselníku lze editovat tato dvě nastavení.

Klenutím na ikonu složky vedle názvu číselníku se zobrazí seznam hodnot číselníku.

[[Image:formulare_a_katalogy-ciselnik.png|center]]

V horní části obrazovky je seznam hodnot, odkazem '''Přidat''' nebo klikem na text ve sloupci ''Hodnota'' se přechází do editace jedné položky číselníku. Zde se vyplňuje:

* '''Hodnota''' - hodnota položky číselníku jak se uloží do databáze při zadávání dat
* '''Systémový název''' - zobrazuje se jako položka číselníku, např. v rozevírací nabídce
* '''pomocný text''' - volitelný pomocný text s nápovědou pro položku číselníku
* '''Lokalizovaný název''' - zadává se text, který se zobrazí pro položku číselníku v prezentační části, lze zadat pro každý jazyk jiný

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

Pro implementaci odesílání souborů na server se postupuje následovně:

* V datové tabulce se nadefinuje pole typu řetězec (např. varchar)
* V katalogu se typ pole označí jako ''Soubor''
* V HTML kódu formuláře se použije ''method="post" enctype="multipart/form-data"''
* Příslušné vstupní pole formuláře bude mít v předloze kód cca

<code>
<nowiki><input type="file" id="PRILOHA" name="PRILOHA" size="30" value=""/></nowiki>
</code>

Po uploadu jsou soubory uloženy do adresáře /offlinedata/catalogue/files/, v příslušném poli datové tabulky se nachází název souboru; může dojít k přejmenování souboru aby se zajistila unikátnost názvu souboru, nežádoucí znaky v názvu souboru apod.

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

Soubor:Formulare a katalogy-ciselnik.png

2018-11-02T09:11:45Z

Jardac: Category:WebToDate Formuláře a katalogy Číselník modulu Formuláře a katalogy

[[Category:WebToDate Formuláře a katalogy]]
Číselník modulu Formuláře a katalogy

WebToDate/Formuláře a katalogy/Reference

2018-11-02T09:10:03Z

Jardac: /* Číselníky */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''. Pokud je součástí katalogu pole pro odeslání souboru na server a je nastaveno odesílání mailů s novými záznamy, soubor se odešle jako příloha tohoto e-mailu.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

[[Image:formulare_a_katalogy-ciselnik.png|center]]

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

Pro implementaci odesílání souborů na server se postupuje následovně:

* V datové tabulce se nadefinuje pole typu řetězec (např. varchar)
* V katalogu se typ pole označí jako ''Soubor''
* V HTML kódu formuláře se použije ''method="post" enctype="multipart/form-data"''
* Příslušné vstupní pole formuláře bude mít v předloze kód cca

<code>
<nowiki><input type="file" id="PRILOHA" name="PRILOHA" size="30" value=""/></nowiki>
</code>

Po uploadu jsou soubory uloženy do adresáře /offlinedata/catalogue/files/, v příslušném poli datové tabulky se nachází název souboru; může dojít k přejmenování souboru aby se zajistila unikátnost názvu souboru, nežádoucí znaky v názvu souboru apod.

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-02T08:41:44Z

Jardac: /* Odesílání příloh e-mailem */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''. Pokud je součástí katalogu pole pro odeslání souboru na server a je nastaveno odesílání mailů s novými záznamy, soubor se odešle jako příloha tohoto e-mailu.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

Pro implementaci odesílání souborů na server se postupuje následovně:

* V datové tabulce se nadefinuje pole typu řetězec (např. varchar)
* V katalogu se typ pole označí jako ''Soubor''
* V HTML kódu formuláře se použije ''method="post" enctype="multipart/form-data"''
* Příslušné vstupní pole formuláře bude mít v předloze kód cca

<code>
<nowiki><input type="file" id="PRILOHA" name="PRILOHA" size="30" value=""/></nowiki>
</code>

Po uploadu jsou soubory uloženy do adresáře /offlinedata/catalogue/files/, v příslušném poli datové tabulky se nachází název souboru; může dojít k přejmenování souboru aby se zajistila unikátnost názvu souboru, nežádoucí znaky v názvu souboru apod.

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-02T08:36:55Z

Jardac: /* Upload souborů */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

Pro implementaci odesílání souborů na server se postupuje následovně:

* V datové tabulce se nadefinuje pole typu řetězec (např. varchar)
* V katalogu se typ pole označí jako ''Soubor''
* V HTML kódu formuláře se použije ''method="post" enctype="multipart/form-data"''
* Příslušné vstupní pole formuláře bude mít v předloze kód cca

<code>
<nowiki><input type="file" id="PRILOHA" name="PRILOHA" size="30" value=""/></nowiki>
</code>

Po uploadu jsou soubory uloženy do adresáře /offlinedata/catalogue/files/, v příslušném poli datové tabulky se nachází název souboru; může dojít k přejmenování souboru aby se zajistila unikátnost názvu souboru, nežádoucí znaky v názvu souboru apod.

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-01T14:58:34Z

Jardac: /* Přidání kapitoly Číselníky*/

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Číselníky====

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-01T14:57:48Z

Jardac: /* Pole a Třídění */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů / Číselník/ Soubor''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo. Volba ''Číselník'' slouží k tomu, aby na pole byl napojen číselník s výběrem z možností. Volba ''Soubor'' se použije v případě, že pole slouží pro uložení souboru odeslaného pomocí vstupního formuláře v prezentační části.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-01T13:54:45Z

Jardac: /* Nastavení pro upload souborů */

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Maximální velikost souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, zadává se miximální velikost nahrávaného souboru v bytech
* '''Povolené koncovky souborů''' - v případě, že katalog má vstupní formulář v prezentační části a součástí katalogu je i pole pro upload souborů, lze takto omezit typy souborů, které lze na server odesílat; koncovky se oddělují středníkem
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

WebToDate/Formuláře a katalogy/Reference

2018-11-01T13:46:46Z

Jardac:

[[Category:WebToDate Formuláře a katalogy]]
[[Category:Formuláře a katalogy]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Kompletní nabídka modulu vypadá následovně:

'''Nástroje'''

:Položka

:Vyhledávací formulář

:Styly

:Vstupní formulář

:Potvrzovací formulář

'''Nastavení'''

:Seznam předpisů

:Globální

::Seznam katalogů

::Navigační lišta

::Filtr slov

::Další nastavení

:Předpisy

::''název předpisu''

:::Seznam položek

:::Jedna položka

:::Vyhledávání

:::Vkládání

'''Administrace'''

:Práva

:Antispamové profily

:Nový katalog

:''název katalogu''

::Pole

::Třídění

'''Data'''

:Seznam tabulek

:Katalogy

::''název katalogu''

:Import

:Export

:Soubory

:Protokoly

:Zakázané IP adresy

'''Nápověda'''

=== Nástroje ===

Funkce v této nabídce slouží k usnadnění práce při vývoji grafické prezentace katalogu, tj. stránek zobrazujících data katalogu i stránek se vstupními formuláři. Tyto funkce generují WebToDate fragmenty nebo WebToDate styly, které jsou v rámci vytváření definic těchto stránek využitelné. Princip fungování je v zásadě ten, že vždy vybereme, ke kterému katalogu chceme ten který element vygenerovat, funkce podle aktuální definice katalogu vygeneruje příslušný fragment (resp. styl). Tento objekt lze pak po stránce HTML kódu dále upravit a použít na příslušné předloze.
====Položka====
Funkce '''Položka''' generuje fragment, který můžeme použít jako část těla předlohy pro detailní zobrazení jedné položky katalogu.

[[Image:formulare_a_katalogy22-vytvoreni-html-fragmentu.jpg|center]]

V prvé řadě vyberte katalog, pro který chcete příslušný fragment vygenerovat. Dále vyberte jeho zařazení (kategorie apod.) a případně změňte název. Pomocí tlačítka '''Přidat HTML fragment''' se v databázi založí nový fragment, okamžitě se zobrazí tlačítko '''Vyhledat''', pomocí kterého lze přejít do režimu editace tohoto fragmentu.

V těle fragmentu se vygeneruje HTML tabulka se zhruba následujícím kódem.

<code>
<nowiki><table></nowiki>
<nowiki><tr valign="top"><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Skladatel</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Interpret</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosičů</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Nosič</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Čárový kód</td><td></td></tr></nowiki>
<nowiki><tr valign="top"><td>Na skladě</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>

Klíčová slova typu WTD_FC reprezentují jednotlivá pole datové tabulky katalogu, jejich názvy se samozřejmě pro každý katalog liší. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat na detailní stránce'''.

<div class="note">Fragment lze přiřadit na příslušnou předlohu pod vhodným stylem – tento styl typicky vkládá jen tělo fragmentu, jeho definice tedy vypadá většinou tak, že v těle obsahuje pouze klíčové slovo <nowiki></nowiki> (platí i pro všechny ostatní fragmenty v této kapitole).</div>

====Vyhledávací formulář====
Funkce '''Vyhledávací formulář''' generuje fragment s vyhledávacím formulářem použitelným pro daný katalog. Vygenerovaný kód vypadá zhruba následovně:

<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><label for="PRIJMENI">Příjmení</label></nowiki>
<nowiki><input type="text" id="PRIJMENI" name="PRIJMENI" value=""/></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledej!" /></nowiki>
<nowiki></form></nowiki>
</code>

Generují se ta pole, která mají ve vlastnostech nastaveno '''Použít při prohledávání'''. Takto vygenerovaný formulář je použitelný pouze v předlohách ke stránkám daného katalogu. Vyhledávací formulář lze vložit i na každou jinou stránku (např. úvodní stránku serveru), v tom případě je ale třeba předem nahradit klíčové slovo <nowiki></nowiki> za URL stránky pro zobrazování seznamu položek daného katalogu, tedy např. ''/scripts/modules/catalogue/list.php?catalogueid=2'' (včetně id katalogu).

====Styly====
Funkce '''Styly''' slouží k vygenerování WebToDate stylu formátujícího seznam položek katalogu. Tento styl se pak nastavuje v předpisu katalogu ('''Nastavení''' / '''Předpisy''' / název předpisu / '''Seznam položek'''). Vygenerovaný kód stylu je závislý na zvoleném katalogu, generuje se formou HTML tabulky, jeho tělo vypadá např. takto:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td><a href=""></a></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu WTD_FC opět reprezentují jednotlivá pole datové tabulky katalogu, klíčové slovo <nowiki></nowiki> reprezentuje URL pro zobrazení detailního pohledu na jednu položku. Generují se ta pole, která mají ve vlastnostech nastaveno '''Zobrazovat v seznamu''', odkaz se generuje na pole, které má nastavenou vlastnost '''Odkaz na detail''' (pokud takové existuje).

====Vstupní formulář====
Funkce '''Vstupní formulář''' slouží k vygenerování fragmentu s kódem pro formulář použitelný pro daný katalog na veřejné části. Do formuláře se generuje:

* Adresa skriptu pro uložení dat
* Chybová hlášení typu WTD_IF, která se zobrazují ve chvíli, kdy nastala některá z možností podle typu chybového hlášení
* Pole formuláře typu WTD_FCI
* Označení povinných polí s popiskem

Generují se ta pole katalogu, která mají ve vlastnostech nastaveno '''Data lze vkládat z veřejné části'''. Pole, která mají vlastnost '''Povinně vyplnit''', jsou ve vygenerovaném kódu označena.

<div class="note">Poznámka: Ve formuláři se jedná ale jen o grafické označení, povinné vyplnění dat je kontrolováno na straně serveru podle definice polí katalogu nezávisle na přesném tvaru vstupního formuláře.</div>

Definice polí katalogu obsahuje rovněž možnost zadat výchozí hodnotu. Tato výchozí hodnota se do kódu formuláře negeneruje, ale je vkládána až ve chvíli zobrazení stránky s formulářem záměnou za příslušné klíčové slovo typu WTD_FCI.

====Potvrzovací formulář====
Funkce '''Potvrzovací formulář''' slouží k vytvoření fragmentu, který lze použít pro zobrazení potvrzovací stránky před vlastním uložením dat do databáze. Výsledný kód je velmi podobný předchozímu případu, pouze pole typu WTD_FCI jsou ve formuláři vždy dvakrát – jednou v kódu stránky pro zobrazení, podruhé jako ''hidden'' pole formuláře za účelem vložení dat do databáze.

=== Nastavení ===

Tato část nabídky slouží k definování grafické podoby katalogů na veřejné části webu. Oddělují se dvě části – '''Globální''' a '''Předpisy'''. Globální nastavení je takové, které je společné pro celý modul, nastavení v předpisech jsou zpravidla jedinečná pro daný katalog (v některých případech je lze využít pro více katalogů se stejnou strukturou). ''Předpisem'' se rozumí souhrn nastavení pro více stránek – pohledů na data (seznam položek, jedna položka atd.)
====Seznam předpisů====
Pomocí funkce '''Seznam předpisů''' se zakládají nové předpisy, jedinou volbou při zakládání předpisu je jeho název. Po založení se předpis zobrazí v nabídce v této sekci '''Nastavení''', pod názvem předpisu jsou pak jednotlivé položky pro nastavení předpisu.

====Globální nastavení====
=====Seznam katalogů=====
Funkce '''Globální''' / '''Seznam katalogů''' definuje stránku zobrazující seznam katalogů na veřejné části. Tuto stránku (na URL ''/scripts/modules/catalogue/default.php'') lze využít v případě, že na serveru je definováno více katalogů určených pro zobrazování dat a chceme jednoduše zobrazit jejich seznam. Stránka je definovaná předlohou a stylem seznamu katalogů.

[[Image:formulare_a_katalogy24-nastaveni-parametru-seznamu-katalogu.jpg|center]]

URL s odkazem na daný katalog ve stylu seznamu katalogů se pak vždy generuje jako odkaz na stránku se seznamem položek katalogu, tedy /''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu''.

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

[[Image:formulare_a_katalogy25-navigacni-lista.jpg|center]]

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

# '''Předchozí''' – HTML kód určující formátování odkazu pro přechod na předcházející stránku
# '''Následující''' – HTML kód určující formátování odkazu pro přechod na další stránku
# '''Hlavička''' – HTML kód který je umístěn na počátku výsledného kódu navigační lišty
# '''Patička''' – HTML kód který je umístěn na konci výsledného kódu navigační lišty
# '''Číslo stránky''' – formátování jednotlivých čísel stránky, které umožní odkliknutí na zvolenou stránku
# '''Aktivní stránka''' – formátování údaje o čísle aktuální stránky
# '''Separátor''' – oddělovač mezi jednotlivými čísly stránek.
# '''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<nowiki> a </nowiki>.

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

[[Image:formulare_a_katalogy26-nastaveni-navigacni-listy.jpg|center]]

<div class="note">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í.</div>

=====Filtr slov=====
Funkce '''Filtr slov''' umožňuje definovat slovník nevhodných výrazů. V horním seznamu se zobrazují slova seřazená podle abecedy, ve spodním rámci se zobrazuje editační formulář.

[[Image:diskuze37-filtr-slov.jpg|center]]

Ve slovech lze používat hvězdičku jako zástupný znak pro více libovolných písmen.

Součástí definice filtrovaného výrazu jsou i příznaky, zda výraz použít při filtraci nežádoucích výrazů a při detekci spamu.

Výrazy označené pro použití při detekci spamu se použijí jen v případě, že v antispamovém profilu, který používá daný katalog, je zvolena možnost ''Vyhledávání spamu podle obsahu příspěvků''.

=====Další nastavení=====
Pokud je v katalogu zapnuta jakákoliv ochrana proti spamu, je třeba nadefinovat, jak se má chovat skript pro vkládání záznamů do katalogu v případě, že je příspěvek označen za spam a do databáze se nevloží. Toto chování definuje volba '''Je-li příspěvek detekován jako spam'''. Na výběr jsou následující možnosti:

* '''Ukončit běh skriptu''' - okamžitě se ukončí běh skriptu pro vložení záznamu. Skript vypíše pouze identifikační značku dané metody kontroly spamu.
* '''Zobrazit stránku pro vložení příspěvku''' - znovu se načte formulář pro vložení záznamu do daného katalogu.
* '''Přesměrovat na zvolenou stránku''' - přesměruje na stránku, kterou je nutné v případě této volby zvolit, jedná se o libovolnou stránku ze stromu kategorií WebToDate.

====Nastavení předpisů====
Dále se v nabídce '''Nastavení''' nacházejí jednotlivé předpisy a jejich nastavovací formuláře (za předpokladu, že je alespoň jeden předpis založen). Každý předpis se skládá z nastavení '''Seznam položek''', '''Jedna položka''', '''Vyhledávání''' a '''Vkládání'''. V následující tabulce jsou uvedena URL stránek, ke kterým se tato nastavení vztahují:

{| class="prettytable"
| '''Seznam položek'''
| '''/''scripts/modules/catalogue/list.php?catalogueid=číslo_katalogu'''''

|-
| Jedna položka
| ''/scripts/modules/catalogue/detail.php?.....''

|-
| Vyhledávání
| ''/scripts/modules/catalogue/search.php?catalogueid=číslo_katalogu''

|-
| Vkládání
| ''/scripts/modules/catalogue/iform.php?catalogueid=číslo_katalogu''

|}

Před uložením kteréhokoliv z těchto formulářů je třeba předem založit příslušnou předlohu resp. předlohy, doporučený postup je založit stránku typu předloha v kategorii Formuláře a katalogy, jako šablonu zvolit předpřipravenou šablonu stránek, která obsahuje vhodnou definici oblasti. Kódy specifické pro danou předlohu je vhodné umístit do separátních fragmentů a ty pak přiřadit na oblast na dané předloze (a předlohu vygenerovat). V rámci jednoho předpisu není povinné volit předlohy a nastavení ve všech čtyřech formulářích – pokud se např. daný katalog používá pouze pro sběr dat pomocí formuláře, není třeba nastavovat vlastnosti zobrazení všech položek či jedné položky apod., ale pouze nastavení pro vkládání dat.

Obecné schéma popisující kroky od použité šablony po výslednou dynamickou HTML stránku je na následujícím obrázku (platí pro všechny moduly WebToDate).

[[Image:formulare_a_katalogy27-schema-uziti-sablony-dhtml.jpg|center]]

=====Seznam položek=====
Formulář '''Seznam položek''' definuje předlohu stránky, styl seznamu položek a počet položek na jednu stránku v rámci stránkování. Všechna tato nastavení je nutno při uložení povinně vyplnit.

===== Jedna položka=====
Formulář '''Jedna položka''' definuje předlohu pro detailní zobrazení jednoho záznamu, jedinou možností v tomto formuláři je právě nastavení této předlohy.

=====Vyhledávání=====
Formulář '''Vyhledávání''' definuje vlastnosti samostatné vyhledávací stránky, jedinou volbou je zde předloha stránky. Výsledky hledání prezentuje stránka '''Seznam položek''', nikoliv tato stránka. Proto je tato stránka použitelná pouze v případě, kdy chceme mít na jedné stránce vyhledávací formulář a na druhé výsledek hledání. V opačném případě je možné vyhledávací formulář (tedy typicky tělo samostatného fragmentu) použít i na předloze stránky '''Seznam položek''', výsledek bude z hlediska funkčnosti identický.

=====Vkládání=====
Posledním formulářem v předpisu je '''Vkládání'''. Charakterizuje všechny stránky, které se mohou týkat vkládání dat do daného katalogu z veřejně přístupného adresáře. Jedná se o tyto předlohy:

* Předloha pro vstupní stránku – použije se pro stránku, ve které je formulář pro vložení dat. Tato volba je ve formuláři povinná, ostatní jsou nepovinné.
* Předloha pro potvrzovací stránku – použije se volitelně pro stránku, která zobrazuje formulář pro potvrzení vložení dat, data jsou v ''hidden'' polích formuláře. Stránka je potřebná pouze pokud se tato funkce používá, neboli ve vlastnostech katalogu je zvoleno '''Potvrzovací stránka''' : '''Ano'''.
* Odmítnutí přístupu – používá se v případě, že ve vlastnostech katalogu je nastaveno čtení nebo zápis s omezením na skupinu vybraných uživatelů.<div class="note">Poznámka: Funkce vyžaduje instalaci modulu [[../../Registrace a personalizace|Registrace a personalizace]].</div> Stránka se vyvolá v případě, že uživatel se úspěšně přihlásí k modulu Registrace a personalizace, ale patří do skupiny, která nemá k dané funkci přístup. Pokud je čtení nebo vkládání dat omezeno na všechny registrované uživatele (ne vybranou skupinu), stránka se nikdy nepoužije a není proto třeba ji nastavovat.
* Předloha pro e-mail – používá se jako předloha pro e-mail s obsahem formuláře zasílaný na adresu definovanou ve vlastnostech katalogu, je potřebná v případě, že je v těchto vlastnostech nastaveno '''Veřejný formulář vyvolává''': '''Odeslání e-mailu''' nebo '''Obojí'''.
* E-mail od - zadává se e-mailová adresa, ze které odcházejí e-maily s daty z formuláře pro vkládání dat do katalogu v prezentační části.

[[Image:formulare_a_katalogy28-nastaveni-parametru-vkladani-predloha-emailu.png|center]]

V případě využívání této funkce pro vkládání dat z formuláře je v zásadě třeba si připravit ještě jednu stránku, a to tu, která se má uživateli zobrazit po úspěšném vložení dat. URL této stránky se ale nedefinuje v tomto nastavení, ale přímo v kódu formuláře v poli ''returnurl''.

=== Administrace ===

Tato část nabídky slouží k zakládání nových katalogů, k definování jejich vlastností a k definování seznamu a vlastností polí katalogů.
====Práva====
První položkou nabídky jsou '''Práva'''. V tomto formuláři se způsobem obvyklým ve všech modulech nastavují práva pro editaci dat jednotlivých katalogů. Po založení katalogu mají právo na editaci dat pouze administrátoři. V tomto formuláři lze tato práva nastavit i pro členy vybraných týmů. V levé části vyberte příslušný katalog, v pravé části vyberte tým a pomocí příslušného tlačítka jej přeřaďte do seznamu '''Autorizované týmy'''.

====Antispamové profily====
V nabídce '''Antispamové profily''' se definují nastavení ochrany proti formulářovému spamu. Antispamový profil je pojmenovaná sada nastavení, pomocí kterých se vybírá, jaký typ ochrany se pro vkládání záznamů aplikuje. Na úrovni definice katalogu se pak vybírá odpovídající profil, který daný katalog použije. Všechny katalogy mohou využívat stejný profil nebo je možné nadefinovat více profilů a ty pak nastavit u různých katalogů dle potřeby.

V horní části okna prohlížeče je seznam profilů, klepnutím na název profilu se zobrazí formulář pro definici profilu.

[[Image:poradny-administrace-antispamoveho-profilu.png|center]]

Přidávat profily a měnit jejich nastavení je možné bez omezení, smazat profil lze jen když není použit u nějakého katalogu.

V následující tabulce je stručně uveden význam jednotlivých voleb, problematice spamu je věnována samostatná kapitola [[../Ochrana proti spamu#Ochrana proti spamu|Ochrana proti spamu]].

{| class="prettytable"
| '''Položka'''
| '''Význam'''
| '''Kroky potřebné pro implementaci'''

|-
| Kontrola URL volající stránky
| Pomocí http ''referer'' se kontroluje, že skript pro vložení záznamu je volán z formuláře zobrazovaného pomocí tohoto modulu na daném serveru. Pokud se cizí aplikace pokouší přímo přes http protokol vložit příspěvek (nevyplňuje formulář na serveru), je příspěvek detekován jako spam.
| Kontrola nevyžaduje žádné další kroky.

|-
| Formulářová návnada
| Do pole '''Názvy polí formuláře''' se zadá jeden nebo několik názvů HTML polí ve vstupním formuláři (názvy se oddělují středníkem). Kontrola zjišťuje, jestli některé z těchto polí není čímkoli vyplněno, pokud zjistí, že některé pole má hodnotu, je příspěvek označen za spam.
| Kontrola vyžaduje vložení jednoho nebo několika formulářových polí do HTML kódu vstupního formuláře pro zadávání nových záznamů. Pole musí být skryta před uživatelem (jako typ ''hidden'' či pomocí CSS). Člověk pak takové pole nevyplňuje, spamovací robot jej může vyplnit.

|-
| Seznam zakázaných IP adres
| Při vložení se kontroluje, zda IP adresa, ze které záznam přichází, není na seznamu zakázaných adres. Pokud tomu tak je, je položka označena za spam.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje zadání zakázaných IP adres pomocí funkce '''Data''' - '''Zakázané IP adresy''' nebo vložením IP adresy přímo z formuláře pro úpravu záznamu.

|-
| Vyhledávání spamu podle obsahu příspěvků
| V textu příspěvků se před vložením vyhledávají slova zadaná ve funkci '''Filtr slov''' s volbou '''Spam'''.
| Nevyžaduje žádné změny v prezentaci, ale vyžaduje naplnění seznamu nežádoucích výrazů pomocí funkce '''Filtr slov'''.

|-
| Opisování kontrolních kódů
| Uživateli jsou generovány do stránky kontrolní kódy, které musí opsat do daného textového pole. Lze navolit parametry kontrolních kódů - délku, zda se jedná o číslice či písmena apod.
| Vyžaduje do HTML kódu vstupního formuláře doplnění několika vstupních polí a klíčových slov modulu, aby bylo zajištěno zobrazení kontrolních kódů a zobrazilo se vstupní pole pro jejich opsání.

|}

====Nový katalog====
Pomocí další položky nabídky '''Nový katalog''' se zakládají katalogy.

[[Image:formulare_a_katalogy19-novy-katalog.jpg|center]]

Povinně se zde vyplňuje název katalogu, volí datová tabulka, nad kterou se katalog vytváří a pole pro jednoznačnou identifikaci záznamů v rámci dané datové tabulky (sloupec datové tabulky, který obsahuje vhodné jedinečné hodnoty, tyto hodnoty musí být použitelné v URL). Ostatní položky jsou nepovinné.

V nabídce '''Datová tabulka''' se ve výchozím stavu zobrazují názvy tabulek spravovaných modulem, tj. těch, jejichž názvy začínají na písmena KATD. Pokud je třeba založit katalog nad tabulkou s jiným názvem, existuje tato možnost – je toto třeba povolit v souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|config/global.php]]'' v konstantě CATALOGUE_TABLES (viz kapitola
[[../Instalace#Konfigurace v global.php|Konfigurace v global.php]]). Tato volba ovšem pak umožňuje manipulaci s daty této tabulky i s její strukturou (včetně smazání), takže tuto možnost je třeba používat s opatrností. Po založení katalogu již volbu datové tabulky nelze změnit.

V tomto formuláři lze dále volit:

* '''Předpis''' – změnou předpisu dojde ke změně grafických nastavení všech veřejně přístupných stránek patřících k danému katalogu. Jak je vysvětleno v kapitole [[../Pracovní postupy|Pracovní postupy]], při zakládání nového katalogu zpravidla ještě definice předpisu není vytvořená, výjimkou může být pouze opakované použití předpisu pro více katalogů s totožnou strukturou.
* '''Antispamový profil''' - volba [[../Ochrana proti spamu|antispamového profilu]]
* '''Data jsou přístupná pro čtení''' – tato volba definuje, kdo může zobrazovat data katalogu pomocí veřejně přístupných skriptů modulu. Pokud je zvoleno '''Nikomu''', stránky pro zobrazení dat katalogu vypíší pro dané ID katalogu chybové hlášení typu "Katalog nebyl nalezen" i v případě, že všechna ostatní nastavení (předpis apod.) jsou v pořádku a funkční. Další možnosti jsou '''Všem''' (tj. všem anonymním uživatelům) a '''Registrovaným''' s možností nepovinně ještě přístup omezit na vybranou skupinu uživatelů z modulu Registrace a personalizace. V případě, že je použita poslední volba, probíhá před zobrazením stránky s daty katalogu zjišťování, zda je uživatel k modulu Registrace a personalizace přihlášen, pokud tomu tak není, je přesměrován na přihlašovací stránku modulu Registrace a personalizace.
* '''Vkládat data mohou''' – tato volba je analogická předchozí volbě, pouze se vztahuje na možnost vkládání dat pomocí skriptu ''iform.php''.
* '''Přihlašovací režim''' – význam volby je stejný jako v ostatních modulech spolupracujících s modulem Registrace a personalizace. Možnost '''Vyžadovat přihlášení vždy''' vyvolá přihlašovací formulář vždy, když v rámci ''session'' není uživatel přihlášen, možnost '''Rozpoznávat registrované uživatele''' se pokouší identifikovat registrovaného uživatele pomocí cookies, které modul Registrace a personalizace vytváří. Pokud je uživatel pomocí tohoto ''cookie'' jednoznačně identifikován, je přihlášen automaticky, v opačném případě opět dojde na přihlášení přes formulář.
* '''Veřejný formulář vyvolává''' – pokud je daný katalog určen k tomu, aby pracoval se vstupním formulářem z veřejné části, v této volbě je třeba nadefinovat, zda se data z formuláře zapisují do datové tabulky, nebo odesílají e-mailem nebo oboje. Pokud je použito odesílání e-mailem, je třeba zadat e-mailovou adresu, na kterou se pošta odesílá a předmět těchto e-mailů.
* '''Potvrzovací stránka''' – v této volbě lze určit, zda po odeslání formuláře s daty dochází rovnou k zápisu dat nebo se má ještě zobrazit potvrzovací stránka a teprve po schválení v této potvrzovací stránce dojde k zápisu dat z formuláře.

Dále se v nabídce '''Administrace''' zobrazují jednotlivé katalogy. Klepnutím na název katalogu se zobrazují vlastnosti katalogu. Tento formulář je identický s formulářem pro založení nového katalogu, jedinou změnou je, že nelze změnit výběr datové tabulky.

====Pole a Třídění====
V nabídce se pod názvem katalogu zobrazují možnosti '''Pole''' a '''Třídění'''. Pomocí funkce '''Pole''' se zakládají pole katalogu, zpravidla platí, že co sloupec datové tabulky to jedno pole katalogu. Formulář pro vlastnosti polí je zobrazen na následujícím otisku obrazovky, každé pole je třeba explicitně do katalogu přidat (např. odkazem '''Přidat''' vpravo nahoře).

[[Image:formulare_a_katalogy30-nastaveni-polozky-katalogu.png|center]]

Význam jednotlivých políček tohoto formuláře je následující:

* '''Pořadové číslo''' – je třeba povinně explicitně zadat celé číslo, podle kterého se pole řadí. Podle tohoto čísla se řadí pole ve všech případech, kdy se generují fragmenty či styly v sekci '''Nástroje''', podle tohoto čísla jsou rovněž seřazena editační pole v automaticky sestavovaném editačním formuláři dat katalogu v administračním rozhraní v sekci '''Data'''.<div class="note">Nástroje: Ve vygenerovaném stylu či fragmentu lze ovšem dodatečně pořadí zobrazování polí katalogu jednoduše změnit prostým přesunem příslušných klíčových slov pro obsah polí v HTML kódu fragmentu či stylu.</div>
* '''Jméno pole v databázi''' – volí se z nabídky názvů polí tak jak jsou definována v datové tabulce katalogu.
* '''Zobrazování pole''' – zadává se povinně popisek. Tento popisek se používá jednak při zobrazování v administrační části (např. ve formuláři při editaci dat), dále jej používají funkce v sekci '''Nástroje''' při vytváření fragmentů či stylů – po vygenerování takového objektu lze ovšem opět tyto popisky v HTML kódu jakkoliv měnit či dokonce odstranit. Maximální délka popisku je 50 znaků.
* '''Zobrazovat v seznamu''' – udává, zda chceme zobrazovat pole ve stránce pro zobrazení seznamu položek katalogu. Pokud je zvoleno, nástroj pro generování stylu zahrne toto pole do zobrazení. Pokud klíčové slovo pro dané pole ze stylu pro zobrazení seznamu dodatečně odstraníme, pole nebude v seznamu zobrazováno. Pokud naopak dodatečně zrušíme tuto volbu v tomto formuláři, pole opět nebude zobrazováno, přestože odpovídající klíčové slovo ve stylu pro seznam položek zůstane.
* '''Odkaz na detail''' – toto pole má dvojí význam. Při generování stylu pro seznam položek se na toto pole umístit odkaz na detailní zobrazení (neboli HTML značka <nowiki><a></nowiki>), nástroj pro editaci dat katalogu v administrační části na toto pole umístí odkaz na otevření editačního formuláře pro editaci záznamu v seznamu záznamů.
* '''Zobrazovat na detailní stránce''' – pokud je tato volba zvolena, fragment vygenerovaný pomocí funkce '''Položka''' obsahuje klíčové slovo pro toto pole. Pokud klíčové slovo z fragmentu manuálně odstraníme, obsah pole se v detailním pohledu na jeden záznam nezobrazuje stejně tak jako v případě, kdy klíčové slovo ve fragmentu ponecháme ale dodatečně zrušíme tuto volbu v tomto formuláři.
* '''Používat při prohledávání''' – Tato volba má dvojí význam. Jednak specifikuje, že podle daného pole je možné prohledávání v administračním rozhraní při editaci dat, jednak toto pole generuje funkce '''Vyhledávací formulář''' v sekci '''Nástroje''' do příslušného fragmentu. Podporována je možnost hledání pouze u některých datových typů (podle definice typu v datové tabulce) – konkrétně pro textové datové typy a pro celočíselné datové typy. Pokud je tedy např. v datové tabulce sloupec typu ''datum'', nelze v tomto formuláři zvolit jeho prohledávání.
* '''Zobrazovat v seznamu při úpravách''' – pomocí této volby se specifikuje, která pole se zobrazují v seznamu položek v nástroji pro editaci dat v administračním rozhraní. Pokud potřebujete data katalogu v administračním rozhraní editovat, je třeba aspoň jedno pole katalogu označit touto volbou.
* '''Data lze vkládat z veřejné části''' – tato volba vyznačuje, že do tohoto pole je možné vkládat data pomocí vstupního formuláře veřejné části. Takto označená pole generuje funkce '''Vstupní formulář''' v sekci '''Nástroje''' do HTML kódu fragmentu. Pokud je dodatečně tato volba zrušena, je potřeba i příslušné klíčové slovo typu WTD_FCI odstranit z fragmentu – skript pro vkládání dat s klíčovým slovem příslušným k danému poli přestane pracovat a výsledkem je chyba typu FIELDSNOACCESS (viz chybové stavy v kapitole Veřejné skripty).
* '''Výchozí hodnota''' – v tomto poli lze definovat výchozí hodnotu, která se předvyplní jak v administračním rozhraní ve formuláři pro editaci dat, tak ve veřejném formuláři dosazením hodnoty za příslušné klíčové slovo typu WTD_FCI.
* '''Povinně vyplnit''' – volba vyznačuje, že pole musí povinně obsahovat nějakou hodnotu. Povinné vyplnění se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Jedinečná hodnota''' - volba vyznačuje, že pole musí obsahovat jedinečnou hodnotu v rámci daného sloupce datové tabulky. Hodnota se kontroluje jak při vkládání dat formulářem z veřejné části tak při editaci dat v administračním rozhraní.
* '''Typ pole''' - rozevírací nabídka s možnostmi ''Běžné pole / ID souboru ze zdrojů''. Volba ''Běžné pole'' je určena pro vstupní pole zadávaná běžným způsobem, která reprezentují nějaký text, číslo apod. Volba ''ID souboru ze zdrojů'' je určena k tomu, aby bylo možné do dané tabulky vkládat odkazy na soubory z databáze zdrojů pomocí jejich ID. Volbu ''ID souboru ze zdrojů'' lze provést jen pro takové pole datové tabulky, jehož datový typ je celé číslo.

Je-li nějaké pole označené jako '''Jedinečná hodnota''', '''Povinně vyplnit''' a zároveň je použito jako pole pro jednoznačnou identifikaci ve vlastnostech katalogu a jeho typ je celočíselný, modul jej při vkládání dat z veřejně přístupného formuláře autoinkrementuje, počáteční hodnota je 1.

Druhou funkcí je '''Třídění'''. Pomocí definic třídění se specifikuje, v jakém pořadí se budou zobrazovat položky katalogu v zobrazení seznamu položek, týká se to jak zobrazení na veřejné části webu tak v administračním rozhraní pro editaci dat. Pravidel pro třídění pro vybraný katalog lze zadat více, pořadí v jakém se třídící kritéria uplatní se definují ve formuláři pro editaci způsobu třídění.

[[Image:formulare_a_katalogy31-trideni-kriterii.jpg|center]]

Zadává se pole, podle kterého se třídí (výběrem z polí datové tabulky), pořadí v pravidlech třídění a způsob třídění (vzestupně, sestupně).

=== Data ===

Nabídka modulu v této části umožňuje:

* Zakládat nové datové tabulky, měnit jejich strukturu či je mazat
* Exportovat z datových tabulek data a naopak je do nich importovat
* Spravovat soubory k importu a exportované soubory
* Editovat data jednotlivých katalogů

====Seznam tabulek====
První položkou nabídky je '''Seznam tabulek'''. V pravé horní části se zobrazí seznam datových tabulek katalogu, u každé tabulky jsou tlačítka '''Náhled''', '''Export''' a '''Editovat'''.

Funkce '''Náhled''' je nejrychlejší způsob, jak zkontrolovat obsah tabulky – zobrazí v režimu pouze pro čtení prvních několik desítek záznamů v datové tabulce.

Společný formulář se používá pro zakládání nové tabulky (odkaz '''Přidat''' vpravo nahoře) a editaci struktury existující tabulky (tlačítko '''Editovat''').

[[Image:formulare_a_katalogy32-vytvareni-tabulky.jpg|center]]

Formulář má dvě záložky – v záložce '''Tabulka''' se zadává pouze jméno tabulky (automaticky se ke jménu předřazují písmena KATD), v záložce '''Sloupce''' lze měnit strukturu tabulky.

Editor struktury tabulek mění strukturu okamžitě po potvrzení editace daného řádku, nelze tedy např. přidat několik sloupců na straně prohlížeče a pak změnu dávkově odeslat na server. Tlačítko '''Odebrat sloupec''' funguje bez potvrzování, změna se okamžitě provede. Pokud klepneme do kteréhokoliv pole v editačním řádku, ostatní řádky se uzamknou a formulář je v režimu změny vybraného sloupce tabulky.

Názvy sloupců lze volit libovolně s těmito omezeními:

* Tabulka nesmí obsahovat dva sloupce stejného názvu
* Maximální délka názvu je 50 znaků
* Doporučujeme v názvech sloupců používat pouze písmena bez diakritiky a čísla, nikoliv např. mezery apod.

Datové typy se specifikují výběrem v poli '''Typ sloupce'''. Možné hodnoty jsou:

* Celé číslo
* Znak
* Řetězec
* Text
* Reálné číslo
* Datum

Typ ''Znak'' volte v případě, že pole má obsahovat menší a vždy stejný počet znaků. Typ ''Řetězec'' volte v případě, že pole obsahuje pokaždé jiný omezený (typicky do 255) počet znaků. Typ ''Text'' volte pro delší texty.

Délky polí lze volit pouze u typů ''Řetězec'' a ''Znak'', u ostatních polí se délky nastavují automaticky a nelze je měnit.
<div class="note">Řetězec a Znak: Maximální délky těchto polí jsou omezeny, omezení závisí na konkrétním typu použité databáze a její verze – tato omezení je třeba zjistit v dokumentaci k dané databázi, jedná se o maximální délky typů VARCHAR a CHAR.</div>

Pole lze rovněž opatřit databázovým indexem. Index je struktura databáze, která zrychluje přístup k datům podle daného sloupce. Použijte tuto možnost v případě, že se podle tohoto pole má třídit nebo vyhledávat. Pole typu ''Text'' nelze indexovat.

<div class="note">Strukturu datových tabulek lze měnit i v případě, že tabulka již obsahuje data. Je proto vhodné postupovat velmi obezřetně, data z odstraněného sloupce již rozhodně nelze obnovit.</div>

====Katalogy====
Další funkcí je editace dat katalogů. Pod nabídkou '''Data''' / '''Katalogy''' se zobrazují názvy existujících katalogů, klepnutím na název se přechází do nástroje pro editaci dat katalogu. Obrazovka může vypadat např. tak, jak je znázorněno na následujícím otisku.

[[Image:formulare_a_katalogy33-editace-katalogu.png|center]]

V horní části se zobrazuje stránkovaný seznam položek, vpravo nahoře jsou odkazy pro stránkování, přidání nového záznamu a přechod na vyhledávání. V seznamu se zobrazují ty sloupce, které mají v definici katalogu zvoleno '''Zobrazovat v seznamu při úpravách'''. Klepnutím na položku se ve spodní části otevírá editační formulář. Odkaz na otevření tohoto formuláře se umístí na to pole, které má v definici katalogu zvoleno '''Odkaz na detail'''.

Pomocí editačního formuláře lze záznamy měnit, mazat i přidávat. Formulář nemusí obsahovat všechny sloupce datové tabulky – obsahuje jen ty sloupce, pro které je definováno pole katalogu. Pořadí polí ve formuláři je dáno vlastností '''Pořadové číslo''' v definici pole katalogu. Formulář používá i další vlastnosti polí katalogu jako výchozí hodnoty a jedinečnost údaje ve sloupci tabulky. Je-li součástí formuláře pole pro jednoznačnou identifikaci, jeho popisek je zvýrazněn tučně. Pokud je pole označeno jako ''Povinně vyplnit'', přidávají se za název pole v popisku formuláře znaky (*). Pokud je pole v datové tabulce typu ''text'', objevuje se vedle vstupního pole ikona WYSIWYG editoru, po klepnutí na tuto ikonu lze obsah tohoto pole měnit a formátovat pomocí tohoto editoru.

Je-li v definici polí katalogu pole typu ''ID souboru ze zdrojů'', příslušný řádek formuláře pro toto pole vypadá tak, jak je patrno z následujícího otisku obrazovky (pole "Obrázek").

[[Image:formulare_a_katalogy-data-s-obrazkem.png|center]]

Do pole lze pak vložit jen celé číslo, které existuje jako ID souboru v databázi zdrojů. Pomocí tlačítka '''Náhled''' se vyvolá náhled tohoto souboru v novém okně prohlížeče, pomocí tlačítka '''Vložit''' se vyvolá formulář pro výběr souboru z databáze zdrojů.

[[Image:formulare_a_katalogy-vyber-obr.png|center]]

V horní části tohoto okna je vyhledávací formulář pro vyhledávání v databázi zdrojů, vyhledat můžete dle jakékoli kombinace metadat. Ve spodní části se po vyhledávání zobrazí seznam zdrojů odpovídající vyhledávací podmínce, u každého zdroje je seznam všech souborů ve zdroji. Klepnutím na šipku vlevo od názvu souboru se do formuláře pro editaci záznamu katalogu vkládá ID souboru, po klepnutí na šipku se toto okno uzavírá.

Vyhledávání používá ta pole, která mají v definici katalogu nastaveno '''Používat při prohledávání'''. Pokud je vyplněno více polí vyhledávacího formuláře, spojují se ve vyhledávací podmínce logickou spojkou "a zároveň".

[[Image:formulare_a_katalogy34-vyhledavani-zaznamu.jpg|center]]

Je-li nastaveno prohledávání podle aspoň jednoho textového pole, obsahuje formulář zaškrtávací okénko z volbou, zda prohledávat jen začátky textových polí. Pokud je toto zvoleno, musí obsah pole začínat na zadaný text, v opačném případě musí pole obsahovat (kdekoliv) zadaný text. Žádné složitější vyhledávací výrazy nejsou podporovány.

Jako poslední jsou v v nabídce '''Data''' funkce pro export a import dat. Pro manipulaci se soubory, které se mají importovat, resp. s exportovanými soubory slouží funkce '''Soubory'''. Grafické rozhraní této funkce zpřístupňuje obsah adresáře ''wwwroot/data'' a jeho podadresářů. Výchozí složky jsou

''/data/katalogy/export/''

pro export dat, resp.

''/data/katalogy/import/''

pro import dat. Adresář pro import lze změnit tak jak je popsáno v kapitole Konfigurace v global.php. Je nutné ručně zajistit, aby exportní i importní adresář existovaly, v opačném případě funkce pro export resp. import nejsou funkční.

V levé části okna pro soubory se přechází mezi složkami. V pravé části se zobrazuje obsah složky, klepnutím na název souboru se zobrazí jeho náhled, tak jak je vidět na následujícím otisku obrazovky.

[[Image:formulare_a_katalogy35-zobrazeni-struktury-slozek-nahledy.jpg|center]]

Tlačítko '''Přidat soubor''' použijte v případě, že chcete do adresáře na serveru kopírovat soubor připravený k importu a umístěný na lokálním disku počítače. Naopak tlačítko '''Stáhnout soubor''' použijte v případě, že chcete na lokální disk stáhnout exportovaný soubor.
<div class="note">Poznámka: Maximální velikost souboru při kopírování z lokálního počítače na server je omezena nastavením v souboru ''php.ini'', v případě práce s většími soubory je tedy třeba nejprve zkontrolovat toto nastavení, případně nakonfigurovat k adresáři přístup přes ftp server či jiný podobný způsob přímého přístupu.</div>

====Import====
Funkce '''Import''' nejprve v pravé horní části okna zobrazí seznam souborů v importním adresáři. Klepnutím na název souboru se otevírá ve spodní části formulář pro spuštění importu.

[[Image:formulare_a_katalogy36-import-dat-ze-souboru.jpg|center]]

V záložce '''Soubor''' se nachází pouze informace o tom, který soubor bude importován. V záložce '''Tabulka''' se nacházejí důležitá nastavení importu. V prvé řadě se zde volí, zda se importuje do existující tabulky nebo má import založit novou tabulku. Pokud se importuje do existující tabulky, lze zvolit, zda nová importovaná data pouze přidat a stávající ponechat nebo původní data nejprve smazat. Tlačítko '''Náhled''' zobrazí v novém okně náhled na importovaná data (prvních několik desítek záznamů), tlačítko '''Import''' spouští vlastní import dat.

Importovat lze z jednoho z podporovaných formátů dat, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF

| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML

| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:
*Název kořenového elementu může být libovolný
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><NAZEV></nowiki> apod.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV

| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.
Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.
Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

<div class="note">Při používání importu doporučujeme používat obvyklé konvence pro názvy sloupců tabulek apod., tj. spíše kratší jména, bez diakritiky, pouze písmena a číslice. Funkčnost importu je do značné míry daná tím, jak pracují příslušné funkce PHP – např. PHP funkce zjišťující název sloupce tabulky vrací pro databázi MS SQL Server maximálně 30 znaků, je-li název sloupce delší, import nemůže proběhnout.</div>

====Export====
Pomocí funkce '''Export''' lze exportovat data nejen z tabulek, které spravuje modul Formuláře a katalogy, ale ze všech tabulek databáze, kterou instalace WebToDate používá. V pravé horní části se zobrazuje seznam těchto SQL tabulek, v každém řádku je tlačítko '''Náhled''', které ve spodním rámci zobrazí prvních několik záznamů v tabulce, a dále tlačítko '''Export''', které vyvolá ve spodním rámci formulář pro export dat.

[[Image:formulare_a_katalogy37-export-dat-tabulky.jpg|center]]

První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:formulare_a_katalogy38-export-souboru.jpg|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
====Soubory====
Exportovaný soubor je exportní funkcí uložen do adresáře pro export, ze kterého je možné jej stáhnout pomocí funkce '''Soubory'''.

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="5"| DBF
| PHP funkce pro manipulaci s DBF soubory nepodporují datový typ MEMO, neboli dlouhé texty. Sloupce typu MEMO v importovaném DBF souboru se při importu ignorují.

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců z DBF souboru a přiřadí se jim nejpodobnější datové typy SQL databáze.

|-
| Při importu do existující tabulky se porovnávají názvy sloupců v SQL tabulce a v importované tabulce a importuje se vyhledáváním sloupců se stejným názvem. To znamená, že struktura SQL tabulky nemusí být identická se strukturou importovaného DBF souboru – pokud jsou v DBF souboru nějaké sloupce navíc, ignorují se, pokud jsou naopak navíc nějaké sloupce v SQL tabulce, dosadí se do nich při importu hodnota ''null''.

|-
| DBF formát obsahuje standardně nezobrazovaný sloupec nazvaný ''deleted'', pomocí kterého se v tomto formátu označují odstraněné řádky. Import s tímto sloupcem pracuje – pokud import automaticky zakládá novou tabulku, vytvoří se i sloupce nazvaný ''deleted''. Tento sloupec lze ale z SQL tabulky odstranit a bez problémů z DBF souboru importovat (viz předchozí poznámka).

|-
| Texty musí být v DBF souboru v takové kódové stránce v jaké mají být uloženy v SQL databázi, při importu nedochází k překódování.

|-
| rowspan="4"|XML
| Konvence ohledně pojmenování XML elementů v importovaném souboru je následující:

* Název kořenového elementu může být libovolný
* <nowiki>Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy musí jmenovat <row></nowiki>
* <nowiki>Elementy pro jednotlivá pole jsou pojmenovány stejně jako názvy sloupců v datové tabulce, tedy např. <NAZEV> apod.</nowiki>

|-
| Je-li SQL tabulka při importu zakládána automaticky, převezmou se názvy sloupců podle XML struktury. Všechny automaticky založené sloupce datové tabulky v SQL databázi budou mít typ ''řetězec'' o délce 255 znaků. Pokud se tedy používá automatické zakládání tabulky při importu, je vhodné následně nastavit správné datové typy pro sloupce tabulky. Další vlastnost, která z tohoto chování vyplývá je ta, že v tomto případě budou všechny texty oříznuty na délku max. 255 znaků. Pokud tedy XML elementy obsahují texty delší než 255 znaků, je třeba buď nejprve strukturu tabulky založit ručně nebo po importu strukturu odpovídajících sloupců změnit (na typ ''dlouhý text'') a import spustit ještě jednou.

|-
| Datumy by v importovaném souboru měly být v XML formátu 2005-05-04 11:41:00.

|-
| Nejvhodnější kódová stránka pro import je utf-8, importovat lze ale i XML soubory v jiných kódových stránkách.

|-
| rowspan="5"|CSV
| Zatímco u ostatních formátů se nastavuje pouze tabulka do které se importuje a možnost ponechat či odstranit původní data v datové SQL tabulce, u CSV formátu se ve formuláři vyskytuje důležitá volba '''Data obsahují názvy sloupců''' – tuto volbu je třeba vždy správně nastavit.

Oddělovač sloupců může být čárka nebo středník, což je při importu detekováno automaticky.

|-
| Při automatickém zakládání SQL tabulky při importu budou mít všechny sloupce typ ''řetězec'' o délce 255 znaků – chování je stejné jako u XML formátu včetně možného nežádoucího oříznutí delších textů, je tedy vhodné nejprve strukturu tabulky připravit ručně.

Pokud CSV soubor neobsahuje v prvním řádku názvy sloupců, založí se názvy automaticky podle jmenné konvence ''sloupec_1'', ''sloupec_2'' atd., v opačném případě se sloupce v SQL tabulce pojmenují podle prvního řádku CSV souboru.

|-
| Pokud CSV soubor obsahuje v prvním řádku názvy sloupců, při importu do existující tabulky se importuje metodou vyhledávání stejných názvů sloupců v SQL tabulce – záleží tedy na těchto názvech a pokud se název sloupce liší nebude takový sloupec importován. Pokud naopak v prvním řádku názvy sloupců nejsou, importuje se podle pořadí, v jakém jsou sloupce definovány.

|-
| Texty musí být v  CSV souboru v takovém kódování, v jakém mají být uloženy v SQL databázi.

|-
| Formát datumů se očekává stejný jako u XML formátu.

|}

====Protokoly====
V části '''Protokoly''' lze procházet protokol modulu týkající se zápisů nových záznamů.

[[Image:poradny-zobrazit-protokol.png|center]]

Zobrazují se záznamy o vložených i odmítnutých záznamech, pokud je vložení odmítnuto antispamovou kontrolou, je zde uveden typ kontroly, která odmítnutí vyvolala.

====Zakázané IP adresy====
Funkce '''Zakázané IP adresy''' ovládá přidávání IP adres na blacklist (seznam zakázaných adres) a jejich odstraňování z blacklistu.

[[Image:diskuze47-zakazane-ip-adresy.jpg|center]]

Seznam adres je společný pro všechny katalogy a ovládá se stejným způsobem jako jiné funkce WebToDate modulů. Ve formuláři se zadává pouze IP adresa, datum vložení a údaj o uživateli se doplňuje automaticky.

== Veřejné skripty ==
=== Zobrazování dat ===

Prezentační skripty modulu se nacházejí v adresáři ''/scripts/modules/catalogue''/.'' Pro zobrazování dat lze použít skripty:

* ''default.php'' – zobrazuje seznam katalogů
* ''list.php'' – zobrazuje seznam položek katalogu
* ''detail.php'' – zobrazuje jednu položku katalogu
* ''search.php'' – zobrazuje vyhledávací stránku pro katalog

Skript ''default.php'' zobrazující seznam katalogů zobrazuje názvy existujících katalogů a odkazy na stránky zobrazující seznam položek katalogu. Skript zobrazuje jen ty katalogy, u kterých je nastaveno '''Data jsou přístupná pro čtení''' : '''Všem'''. Využití této stránky je nepovinné, odkazy na jednotlivé katalogy lze používat v jiných stránkách libovolně a stránka zobrazující seznam všech veřejně přístupných katalogů nemusí mít na daném webu využití.

Seznam katalogů je reprezentován v předloze stránky klíčovým slovem <nowiki>. Žádné jiné klíčové slovo nelze v předloze použít, pouze lze v předloze použít podmíněné zobrazení chybového hlášení </nowiki>. Seznam katalogů se formátuje zvoleným WebToDate stylem. Nejjednodušší styl lze pro tyto účely vytvořit tak, že do jeho těla zadáme kód

<code>
<nowiki><a href=""></a><br/></nowiki>
</code>

Tento příklad obsahuje klíčová slova pro název katalogu a pro odkaz na stránku se seznamem položek. Kromě toho lze v tomto stylu použít i klíčové slovo <nowiki></nowiki>, za které se dosazuje pro daný katalog URL vyhledávací stránky.

Důležitějším skriptem je skript ''list.php'' zobrazující seznam položek daného katalogu. Základní objekty, které se mohou v předloze vyskytovat, jsou seznam záznamů (reprezentovaný klíčovým slovem <nowiki>) a stránkovací navigační lišta (reprezentovaná klíčovým slovem </nowiki>). Dále lze do předlohy této stránky umístit:

* název zobrazovaného katalogu (<nowiki></nowiki>)
* ID zobrazovaného katalogu (<nowiki></nowiki>)
* Odkaz na první stránku se seznamem položek (<nowiki></nowiki>)
* Odkaz na vyhledávací stránku (<nowiki></nowiki>)
* Hlášení o tom, že katalog neobsahuje žádné položky (<nowiki></nowiki>.)

Ve stránce se může navíc vyskytovat vyhledávací formulář – z tohoto hlediska jsou možnosti práce s předlohou stejné jako na stránce pro '''Vyhledávání''' (z klíčových slov tedy ve stránce fungují klíčová slova typu <nowiki></nowiki>).

Stránkovací lišta se vždy formátuje jednotně podle nastavení pro navigační lištu v nastaveních modulu. Seznam položek katalogu se formátuje zvoleným WebToDate stylem. Jednoduchý příklad těla tohoto stylu vypadá následovně:

<code>
<nowiki><tr></nowiki>
<nowiki><td></td></nowiki>
<nowiki><td></td></nowiki>
<nowiki></tr></nowiki>
</code>

Klíčová slova typu <nowiki></nowiki> zde reprezentují pole katalogu, přičemž ''neco'' je název sloupce datové tabulky. Dále lze ve stylu použít tyto klíčová slova:

* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole neco není prázdné
* <nowiki></nowiki> - číslování záznamů v seznamu
* <nowiki></nowiki> - odkaz na detailní stránku

Podmíněné vkládání obsahu polí lze použít např. v případech, kdy chceme odkaz (obrázek či e-mailovou adresu apod.) vložit pouze v případě, kdy je v záznamu nějaká hodnota, např. takto:
<code>
<nowiki>'></a>")--></nowiki>
</cede>
Číslování pomocí <nowiki></nowiki> zobrazuje pro větší přehlednost pro každý záznam katalogu číslo dané vypisovaným pořadím na stránce se započtením stránkování záznamů, toto číslování tedy nemá žádnou souvislost s daty katalogu.

Důležité je klíčové slovo <nowiki></nowiki>, za které se dosazuje odkaz na zobrazení detailní stránky s jednou položkou katalogu. Toto URL se generuje ve tvaru

''detail.php?catalogueID=číslo_katalogu&linkvalue=hodnota_pole_pro_jednoznačnou_identifikaci''

V parametrech skriptu pro zobrazení detailu jedné položky se tedy musí vyskytovat jak ID katalogu, tak identifikátor záznamu (v parametru ''linkvalue'').

Skript pro zobrazení jedné položky ''detail.php'' je určen k zobrazení jednoho záznamu datové tabulky katalogu. Všechna klíčová slova se zde umísťují do předlohy, stránka nepoužívá žádný WebToDate styl. Nejdůležitější klíčová slova v předloze jsou:

* <nowiki></nowiki> - klíčové slovo zastupující pole datové tabulky (neco = název sloupce datové tabulky)
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' je prázdné
* <nowiki></nowiki> - kód se vkládá pouze pokud pole ''neco'' není prázdné

Jednoduchý příklad HTML kódu části předlohy zobrazující vybraná data z jedné položky katalogu vypadá následovně:
<code>
<nowiki></nowiki>
<nowiki><table></nowiki>
<nowiki><tr><td>Katalogové číslo</td><td></td></tr></nowiki>
<nowiki><tr><td>Interpret</td><td><strong></strong></td></tr></nowiki>
<nowiki><tr><td>Titul</td><td></td></tr></nowiki>
<nowiki><tr><td>Počet nosičů</td><td></td></tr></nowiki>
<nowiki><tr><td>Nosič</td><td></td></tr></nowiki>
<nowiki></table></nowiki>
</code>
I v této stránce lze použít klíčová slova jako název katalogu apod. a vytvořit vyhledávací formulář (jsou tedy zde aktivní klíčová slova <nowiki></nowiki>), více viz kapitola [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

Stránku s vyhledávacím formulářem lze vytvořit pomocí zobrazení skriptu ''search.php''. Skript vyžaduje jako povinný parametr ID katalogu, zobrazuje se tedy např. jako ''/scripts/modules/catalogue/search.php?catalogueID=1''. Možnosti vyhledávacího formuláře v této stránce platí i pro stránky zobrazující seznam položek katalogu a detail jedné položky.

Příklad vyhledávacího formuláře je následující:
<code>
<nowiki><form action="" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="ARTINAME">Interpret</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="ARTINAME" name="ARTINAME" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="PRODTITL">Titul</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td> <input type="text" id="PRODTITL" name="PRODTITL" value=""/> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr valign="top"></nowiki>
<nowiki><td></nowiki>
<nowiki><label for="MAJCONFC">Nosič</label></nowiki>
<nowiki></td></nowiki>
<nowiki><td></nowiki>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki><input type="submit" name="catalogue_search_button" value="Hledat" /></nowiki>
<nowiki></form></nowiki>
</code>
Za klíčové slovo <nowiki></nowiki> se v tomto příkladu dosadí URL pro zobrazení seznamu položek daného katalogu. Textová pole formuláře pro hledání musí mít atribut ''name'' odpovídající názvům polí (sloupců datové tabulky) katalogu.

Pro prohledávání platí:

* Prohledávat lze v katalogu jen pole textových a celočíselných typů, prohledávání jiných typů polí není podporováno.
* Prohledává se pouze s testem na rovnost nebo u textových polí na výskyt uvnitř textu (tj. podmínka LIKE). Není podporována možnost prohledávat na podmínku danou intervalem hodnot (tedy např. že daná hodnota musí být větší než nějaké číslo a menší než nějaké číslo).
* Tato pole musí být v katalogu označena jako '''Používat při prohledávání'''.

Pokud má formulář více vyplněných polí, spojuje se vždy vyhledávací podmínka logickou spojkou "a zároveň". Pokud se prohledává podle celočíselného pole, hledá se vždy podle testu na rovnost. Pokud se prohledává podle textového pole, hledá se výskyt řetězce kdekoliv uvnitř textového pole. Existuje zde ovšem možnost, jak hledání v textech omezit na hledání výskytu textového řetězce na začátku textových polí. Z vyhledávacího formuláře je třeba v tom případě předat parametr ''searchin'' s hodnotou ''begin'', např. pomocí následujícího kódu umístěného dovnitř formuláře:

<code>
<nowiki><input type="hidden" name="searchin" value="begin"></nowiki>
</code>

V tom případě se hledaný text nemá vyskytovat kdekoliv uvnitř textového pole, ale na jeho začátku.

Jednoduchý vyhledávací formulář tedy obsahuje pouze textová pole pojmenovaná odpovídajícím způsobem. Je ovšem podporována i složitější možnost – totiž vytváření pop-up menu, která nabízejí jedinečné hodnoty z daného sloupce databáze. Výše uvedený příklad prohledává katalog hudebních titulů, kde chceme kromě textových polí typu "interpret" prohledávat i podle typu nosiče (CD, MC apod.). Typ nosiče je v datové tabulce uveden jako text, pomocí klíčového slova <nowiki>) vložíme do formuláře všechny unikátní hodnoty daného sloupce s typem nosiče včetně příslušných HTML <option></nowiki> značek:
<code>
<nowiki><select name="MAJCONFC"></nowiki>
<nowiki><option value="" selected>--nerozlišovat--</option></nowiki>
<nowiki></nowiki>
<nowiki></select></nowiki>
</code>
Výsledný formulář pak vypadá v HTML stránce zhruba takto:

[[Image:formulare_a_katalogy39-vysledny-formular.jpg|center]]

Výpis položek je standardně setříděn podle nastavení '''Administrace''' / ''název katalogu'' / '''Třídění''' v administračním rozhraní modulu. Toto třídění lze změnit přes parametr ''sort'' z vyhledávacího formuláře nebo z URL. Jako hodnota parametru sort se vkládá název sloupce, podle kterého se má třídit. Třídění je pak vždy podle tohoto jednoho vybraného sloupce vzestupně.

Příklad HTML kódu pro volbu třídění je pak následující:
<code>
<nowiki><label for="sort">Třídit podle</label><br /></nowiki>
<nowiki><input type="radio" name="sort" value="nazev" checked="checked" /></nowiki> Názvu
<nowiki><input type="radio" name="sort" value="autor" /></nowiki> Jména autora
</code>
<div class="note">Poznámka: pokud se používá možnost volby třídění a v dané datové tabulce katalogu je větší množství záznamů, je doporučeno opatřit sloupce, podle kterých se třídí indexem (viz kapitola [[../Reference#Data|Data]]), jinak hrozí zpomalení sestavování stránek se seznamem položek a vyšší zátěž serveru.</div>

Další možností rozšíření možností vyhledávání je hledání dle intervalu hodnot. Uvedeme-li ve vyhledávacím formuláři např. pole
<code>
Počet kusů: <nowiki><input type="text" name="pockusu" value="" /></nowiki>
</code>
a je-li toto pole vyplněno, testuje se v prohledávaném sloupci na výskyt zadané hodnoty (pokud se jedná o textový sloupec) nebo na rovnost (pokud se jedná o jiné datové typy). Pokud ale uvedeme ve formuláři pole
<code>
Min. počet kusů: <nowiki><input type="text" name="pockusu[min]" value="" /></nowiki>
Max. počet kusů: <nowiki><input type="text" name="pockusu[max]" value="" /></nowiki>
</code>
můžeme prohledávat na rozsah hodnot, tj. hledat záznamy, kde v daném sloupci se vyskytuje jako minimální číslo hodnota zadaná do pole ''pockusu[min]'' a jako maximální číslo hodnota zadaná do pole ''pockusu[max''].'' Pro tuto volbu se tedy postupuje tak, že jako jméno pole formuláře nebo parametr URL se použije název sloupec datové tabulky s příponou ''[min]'' resp. ''[max''].'' Pro možnost prohledávání dle intervalu hodnot jsou podporovány celočíselné datové typy datové tabulky katalogu.

Vyhledávací formulář nepodporuje žádná další "aktivní" klíčová slova, nelze tedy např. zajistit, že stránka s výsledky hledání zobrazí formulář, který bude obsahovat údaje již uživatelem zadané v předchozí stránce apod.

=== Vkládání dat ===

Pro vkládání dat se používá skript ''/scripts/modules/catalogue/iform.php''. Hlavní možnosti tohoto skriptu jsou:

* Zobrazení formuláře pro vkládání dat
* Zobrazení potvrzovací stránky
* Zobrazování chybových hlášení aktivovaných kontrolou zadaných dat
* Odeslání e-mailu s daty vloženými do formuláře
* Přesměrování na vybranou stránku po úspěšném vložení dat z formuláře do katalogu.

Logika fungování tohoto skriptu je zhruba popsána následujícím vývojovým diagramem:

[[Image:formulare_a_katalogy40-diagram-logiky-fungovani-skriptu-vkladani-dat.jpg|center]]

Hlavním povinným parametrem skriptu je ID katalogu, do kterého se vkládají data ''catalogueid''.

Příklad jednoduchého kódu pro vstupní formulář je následující:
<code>
<nowiki><form action="/scripts/modules/catalogue/iform.php?catalogueid=" method="post"></nowiki>
<nowiki><input type="hidden" name="returnurl" value="/"/></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki></nowiki>
<nowiki><label for="JMENO">Jméno a příjmení</label><br/></nowiki>
<nowiki><input type="text" id="JMENO" name="JMENO" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="EMAIL">E-mailová adresa</label><br/></nowiki>
<nowiki><input type="text" id="EMAIL" name="EMAIL" value=""/></nowiki> *
<nowiki><br/></nowiki>
<nowiki><label for="VZKAZ">Další požadavky a komentáře</label><br/></nowiki>
<nowiki><textarea rows="10" rows="" name="VZKAZ" id="VZKAZ"></textarea></nowiki>
<nowiki><br/></nowiki>
<nowiki><input type="submit" name="catalogue_insert_button" value="Odeslat" /></nowiki>
<nowiki><p> Pole označená * jsou povinná. </p></nowiki>
<nowiki></form></nowiki>
</code>
Hlavní "aktivní" klíčová slova jsou <nowiki> zastupující hodnoty vkládaných polí. Názvy polí katalogu, do kterých se vkládá, se musí shodovat s atributem ''name'' vstupního formuláře. Klíčová slova </nowiki> jsou zde proto, aby v případě, že data neprojdou vstupní kontrolu se mohl zobrazit formulář včetně zadaných hodnot a vedle toho případná chybová hlášení reprezentovaná klíčovými slovy typu WTD_IF.

Na stejném principu pracuje i případná potvrzovací stránka, i zde se používají klíčová slova typu <nowiki></nowiki>, jednou se použijí pro zobrazení a podruhé jako hodnota ''hidden'' pole, která se po potvrzení přenáší jako hodnota, která bude uložena. Jedna položka formuláře na potvrzovací stránce pak vypadá např. takto:
<code>
<nowiki><tr></nowiki>
<nowiki><td> <label for="email">E-mail</label> </td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki><input type="hidden" id="email" name="email" value=""/></nowiki>
<nowiki></td></nowiki>
<nowiki></tr></nowiki>
</code>
<div class="note">Jako u všech ostatních typů stránek, i zde je vhodné tyto kódy formulářů primárně vygenerovat jako fragmenty pomocí nabídky '''Nástroje''' a následně je upravit podle potřeb.</div>

Vstupní skript provádí řadu kontrol a to i několikrát (pokud je použita potvrzovací stránka, tak i před uložením z potvrzovací stránky). Jedná se zejména o:

* Datové typy polí (tj. zda se např. někdo nepokouší do celočíselného pole zadat text apod.)
* Povinné vyplnění polí a unikátní hodnoty
* Názvy polí formulářů a názvy polí datové tabulky musí odpovídat
* Zda nejde o pokus zapsat hodnotu pole, které v definice katalogu není určeno k zápisům z veřejné části serveru.

Těmto kontrolám odpovídají možná chybová hlášení uvedená v kapitole [[../Reference#Klíčová slova modulu|Klíčová slova modulu]] .

Pokud se k vygenerování vstupního formuláře použije funkce z nabídky '''Nástroje''', vygenerují se všechna vstupní pole jako textová. Následně je možné změnit vstupní formulář tak, že místo některých textových polí se vytvoří nabídky formou pop-up menu, radiopřepínačů apod. Platí to, že důležité jsou pro daný element formuláře atributy ''name'' a ''value'', na typu pole nezáleží. Je třeba si ovšem uvědomit, že pokud dojde k chybě, zobrazí skript pro vkládání dat tu samou stránku se vstupním formulářem, kde klíčová slova typu WTD_FCI nahradí údaji, které zadal uživatel – pro jiná pole než textová pak dost dobře nelze nastavit správnou volbu, kterou uživatel v předchozím kroku zadal (atribut ''selected'' daného formulářového pole).

=== Možnosti omezení přístupu k zobrazení nebo vkládání dat ===

Jak je uvedeno v kapitole [[../Reference#Administrace|Administrace]], lze na úrovni katalogu nadefinovat, kdo (z hlediska veřejné části webu) může zobrazovat data katalogu a kdo do katalogu může vkládat.

Pokud je pro zobrazování zvoleno '''Nikomu''', je chování následující:

* Katalog se nezobrazuje v seznamu katalogů
* Pokud se pokusíme zobrazit seznam položek katalogu přímo přes skript ''list.php'', dostáváme chybové hlášení typu "Katalog nebyl nalezen"
* Stejné hlášení dostáváme u daného katalogu i pro skripty zobrazující jeden záznam a vyhledávací stránku.

Pokud vyvoláme skript pro vkládání dat iform.php pro katalog, který má nastaveno pro vkládání dat '''Nikdo''', dostáváme chybové hlášení typu "Předloha není definována".

Je-li na serveru instalován navíc modul Registrace a personalizace, lze kromě přístupů '''Všichni''' / '''Nikdo''' nastavit ve vlastnostech katalogu ještě přístup registrovaným uživatelům, a to odděleně pro prohlížení dat katalogu a pro vkládání dat do katalogu. V obou případech lze zvolit, že přístup mají buď všichni registrovaní nebo jen jedna vybraná skupina. Chování veřejných skriptů je pak následující:

* Pokud uživatel není přihlášen a pokusí se zobrazit nějakou stránku související s daným katalogem (zobrazení dat nebo vstupní formulář), je přesměrován na přihlašovací stránku ''(/''scripts/modules/registration/login.php''). Po úspěšném přihlášení je přesměrován zpět na původní stránku.
* Pokud uživatel je přihlášen a je nastaven přístup všem registrovaným, požadovaná stránka se ihned zobrazí.
* Pokud je uživatel přihlášen a je nastaven přístup pouze určité skupině uživatelů, je při pokusu o zobrazení stránky nejprve vyhodnoceno, zda přihlášený uživatel patří do nastavené skupiny. Pokud tomu tak je, stránka se zobrazí, pokud tomu tak není, je uživatel přesměrován na stránku ''Odmítnutí přístupu'' v případě vkládání dat a na přihlašovací formulář v případě zobrazování dat.

=== Klíčová slova modulu ===

Tato kapitola obsahuje souhrn všech klíčových slov modulu, která se používají v předlohách a WebToDate stylech.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – všechny stránky kromě seznamu katalogů a e-mailů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam katalogů
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu katalogů'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Název katalogu
|

|-
| <nowiki></nowiki>
| ID katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující stránku se seznamem položek katalogu
|

|-
| <nowiki></nowiki>
| URL zobrazující vyhledávací stránku pro daný katalog
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – seznam položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Seznam položek (záznamů)
|

|-
| <nowiki></nowiki>
| Navigační lišta
|

|-
| <nowiki></nowiki>
| Hlášení v případě, že nebyl nalezen žádný záznam
|

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná ve stylu seznamu položek katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Číslování položek v zobrazeném seznamu
|

|-
| <nowiki></nowiki>
| Odkaz na zobrazení detailní stránky zobrazující jeden záznam
|

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - zobrazení jedné položky katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' je prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| kód se vkládá pouze pokud pole ''neco'' není prázdné
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze - vyhledávací stránka katalogu'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Zobrazení jedinečných hodnot daného sloupce
| Pro účely vyhledávacího formuláře, vytváří se včetně HTML <nowiki><option></nowiki> značek

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – stránky pro vkládání dat přes formulář'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující hodnotu atributu ''value'' vstupního formuláře
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Skrytý kontrolní kód
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| Zobrazovaný kód k opsání
| Používá se pro [[../Ochrana proti spamu|antispamovou ochranu]] typu ''Opisování kontrolních kódů''

|-
| <nowiki></nowiki>
| bylo zjištěno, že datový typ některého pole neodpovídá datové tabulce
|

|-
| <nowiki></nowiki>
| některé povinné pole není vyplněno
|

|-
| <nowiki></nowiki>
| některé pole, které má obsahovat unikátní hodnoty není správně vyplněno
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce neexistuje
|

|-
| <nowiki></nowiki>
| některé pole v kolekci formuláře v datové tabulce nemá povolen zápis z veřejné části
|

|-
| <nowiki></nowiki>
| jiná chyba, např. nelze naplnit pole pro jednoznačnou identifikaci, SQL databáze vrátila při pokusu o zápis chybu apod.
|

|-
| <nowiki></nowiki>
| Kód se vloží v případě, že uživatel špatně opsal kontrolní kód pro antispamovou ochranu
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Kód vloží antispamová ochrana v případě, že adresa uživatele vkládajícího dotaz je na seznamu zakázaných adres
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|-
| <nowiki></nowiki>
| Vloží se pokud byl příspěvek detekován jako spam a nejde o předchozí dva případy.
| Lze použít v předloze obsahující formulář pro vložení nového dotazu

|}

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze – e-mail s obsahem vstupního formuláře'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| klíčové slovo zastupující vloženou hodnotu pole datové tabulky
| (''neco'' = název sloupce datové tabulky)

|-
| <nowiki></nowiki>
| Název katalogu
| <nowiki></nowiki>

|-
| <nowiki></nowiki>
| ID katalogu
| <nowiki></nowiki>

|}

Modul dále podporuje [[../../Referenční/Klíčová slova WebToDate#Klíčová slova pro formátování|Klíčová slova pro formátování]] typu WTD_FORMAT, tedy např.

''<nowiki></nowiki>''

apod.

=== Speciální názvy parametrů ===

Skripty používají následující speciální parametry (v URL nebo ve vyhledávacích formulářích). Vzhledem k vyhrazenému významu těchto parametrů to znamená, že '''názvy sloupců datových tabulek se nesmí shodovat s názvy těchto parametrů''':

* catalogueid – ID katalogu
* linkvalue – hodnota pole pro jednoznačnou identifikaci (používá skript pro zobrazení detailní stránky jedné položky katalogu)
* pg – používá stránkovací lišta pro stránkování
* searchin – udává způsob prohledávání textových polí (používá skript pro zobrazení seznamu položek katalogu)
* sort – může být použit pro výběr sloupce, podle kterého se třídí seznam položek
* returnurl – využívá skript pro vkládání dat z veřejných formulářů jako URL stránky zobrazené po úspěšném vložení záznamu
* tmplid – parametrem lze vynutit pro stránku jinou předlohu, hodnotou je ID této předlohy
* lid, locale, dlid, dlocale – využívají všechny moduly jako identifikátory pro jazyky
* ccid, ccvalue - parametry pro práci s kontrolními kódy [[../Ochrana proti spamu|antispamové ochrany]]

== Rozhraní pro napojení jiných aplikací ==
Modul obsahuje rozhraní pro napojení jiných aplikací, které umožňuje těmto aplikacím aktualizaci obsahu jednotlivých katalogů, tj. vkládání, aktualizaci a mazání záznamů v datových tabulkách katalogů.

=== Princip řešení ===

Na serveru je umístěn skript ''/gate/catupdate/default.php''. Adresář ''gate'' je virtuální adresář www serveru fyzicky umístěný na stejné úrovni jako např. adresář wwwroot. Z bezpečnostních důvodů je velmi vhodné přístup na tento virtuální adresář omezit pouze na IP adresu serveru, na kterém běží aplikace, která má měnit data modulu.

Tento skript přijímá přes protokol http POST příkazy ve formátu XML, provádí je a zpět zasílá (opět v XML) potvrzení. Příkazem může být buď pokyn ke smazání jedné položky daného katalogu nebo pokyn k vložení nebo aktualizaci záznamu jednoho katalogu.

Vkládání / aktualizace se synchronizuje na úrovni ID záznamů, externí aplikace tedy musí znát a používat identifikátory používané v dané datové tabulce. Při mazání se načítá jen ID záznamu, který se má mazat, při vkládání nebo aktualizaci celý záznam, tj. jeden řádek tabulky.

Skript zachycuje všechny potencionální chybové stavy a podává o nich hlášení prostřednictvím vraceného XML kódu – jedná se například o žádost o smazání neexistujícího záznamu, chybu při zápisu do databáze apod. Všechny události se protokolují do speciálního logu, kde se dá kontrolovat, zda komunikace probíhá v pořádku.

=== XML formáty přenosů ===

Každá žádost o aktualizaci obsahuje název datové tabulky, se kterou se manipuluje. Následuje příkaz (smazat / přidat nebo aktualizovat). Pak následují vlastní data – buď je uveden pouze unikátní identifikátor (v případě mazání) nebo celý řádek tabulky (v případě vložení či aktualizace).

Kořenový element žádosti o aktualizaci je vždy ''<nowiki><catupdaterequest''>,'' následuje kód ''<dbtable name="název_tabulky" idcolumn="název_sloupec_pro_jednoznačnou_identifikaci''"/>,'' který specifikuje, která datová tabulka se má aktualizovat a jaký sloupec se používá pro vyhledávání záznamů (jednoznačnou identifikaci). Dále je povinné uvést element ''<command''></nowiki>,'' který má v atributu ''type'' uveden typ operace, možné hodnoty jsou ''delete'' / ''update''.

==== Smazání záznamu ====

Následující XML kód slouží jako příkaz ke smazání jednoho záznamu s daným ID. ''per_id'' je název sloupce datové tabulky použitého v katalogu jako sloupec pro identifikaci záznamů.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name="KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="delete"></nowiki>
<nowiki><per_id>2506</per_id></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>

==== Potvrzení smazání ====

Následující kód dostává zpět externí aplikace jako odpověď na příkaz smazání položky.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdateresponse></nowiki>
<nowiki><status>error</status></nowiki>
<nowiki><description>Záznam s ID=2506 v tabulce KATDTBL se nepodařilo smazat.</description></nowiki>
<nowiki></catupdateresponse></nowiki>
</code>
Element ''status'' může nabývat hodnot ''ok / error'', v případě chyby obsahuje element ''description'' textový popis chyby.

==== Vložení nebo aktualizace záznamu ====

Následující kód reprezentuje příkaz na vložení nebo aktualizaci jednoho záznamu.
<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><catupdaterequest></nowiki>
<nowiki><dbtable name=" KATDTBL" idcolumn="per_id"/></nowiki>
<nowiki><command type="update"></nowiki>
<nowiki><per_id>2507</per_id></nowiki>
<nowiki><vydavatel>Vydavatel s.r.o.</vydavatel></nowiki>
<nowiki><okres>Praha</okres></nowiki>
<nowiki><nazev>Křížovky a rébusy</nazev></nowiki>
<nowiki><zamereni>Časopisy pro luštitele</zamereni></nowiki>
<nowiki><regionalni>Ne</regionalni></nowiki>
<nowiki><per>6</per></nowiki>
<nowiki></command></nowiki>
<nowiki></catupdaterequest></nowiki>
</code>
Nejprve je uvedena informace o tom, které tabulky se příkaz týká, atribut ''idcolumn'' zde musí obsahovat jako hodnotu název sloupce datové tabulky, který se používá pro identifikaci záznamů a pomocí kterého se provádí příkazy pro aktualizaci či mazání těchto záznamů. Pak je uveden vlastní příkaz a seznam hodnot jednotlivých polí. Tento seznam není pevně dán, ale liší se dle struktury katalogu, jména elementů odpovídají názvům sloupců datové tabulky modulu Formuláře a katalogy.

Soubor:Formulare a katalogy19-novy-katalog.jpg

2018-11-01T13:35:45Z

Jardac: Jardac načtena nová verze "Soubor:Formulare a katalogy19-novy-katalog.jpg"

[[Category:WebToDate Formuláře a katalogy]]
Formuláře a katalogy - nový katalog

WebToDate/Fulltext SOLR/O produktu

2018-03-29T11:45:23Z

Jardac: /* Základní vlastnosti modulu - nadpisy */

[[Category:WebToDate Fulltext SOLR]]
[[Category:Fulltext]]

== Základní vlastnosti modulu ==
Modul je určen pro fulltextové prohledávání webové prezentace. Jedná se o integrační modul s aplikací [http://lucene.apache.org/solr/ Apache SOLR], který umožňuje přenos dat na SOLR k fulltextové indexaci, a vytvoření prezentační vrstvy pro vyhledávací stránku.

Modul obsahuje následující funkce:

* Odesílání indexovaných dat na SOLR (tj. nové dokumenty, aktualizaci existujících dokumentů i smazání odstraněných či odpublikovaných dokumentů).
* Podporu prezentační vrstvy, neboli vytvoření vyhledávací stránky, zpracování vstupních parametrů, vytvoření vyhledávacího dotazu, zpracování výsledků vyhledávání přes [[../../Referenční#Styly|WebToDate styl]] i přes [[../../Referenční/Navigace_a_transformace#Vytvo.C5.99en.C3.AD_a_.C3.BAprava_transformace|XSLT transformaci]].
* Nastavení, které se omezuje na základní komunikaci se SOLR serverem. Nastavení týkající se vlastního hledání (konfigurace stemmingu, práce s diakritikou apod.) se provádějí přímo v konfiguračních souborech SOLR a nelze je měnit na straně WebToDate modulu.

== Co modul umožňuje ==

== Porovnání modulů Fulltext a Fulltext SOLR ==

WebToDate/Fulltext SOLR/O produktu

2018-03-29T11:43:47Z

Jardac: Založena nová stránka s textem „Category:WebToDate Fulltext SOLR Category:Fulltext == Základní vlastnosti modulu == Modul je určen pro fulltextové prohledávání webové pre…“

WebToDate/Referenční/URL stránek

2018-02-21T15:51:11Z

Jardac: /* Odkaz nadpisu využívající ID zprávy */

[[Category:WebToDate Referenční]]
[[Category:Referenční]]
== Jaká URL WebToDate používá a vytváří ==
Tato kapitola obsahuje informace o tom, jak se tvoří URL www stránek v prezentační části v systému WebToDate. Tato informace je nutná v případech, kdy je třeba vytvořit nabídku odkazů či použít v těle zprávy odkaz na jinou stránku apod.

=== URL stránek ===

URL stránek definovaných v systému a zobrazovaných ve stromu stránek je zpravidla totožné s URL zadaném v poli '''URL stránky''' ve formuláři pro definici stránky. Výjimkou jsou stránky obsahující seznam nebo zprávu přiřazené dynamicky nebo stránky v privátní zóně, v tom případě je třeba použít URL ve tvaru

''/scripts/detail.php?pgid=ID_stránky.''

Tento prezentační skript se používá pro zobrazování stránek i zpráv, podporované parametry skriptu jsou následující:

* ''id'' – ID zprávy
* ''abbrev'' – zkratka zprávy
* ''pgid'' – ID stránky
* ''conn'' – ID instance seznamu, který se stránkuje
* ''pg'' – číslo stránky v rámci stránkování
* ''newsid'' – ID zprávy obsahující seznam typu přílohy, používá se pro fotogalerie v URL zdroje
* ''listid'' – ID zobrazovaného seznamu, používá se pro fotogalerie v URL zdroje
* ''returnurl'' – návratová adresa pro vložení odkazu zpět na stránku se zprávou, , používá se pro fotogalerie v URL zdroje
* ''tmplid'' – ID předlohy, která se má použít místo výchozí

Pro další stránku v rámci stránkování seznamu vloženého do stránky dynamicky se tedy vygeneruje tvar typu ''/scripts/detail.php?pgid=273&conn=5140&pg=2''.

=== URL zpráv ===

URL zpráv je ve výchozí konfiguraci ve tvaru

''/scripts/detail.php?id=ID_zprávy''

Kromě parametru ''id'' se ještě nejčastěji používají parametry:

* ''abbrev'' – tento parametr slouží k zadání zkratky zprávy, hodnota musí korespondovat s obsahem pole Zkratka ve formuláři pro úpravu zpráv. Pokud píšete manuálně často odkaz na určitou zprávu, zadejte zkratku v poli '''Zkratka''' a použijte odkaz ''/scripts/detail.php?abbrev=zkratka'', toto URL se lépe pamatuje než číslo zprávy přidělené systémem
* ''tmplid'' – ID předlohy, jež se má použít pro zobrazení; toto id vynucené z URL má přednost před zadáním předlohy v definici zpráv. Tuto vlastnost lze s výhodou využít pro oblíbenou funkci ''Verze pro tisk'', či pro zobrazení stejných zpráv různě v různém kontextu (z jiné rubriky, z jiného virtuálního serveru apod.). Volání má pak tvar ''/scripts/detail.php?id=ID_zprávy&tmplid=ID_předlohy''

=== URL zdrojů ===

Pro URL zdrojů (tj. stránek používaných pro zobrazení jednoho souboru ve zdroji v HTML kódu s popisky apod., tedy typicky pro obrázek ve fotogalerii) platí to samé co pro zprávy, navíc se dají použít parametry:

* ''newsid'' - parametrem se předává ID zprávy, ve které se zobrazuje daná fotogalerie
* ''listid'' - parametrem se předává ID seznamu, ve kterém se fotogalerie zobrazuje
* ''returnurl'' - parametrem lze předat návratovou adresu, která se použije pro návrat zpět na fotogalerii

=== URL souborů ===

Pokud se soubor nachází ve veřejné zóně, je jeho URL statické a definované ve vlastnostech souboru ve zdroji. Při vložení souboru do zdroje může dojít k jeho přejmenování, které má za cíl, aby na serveru nebyly uloženy soubory, pro které by odkazy na ně vytvářely nevalidní URL. Standardně se při tomto přejmenování postupuje následovně:

# Písmena v názvu se převádí na spodní polovinu ASCII tabulky (tedy znak č na c apod.)
# Provádí se náhrada znaků definovaných v konfiguračních konstantách URL_CONVERT_FIND, URL_CONVERT_REPLACE, URL_CONVERT_NOCHAR (viz další kapitola o možnostech generování URL zpráv)
# Znaky se volitelně převádějí na malá nebo velká písmena dle konfigurační konstanty ASSETS_FILENAME_CONVERT_CASE
# Pokud ve výsledku v názvu souboru zbudou nějaké znaky, které nejsou v URL přípustné, nahradí se znakem definovaným v konstantě ASSETS_AUTOREPAIR_FILENAMES.

V konfiguraci WebToDate lze ale zvolit i jiný přístup k eventuálnímu přejmenování souborů, viz např. konfigurační konstanta ASSETS_SET_SIMPLE_FILENAMES.

Pokud se soubor nachází v privátní zóně, je jeho URL dynamické ve tvaru ''/scripts/file.php?id=ID_souboru''.

Dalším parametrem skriptu ''file.php'' může být parametr ''down''. Pokud má hodnotu ''yes'', vyznačuje se tím žádost o stažení souboru. Pokud tedy uvedeme ve stylu odkaz typu

<code>
<nowiki><a href="/scripts/file.php?id=&down=yes"></a></nowiki>
</code>

klepnutím na tento odkaz se místo pokusu o zobrazení souboru v prohlížeči vyvolá dialog pro uložení souboru na disk.

<div class="note">Poznámka: tato funkce pracuje s vložením dodatečných parametrů do http hlavičky (''Content-Disposition'' apod.). Záleží na prohlížeči, zda tyto druhy hlaviček podporuje, funkčnost ve všech existujících www prohlížečích není zaručena. Pokud daný prohlížeč tyto hlavičky ignoruje, dojde ke standardnímu zobrazení souboru v prohlížeči.</div>

Pokud parametr ''down'' není uveden nebo má jakoukoli jinou hodnotu než ''yes'', dodatečné parametry do http hlavičky se nevkládají a soubor je odesílán do prohlížeče tak, jak je.

=== URL pro přesměrování ===
K dispozici je skript, pomocí kterého lze přesměrovat na zadané URL. Skript je umístěn na adrese ''/scripts/modules/redir/default.php''. Jako jediný parametr má parametr ''trg'', do kterého se vkládá cílové URL. Skript akceptuje http metody GET a POST.

Skript provádí bezpečnostní kontroly na hodnoty parametru ''trg'' a dále kontrolu na to, že se nevolá přesměrování mimo daný server (cílové URL začíná lomítkem). Pokud kontroly projdou v pořádku, přesměruje na URL dané parametrem ''trg'', pokud kontroly v pořádku neprojdou, vyvolá se http chyba 404.

Příkladem využití může být případ, kdy chceme ve stránce zobrazit rozevírací nabídku formuláře, kde se po výběru položky z nabídky a potvrzení tlačítkem formuláře přechází na stránku danou výběrem z této nabídky. Kód formuláře je pak cca následující:

<code>
<nowiki><form action="/scripts/modules/redir/default.php" method="get"></nowiki>
<nowiki><select name="trg"></nowiki>
<nowiki><option value="url1">Položka 1</option></nowiki>
<nowiki><option value="url2">Položka 2</option></nowiki>
<nowiki><option value="url3">Položka 3</option></nowiki>
<nowiki></select></nowiki>
<nowiki><br /></nowiki>
<nowiki><input type="submit" value="Vyhledat" class="button" /></nowiki>
<nowiki></form></nowiki>
</code>

=== URL stránek modulů ===

Většina modulů WebToDate obsahuje svoje prezentační skripty. Např. URL stránky pro vyhledávání v databázi zpráv modulu [[../../Fulltext|Fulltext]] má tvar ''/scripts/modules/fulltext/fulltxt.php''. Konkrétní seznamy prezentačních skriptů a jejich parametrů naleznete v příručkách k jednotlivým modulům.

== Možnosti změn ve tvaru URL stránek ==
Techniky popsané v této kapitole slouží ke změně tvaru nativních URL zpráv či stránek v prezentační části. Cílem je dosáhnout přehlednějších a pro vyhledávače lépe přizpůsobených tvarů URL, které se zpravidla označují jako ''Cool URI'', ''SEO-friendly URLs'' apod.

Tyto techniky vyžadují nasazení modulu www serveru [http://httpd.apache.org Apache]. ''[http://httpd.apache.org/docs/2.2/rewrite/ mod_rewrite]'' (podobné ISAPI moduly třetích stran existují i pro [http://www.iis.net Microsoft IIS], resp. jej firma Microsoft dodává pro [http://www.iis.net/download/URLRewrite IIS 7]). Typická pravidla pro nasazení ''mod_rewrite'' v kombinaci s WebToDate jsou popsána v návodu [[../../Návody/Doporučené přepisy URL|Doporučené přepisy URL]].

=== Odkaz nadpisu využívající ID zprávy ===
URL zpráv mohou mít místo nativního tvaru ''/scripts/detail.php?id=xxx'' např. tvar ''/dokumentxxx.htm'', ale i např. ''/zpravy/zahranicni/KLDR-a-USA-zahajily-rozhovory-o-krocich-k-normalizaci-vztahu-54253''/,'' což je vhodnější tvar např. pro vyhledávací roboty.

Princip této funkce je následující:

* WebToDate připouští dva možné "fyzické" tvary URL zprávy - ''/scripts/detail.php?id=xxx'' (ID zprávy je automaticky přidělované celé číslo) nebo ''/scripts/detail.php?abbrev=yyy'' (parametr ''abbrev'' je obsah textového pole '''Zkratka''' ve vstupním formuláři pro zprávy, které může být definováno ručně nebo generováno automaticky, musí být unikátní v rámci celé databáze zpráv.
* Pomocí sady konfiguračních konstant se definuje, v jakém tvaru se generuje obsah pole '''Odkaz nadpisu''' nebo eventuálně '''Zkratka''', kdy se automaticky tento obsah při uložení zprávy obnovuje a další potřebné vlastnosti, což umožňuje, aby URL zpráv byla optimální z hlediska SEO.
* Pomocí ''mod_rewrite'' se nadefinuje vhodné pravidlo, které převádí vygenerovaná URL na "fyzická" URL zpráv. Přitom pokud se ve výsledném URL může vyskytovat ID zprávy, převádí příslušné pravidlo URL na tvar ''/scripts/detail.php?id=xxx'', pokud je požadováno, aby se číselné ID v URL nevyskytovalo a URL mělo čistě textový tvar, využívá se obsah pole '''Zkratka''' a pravidle ''mod_rewrite'' převod na tvar ''/scripts/detail.php?abbrev=yyy''.

Z hlediska konfigurace WebToDate je pro tuto funkci primární nastavení tvaru přidělovaného URL. Jedná se o konstantu

<code>
<nowiki>define( 'DETAILURL', '/scripts/detail.php?id=' );</nowiki>
</code>

Pokud tuto konstantu přepíšete na

<code>
<nowiki>define( 'DETAILURL', '/dokument.htm' );</nowiki>
</code>

budou automaticky přidělovaná URL pro nově vkládané zprávy (v poli '''Odkaz nadpisu''') v tvaru podle předchozího příkladu. Lze zde ovšem použít výběr z následujících výrazů:

* <nowiki></nowiki> - ID zprávy
* <nowiki></nowiki> - zkratka zprávy
* <nowiki></nowiki> - konvertovaný nadpis (konverze ošetřuje to, aby v URL nebyly znaky s diakritikou a další nežádoucí znaky)
* <nowiki></nowiki> - cesta daná stromem kategorií (dle výchozí kategorie zprávy), tedy např. /zahranicni/evropa/
* <nowiki></nowiki> - zkratka jazyka zprávy převedená na malá písmena
* <nowiki></nowiki> - část cesty podle data zprávy, tedy např. /2007/08/22/.

Druhá konfigurační konstanta NEWSABBREV_AUTOFILL definuje tvar obsahu pole '''Zkratka'''.

<code>
<nowiki>define( 'NEWSABBREV_AUTOFILL', '');</nowiki>
</code>

V definici této konstanty lze použít výrazy:

* <nowiki></nowiki> - ID zprávy
* <nowiki></nowiki> - konvertovaný nadpis

Následující tabulka uvádí různé možnosti konfigurace těchto dvou základních konstant - cílové tvary URL a způsob jejich nastavení.

{| class="prettytable"
| URL (Odkaz nadpisu)
| /domaci/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /2007/09/07/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /domaci/2007/09/07/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /clanky/lidovci-a-zeleni-zuzili-vyber-kandidatu/

|-
| Zkratka
| lidovci-a-zeleni-zuzili-vyber-kandidatu

|-
| Předpis pro vyplňování - Odkaz nadpisu
| /clanky/<nowiki></nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| <nowiki></nowiki>

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /domaci/clanky/lidovci-a-zeleni-zuzili-vyber-kandidatu/

|-
| Zkratka
| lidovci-a-zeleni-zuzili-vyber-kandidatu

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>clanky/</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| <nowiki></nowiki>

|}

Pokud se do URL vkládá zkratka jazyka <nowiki></nowiki>, lze předefinovat vkládání konkrétních zkratek jazyků. Použije se pole

<code>
<nowiki>$g_urlLanguageAbbrevs = array('en' => 'en', 'cs' => '');</nowiki>
</code>

Toto konfigurační PHP pole mapuje zkratky jazyků tak jak jsou zadány v nastavení jazyků a uloženy v databázi, a zkratky použité následně v URL. Např. v tomto konkrétním případě se ve výsledku pro jazyk en vloží zkratka en a pro jazyk cs se zkratka nevloží.

Kromě základních konfiguračních konstant DETAILURL a NEWSABBREV_AUTOFILL je ovšem k dispozici sada dalších nastavení, pomocí kterých se definuje:

* Způsob případné konverze pole Nadpis do URL
* Omezení maximálních délek pro URL a zkratky
* Způsob řešení toho, jak se automaticky řeší případ, kdy by algoritmus vygeneroval zkratku, která již v databázi existuje (pro případ, že by byl např. stejný nadpis několika různých zpráv)
* Kdy se URL či zkratka automaticky generuje či mění
* Jak mohou uživatelé WebToDate do procesu generování URL či zkratek zasahovat

Následující čtyři konstanty definují převod znaků do URL (při konverzi nadpisu zpráv do pole '''Zkratka''' a '''Odkaz nadpisu'''). První dvě konstanty definují mapování jednotlivých znaků (tj. obě musí obsahovat stejný počet znaků), třetí konstanta definuje, které znaky se nahrazují za prázdný řetězec. Čtvrtá konstanta pak definuje, zda se provádí převod znaků na malá nebo velká písmena nebo zůstává rozlišení malých a velkých písmen jako v nadpisu zprávy.

<code>
<nowiki>define( 'URL_CONVERT_FIND', ',. \\/&' );</nowiki>
<nowiki>define( 'URL_CONVERT_REPLACE', '------' );</nowiki>
<nowiki>define( 'URL_CONVERT_NOCHAR', '\'"#$%()+@?!' );</nowiki>
<nowiki>define( 'URL_CONVERT_CASE', 'LOWER' );</nowiki>
</code>

Pokud se do nadpisu vloží nějaký znak, který není v cílové znakové sadě serveru, převede se na číselnou HTML entitu, která se pak objeví ve vygenerovaném URL zprávy, což zpravidla není příliš žádoucí. Aby byla možnost zamezit přenosu těchto entit do URL, jsou k dispozici následující nastavení:

<code>
<nowiki>$url_convert_entities_map = array(</nowiki>

<nowiki>'&#187;' => '-',</nowiki>

<nowiki>'&#51;' => '3'</nowiki>

<nowiki>);</nowiki>

<nowiki>define( 'URL_CONVERT_OTHER_ENTITIES', true );</nowiki>

<nowiki>define( 'URL_CONVERT_ENTITIES_CHAR', '' );</nowiki>
</code>

Nejprve se nahrazují entity podle pole ''$url_convert_entities_map''. V druhém kroku se všechny zbylé numerické entity nahradí za znak URL_CONVERT_ENTITIES_CHAR (může být i prázdný znak), ale jen v případě, že je nastaveno URL_CONVERT_OTHER_ENTITIES = true.

Postup převodu znaků z nadpisu zprávy do URL je tedy následující:

# Nahrazují se HTML entity a numerické entity
# Znaky uvedené v konstantě URL_CONVERT_FIND se nahrazují za znaky v URL_CONVERT_REPLACE a znaky uvedené v URL_CONVERT_NOCHAR se nahrazují prázdným znakem
# Takto vzniklý řetězec se převádí na spodních 128 znaků ASCII tabulky (tedy znak č na c apod.)
# Podle nastavení konstanty URL_CONVERT_CASE se provádí případný převod na malá nebo velká písmena.

Je nutné omezit maximální délku zkratky a URL - vzhledem k volitelnému nastavení tvaru zkratky či URL je možný případ, kdy by vygenerovaný řetězec byl delší než maximální počet znaků pro tato pole v databázi. K tomu jsou určeny konstanty:

<code>
<nowiki>define( 'NEWSURL_MAXLENGTH', 255);</nowiki>
</code>

NEWSURL_MAXLENGTH definuje maximální délku obsahu pole '''Odkaz nadpisu'''. Pokud je sestavený řetězec delší, ořízne se zprava na tuto hodnotu.

<code>
<nowiki>define( 'NEWSURL_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

NEWSURL_CONVERT_MAXLENGTH definuje maximální délku té části URL, která vzniká konverzí s využitím výrazu <nowiki></nowiki>. Pokud je tedy výsledek konverze nadpisu delší než zadaná konstanta, ořízne se zprava.

<code>
<nowiki>define( 'NEWSABBREV_MAXLENGTH', 150);</nowiki>
</code>

NEWSABBREV_MAXLENGTH definuje maximální celkovou délku zkratky, význam je stejný jako u NEWSURL_MAXLENGTH, pouze se aplikuje na obsah pole '''Zkratka'''.

<code>
<nowiki>define( 'NEWSABBREV_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

Význam konstanty NEWSABBREV_CONVERT_MAXLENGTH je stejný jako NEWSURL_CONVERT_MAXLENGTH, pouze se aplikuje na obsah pole '''Zkratka'''.

U zkratky se musí počítat s tím, že může v případě konverze nadpisu do zkratky dojít k vytvoření zkratky, která není unikátní, unikátnost zkratky je ale nutným předpokladem fungování URL založených na zkratkách. Proto je zde konstanta

<code>
<nowiki>define ('NEWSABBREV_UNIQUE_DELIMITER', '_');</nowiki>
</code>

V případě vygenerování zkratky, která již existuje, se postupuje tak, že se unikátní hodnoty pole '''Zkratka''' vytvářejí pomocí oddělovače plus čísla na konci; konstanta NEWSABBREV_UNIQUE_DELIMITER definuje tento oddělovač. Nedochází k efektu dvou oddělovačů za sebou, tj. pokud již existuje zpráva ze zkratkou např. abc_2, nová zpráva má zkratku abc_3 a nikoli abc_2_1.

Konstanta NEWSURL_AUTOUPDATE definuje režim automatických změn obsahu polí '''Odkaz nadpisu''' a '''Zkratka'''.

<code>
<nowiki>define( 'NEWSURL_AUTOUPDATE', 0);</nowiki>
</code>

Možné hodnoty jsou:

* 0 - zkratka se automaticky nevyplňuje, URL se přidělí podle konstanty DETAILURL při prvním uložení zprávy a už se nikdy automaticky nemění
* 1 - zkratka se automaticky vyplňuje pokud je konstanta NEWSABBREV_AUTOFILL neprázdná. Jak zkratka tak URL se vyplní při prvním uložení zprávy a už se automaticky nemění
* 2 - zkratka a URL se může automaticky změnit při uložení, pokud se změnily údaje, podle kterých se tvoří (seznam údajů je daný konstantami NEWSABBREV_AUTOFILL resp. DETAILURL) a pokud zpráva není ve stavu ''Publikováno'' či ''Archivováno''.
* 3 - stejné jako předchozí případ, ale změna zkratky i URL je povolena i v případě, že zpráva je ve stavu ''Publikováno'' či ''Archivováno''.

Konstanta NEWSURL_AUTOUPDATE tedy v zásadě definuje úroveň možnosti změnit URL zprávy v průběhu zpracování a změn. Hodnota 0 znamená nejjednodušší stav, kdy se zkratka nepoužívá a URL se na začátku vytvoří a již se pak nemění, čím vyšší číslo, tím méně je zaručeno, že zpráva si zachová původní URL, ale na druhou stranu se tím více URL přizpůsobuje (z hlediska tvaru pro SEO) aktualizaci metadat zprávy (změně nadpisu, změně kategorie apod.).

Algoritmus automatického sestavování URL a zkratky popisuje následující diagram.

[[Image:referencniprirucka-urlstranek-img171.png|center]]

V rámci verzování zpráv lze chování URL nastavit pomocí konfigurační konstanty ABBREV_AUTOFILL_ON_PUBLISH.

<code>
<nowiki>define('ABBREV_AUTOFILL_ON_PUBLISH', false);</nowiki>
</code>

Hodnota ''true'' znamená, že je požadováno zachování URL mezi různými verzemi zpráv (tj. při publikaci nové verze se přebírá zkratka a URL předchozí publikované verze), hodnota ''false'' znamená, že URL různých verzí zprávy spolu nesouvisejí a chovají se z tohoto hlediska jako samostatné zprávy. Tato možnost zachovávání URL je popsána v následující kapitole.

Konstanta NEWSABBREV_LOCK definuje, zda uživatelé mohou ručně měnit zkratku.

<code>
<nowiki>define('NEWSABBREV_LOCK', false);</nowiki>
</code>

Hodnota ''false'' znamená, že pole je možné běžným způsobem editovat. Hodnota ''true'' znamená, že uživatelé s výjimkou členů týmu ''Administrátoři'' nemají možnost hodnotu tohoto pole měnit.

Pro zdroje lze určit, zda se systém uživatelsky definovatelných URL a zkratek používá i pro ně (myšleno pro pole '''Odkaz nadpisu''' ve zdroji).

<code>
<nowiki>define('ASSETS_FRIENDLY_URL', false);</nowiki>
</code>

Pokud je konstanta ASSETS_FRIENDLY_URL nastavena na hodnotu ''true'', generují se zkratky a URL pro zdroje stejně jako pro zprávy, v opačném případě se zkratky negenerují a URL se vytvářejí v systémovém tvaru.

Další pravidla lze v ''mod_rewrite'' definovat i pro vybrané stránky jiného typu. Pokud chcete, aby taková stránka byla např. výchozí stránka nějaké kategorie (na kterou se odkazují navigace), která je zobrazovaná dynamicky, označte ji jako výchozí stránku a zároveň do pole URL ve vlastnostech kategorie zadejte URL tak jak je definováno v ''mod_rewrite''.

=== Zkratky a zachování URL verzí zpráv ===

Jak je uvedeno výše, zprávy lze zobrazovat i s využitím pole '''Zkratka'''. Výchozí tvar URL je pak ''/scripts/detail.php?abbrev=zkratka'', samozřejmě pak lze pomocí ''mod_rewrite'' nadefinovat jiný tvar URL využívající zkratku. Není-li pole v konfiguraci uzamčeno pro editaci, je obsah pole '''Zkratka''' je volně upravovatelný. V případě využívání této možnosti je třeba si uvědomit následující skutečnosti:

* Nekontroluje se vyplnění tohoto pole, pole může být i prázdné
* Když je pole vyplněno a v předpisu pro URL zprávy se zkratka využívá, může se změnit URL zprávy v poli '''Odkaz nadpisu'''.

Pokud je nastavena konfigurační konstanta ABBREV_AUTOFILL_ON_PUBLISH na hodnotu ''false'', znamená to, že není požadováno zachování URL mezi verzemi a jednotlivé verze zpráv se v tomto smyslu chovají jako samostatné zprávy.

Pokud je nastavena konstanta ABBREV_AUTOFILL_ON_PUBLISH na hodnotu ''true'', znamená to, že se při publikaci zprávy spouští funkce na převzetí URL a zkratky z předchozí publikované verze. Vyhodnocení toho, co je předchozí verze nezáleží na pořadovém číslu verze, hledá se jiná publikovaná verze zprávy.

Funkce pro převzetí URL z předchozí verze pracuje následovně:

# publikovaná zpráva přebírá zkratku i URL předchozí verze
# pro předchozí verzi se spouští algoritmus vygenerování zkratky a URL dle konfiguračních konstant. To znamená, že předchozí verze přecházející do jiného stavu dostane URL a zkratku v podstatě jako kdyby tato zpráva byla nově založena.

To pak má následující efekt:

* Pokud se postupně publikují nové verze stejné zprávy, URL se nemění pro aktuální verzi zprávy.
* Mění se URL pro zprávy, které nejsou ve "viditelném" stavu (toto URL se nikdy v prezentační vrstvě nepoužije) a případně pro zprávy ve stavu ''Archivováno'', tj. pokud je zpráva nahrazena novou verzí a stará přechází do stavu ''Archivováno'', nová verze má převzaté URL a archivovaná má jiné URL, než původně měla.

Pokud je tedy požadováno zachovávání URL mezi různými verzemi zpráv, nejdůležitější zásadou je, že je třeba nakonfigurovat automatické vyplňování pole Zkratka. S využitím pouze ID zprávy nelze funkčnost zachování URL mezi verzemi zpráv implementovat. Potřebné pravidlo pro ''mod_rewrite'' pak musí využívat tvar URL zpráv WebToDate s uvedením obsahu pole zkratka.

Možné nastavení konfiguračních konstant podporujících zachování URL mezi verzemi zpráv je např.:

<code>
<nowiki>define( 'DETAILURL', '/dokument.html' );</nowiki>
<nowiki>define( 'NEWSABBREV_AUTOFILL', '');</nowiki>
<nowiki>define( 'NEWSURL_AUTOUPDATE', 2);</nowiki>
<nowiki>define( 'ABBREV_AUTOFILL_ON_PUBLISH', true);</nowiki>
<nowiki>define( 'NEWSABBREV_LOCK', true);</nowiki>
</code>

=== Způsoby změny URL stránek ===
V prezentační části webu se používá '''Prezentační URL''' stránky. Tato funkce je zavedena proto, aby bylo možné používat v prezentační části srozumitelnější a pro vyhledávače více vhodná URL stránek. Sestavení prezentačního URL automatickým postupem se zásadně liší pro statické stránky (plně generované stránky, které se odesílají z disku www serveru tak jak jsou) a dynamické stránky (stránky obsahující nějaký prvek, který se doplňuje před odesláním stránky do prohlížeče uživatele, nejčastěji se jedná o seznamy zpráv).

==== Konfigurace tvarů URL pro statické stránky ====
Pro statické stránky se výchozí z '''Fyzického URL''' stránky. Při založení stránky je možné fyzické URL nadefinovat dle potřeby, takže se předpokládá, že takové URL nepotřebuje další optimalizaci. Výjimkou je poslední část URL - název souboru. Fyzické URL vyžaduje zadání názvu (např. ''index.htm''), ale tato část URL se nemusí používat v případě, že se jedná o výchozí dokument (z konfigurace www serveru) a jeho uvádění ani zpravidla není žádoucí z hlediska SEO (např. URL ''/mojerubrika/index.htm'' a ''/mojerubrika/'' pak poskytují stejný obsah, což může být vyhledávači penalizováno).

Proto je možno pro statické stránky nadefinovat, že v prezentačním URL má být název výchozích dokumentů odstraněn. Použijí se následující konfigurační konstanty v souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'':

<code>
<nowiki>define('REMOVE_DEFAULT_DOCUMENTS_FROM_URL', true );</nowiki>
<nowiki>define('DEFAULT_DOCUMENTS', 'default.htm;default.html;default.php' );</nowiki>
</code>

Konstanta REMOVE_DEFAULT_DOCUMENTS_FROM_URL nastavená na hodnotu ''true'' vyznačuje, že se při sestavování prezentačního URL statické stránky mají odstraňovat názvy výchozích dokumentů. Konstanta DEFAULT_DOCUMENTS pak definuje názvy těchto výchozích dokumentů oddělené středníkem. Zpravidla postačuje nadefinovat

<code>
<nowiki>define('DEFAULT_DOCUMENTS', NEW_CATEGORY_PAGE_NAME );</nowiki>
</code>

což znamená, že se název výchozího dokumentu přebírá z konstanty, kterým se definuje výchozí název nově zakládané stránky ve stromu kategorií.

Je nutné, aby názvy výchozích dokumentů v konfiguraci WebToDate odpovídaly názvům výchozích dokumentů www serveru. Výše uvedené nastavení tedy odpovídá v konfiguraci serveru Apache direktivě

<code>
<nowiki>DirectoryIndex default.htm default.html default.php</nowiki>
</code>

==== Konfigurace tvarů URL pro dynamické stránky ====
Pro definici tvaru prezentačního URL dynamických stránek slouží konfigurační konstanta SPAGEURL. Může se jednat např. o tvar

<code>
<nowiki>define( 'SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/cz/zahranicni/evropa/nejnovejsi-zpravy-pg273/''

Typické nastavení (do URL se vkládá jen cesta ve stromu kategorií a ID stránky) je

<code>
<nowiki>define('SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/zahranicni/evropa/-pg273/''

nebo pro vícejazyčné weby

<code>
<nowiki>define('SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/cz/zahranicni/evropa/-pg273/''

V definici konstanty SPAGEURL lze použít následující výrazy:

* <nowiki></nowiki> - ID stránky
* <nowiki></nowiki> - ID kategorie, ve které se stránka nachází
* <nowiki></nowiki> - konvertovaný titulek stránky (konverze ošetřuje to, aby v URL nebyly znaky s diakritikou a další nežádoucí znaky)
* <nowiki></nowiki> - cesta daná stromem kategorií (dle kategorie stránky), tedy např. ''/zahranicni/evropa/''
* <nowiki></nowiki> - zkratka jazyka stránky převedená na malá písmena

Výchozí hodnota konstanty (pokud není v ''global.php'' vůbec nadefinována) je

<code>
<nowiki>define( 'SPAGEURL', '/scripts/detail.php?pgid=' );</nowiki>
</code>

což odpovídá nativním URL dynamických stránek.

Při sestavování prezentačního URL se aplikují stejná nastavení ohledně zpracování URL jako [[#Odkaz nadpisu využívající ID zprávy|u zpráv]], tedy konfigurační konstanty URL_CONVERT_FIND, URL_CONVERT_REPLACE, URL_CONVERT_NOCHAR, URL_CONVERT_CASE, URL_CONVERT_OTHER_ENTITIES, URL_CONVERT_ENTITIES_CHAR a $url_convert_entities_map.

Navíc se pro stránky aplikují nastavení

PAGEURL_MAXLENGTH – maximální délka prezentačního URL pro dynamické stránky

PAGEURL_CONVERT_MAXLENGTH – maximální délka konvertovaného titulku stránky

tedy např.

<code>
<nowiki>define( 'PAGEURL_MAXLENGTH', 255);
define( 'PAGEURL_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

Způsob využívání konstant pro maximální délku, ošetření vzniku více lomítek za sebou, způsob konverze titulku apod. je analogický jako u URL zpráv.

==== Stránkování seznamů a tvary URL ====
Jsou-li pomocí konfigurační konstanty SPAGEURL pozměněny tvary URL dynamických stránek, je třeba v případě, že se používají stránkované seznamy zpráv, předefinovat i výchozí chování stránkovací lišty, jinak by sice první stránka v rámci stránkování měla přidělené prezentační URL, ale další stránky v rámci stránkování by již měly nativní tvar URL.

Pro tyto účely jsou v definici [[../Funkce Nastavení#Stránkování|stránkovacích lišt]] tři pole:

* '''Sestavovat odkazy''' – radiopřepínač ''Výchozí tvar'' / ''Čistá URL''
* '''URL první stránky''' – textové pole
* '''Suffix URL dalších stránek''' – textové pole

[[Image:referencniprirucka-urlstranek-strankovaci-lista.png|center]]

Radiopřepínač '''Sestavovat odkazy''' definuje, jak se budou sestavovat URL dosazovaná za klíčové slovo <nowiki></nowiki>. Výchozí hodnota je '''Výchozí tvar''', což reprezentuje nativní URL. Přepnutí na ''Čistá URL'' znamená, že se využijí další dvě pole pro definici tvaru odkazů. Tato definice vychází z toho, že první stránka v rámci stránkování má nějaké URL (v podstatě prezentační URL stránky) a URL dalších stránek v rámci stránkování vzniká tak, že se k URL první stránky připojí nějaký další řetězec (typicky obsahující informaci o stránkovaném seznamu a číslu stránky v rámci stránkování).

Máme-li v konfiguračním souboru nastaveno

<code>
<nowiki>define( 'SPAGEURL', '/scripts/detail.php?pgid=' );</nowiki>
</code>

a zároveň pole nastavena následovně:

'''URL první stránky:''' <nowiki></nowiki>

'''Suffix URL dalších stránek:''' <nowiki>&amp;conn=&amp;pg=</nowiki>

pak tento aparát opět generuje URL dynamických stránek i URL dalších stránek v rámci stránkování v nativním tvaru.

Kromě výrazu <nowiki></nowiki>, který reprezentuje prezentační URL stránky (nebo URL zprávy, pokud se jedná o stránkování příloh ke zprávě), lze ještě v poli '''URL první stránky''' použít výraz <nowiki></nowiki> reprezentující ID stránky nebo zprávy. Pro tato pole jsou k dispozici následující výrazy:

<nowiki></nowiki> - ID zobrazované stránky (URL první stránky lze definovat např. jako ''<nowiki>/scripts/detail.php?pgid=</nowiki>'')

<nowiki></nowiki> - zkratka zobrazované zprávy

<nowiki></nowiki> - prezentační URL zobrazované stránky

<nowiki></nowiki> - ID stránkovaného seznamu

<nowiki></nowiki> - číslo stránky v rámci stránkování seznamu

<nowiki></nowiki> - část URL za otazníkem tak jej generuje stránkovací lišta v nativním tvaru, čili např. ''<nowiki>pgid=173&conn=609&pg=4</nowiki>''

Klíčové slovo <nowiki></nowiki> dosazuje URL první stránky v rámci stránkování kontextově podle toho, o jaký typ zobrazovaného obsahu se jedná. V případě, že jde místo stránek o zprávy (např. se stránkovanou fotogalerií), můžeme požadovat tvar URL

''/zpravy/domaci/nadpis-zpravy-190870/''

pro první stránku zprávy v rámci stránkování, a

''/zpravy/domaci/nadpis-zpravy-190870/70/2/''

pro další stránku v rámci stránkování.

Pokud chceme dosáhnout URL typu ''/zahranicni/evropa/nejnovejsi-zpravy-pg173/609/4/'' (první část je prezentační URL první stránky v rámci stránkování, ''609'' je ID seznamu, ''4'' je číslo stránky v rámci stránkování), nastavíme:

'''URL první stránky''': <nowiki></nowiki>

'''Suffix URL dalších stránek''': <nowiki>//</nowiki>

Pokud se např. stránkuje fotogalerie a pro identifikaci zpráv se používá zkratka, je nativní tvar URL ''/scripts/detail.php?abbrev=29143&conn=614&pg=2''. Vzhledem k tomu, že <nowiki></nowiki> v tomto případě dosadí URL zprávy, lze použít uvedené nastavení i pro tento případ a URL typu ''<nowiki>/zpravy/domaci/nadpis-zpravy-3333/70/2/</nowiki>'' by mělo být funkční i v tomto případě (''3333'' je zde ovšem zkratka zprávy, což musí ošetřit příslušný ''rewrite rule'').

WebToDate/Referenční/URL stránek

2018-02-21T15:48:04Z

Jardac: /* konfigurační pole $g_urlLanguageAbbrevs */

[[Category:WebToDate Referenční]]
[[Category:Referenční]]
== Jaká URL WebToDate používá a vytváří ==
Tato kapitola obsahuje informace o tom, jak se tvoří URL www stránek v prezentační části v systému WebToDate. Tato informace je nutná v případech, kdy je třeba vytvořit nabídku odkazů či použít v těle zprávy odkaz na jinou stránku apod.

=== URL stránek ===

URL stránek definovaných v systému a zobrazovaných ve stromu stránek je zpravidla totožné s URL zadaném v poli '''URL stránky''' ve formuláři pro definici stránky. Výjimkou jsou stránky obsahující seznam nebo zprávu přiřazené dynamicky nebo stránky v privátní zóně, v tom případě je třeba použít URL ve tvaru

''/scripts/detail.php?pgid=ID_stránky.''

Tento prezentační skript se používá pro zobrazování stránek i zpráv, podporované parametry skriptu jsou následující:

* ''id'' – ID zprávy
* ''abbrev'' – zkratka zprávy
* ''pgid'' – ID stránky
* ''conn'' – ID instance seznamu, který se stránkuje
* ''pg'' – číslo stránky v rámci stránkování
* ''newsid'' – ID zprávy obsahující seznam typu přílohy, používá se pro fotogalerie v URL zdroje
* ''listid'' – ID zobrazovaného seznamu, používá se pro fotogalerie v URL zdroje
* ''returnurl'' – návratová adresa pro vložení odkazu zpět na stránku se zprávou, , používá se pro fotogalerie v URL zdroje
* ''tmplid'' – ID předlohy, která se má použít místo výchozí

Pro další stránku v rámci stránkování seznamu vloženého do stránky dynamicky se tedy vygeneruje tvar typu ''/scripts/detail.php?pgid=273&conn=5140&pg=2''.

=== URL zpráv ===

URL zpráv je ve výchozí konfiguraci ve tvaru

''/scripts/detail.php?id=ID_zprávy''

Kromě parametru ''id'' se ještě nejčastěji používají parametry:

* ''abbrev'' – tento parametr slouží k zadání zkratky zprávy, hodnota musí korespondovat s obsahem pole Zkratka ve formuláři pro úpravu zpráv. Pokud píšete manuálně často odkaz na určitou zprávu, zadejte zkratku v poli '''Zkratka''' a použijte odkaz ''/scripts/detail.php?abbrev=zkratka'', toto URL se lépe pamatuje než číslo zprávy přidělené systémem
* ''tmplid'' – ID předlohy, jež se má použít pro zobrazení; toto id vynucené z URL má přednost před zadáním předlohy v definici zpráv. Tuto vlastnost lze s výhodou využít pro oblíbenou funkci ''Verze pro tisk'', či pro zobrazení stejných zpráv různě v různém kontextu (z jiné rubriky, z jiného virtuálního serveru apod.). Volání má pak tvar ''/scripts/detail.php?id=ID_zprávy&tmplid=ID_předlohy''

=== URL zdrojů ===

Pro URL zdrojů (tj. stránek používaných pro zobrazení jednoho souboru ve zdroji v HTML kódu s popisky apod., tedy typicky pro obrázek ve fotogalerii) platí to samé co pro zprávy, navíc se dají použít parametry:

* ''newsid'' - parametrem se předává ID zprávy, ve které se zobrazuje daná fotogalerie
* ''listid'' - parametrem se předává ID seznamu, ve kterém se fotogalerie zobrazuje
* ''returnurl'' - parametrem lze předat návratovou adresu, která se použije pro návrat zpět na fotogalerii

=== URL souborů ===

Pokud se soubor nachází ve veřejné zóně, je jeho URL statické a definované ve vlastnostech souboru ve zdroji. Při vložení souboru do zdroje může dojít k jeho přejmenování, které má za cíl, aby na serveru nebyly uloženy soubory, pro které by odkazy na ně vytvářely nevalidní URL. Standardně se při tomto přejmenování postupuje následovně:

# Písmena v názvu se převádí na spodní polovinu ASCII tabulky (tedy znak č na c apod.)
# Provádí se náhrada znaků definovaných v konfiguračních konstantách URL_CONVERT_FIND, URL_CONVERT_REPLACE, URL_CONVERT_NOCHAR (viz další kapitola o možnostech generování URL zpráv)
# Znaky se volitelně převádějí na malá nebo velká písmena dle konfigurační konstanty ASSETS_FILENAME_CONVERT_CASE
# Pokud ve výsledku v názvu souboru zbudou nějaké znaky, které nejsou v URL přípustné, nahradí se znakem definovaným v konstantě ASSETS_AUTOREPAIR_FILENAMES.

V konfiguraci WebToDate lze ale zvolit i jiný přístup k eventuálnímu přejmenování souborů, viz např. konfigurační konstanta ASSETS_SET_SIMPLE_FILENAMES.

Pokud se soubor nachází v privátní zóně, je jeho URL dynamické ve tvaru ''/scripts/file.php?id=ID_souboru''.

Dalším parametrem skriptu ''file.php'' může být parametr ''down''. Pokud má hodnotu ''yes'', vyznačuje se tím žádost o stažení souboru. Pokud tedy uvedeme ve stylu odkaz typu

<code>
<nowiki><a href="/scripts/file.php?id=&down=yes"></a></nowiki>
</code>

klepnutím na tento odkaz se místo pokusu o zobrazení souboru v prohlížeči vyvolá dialog pro uložení souboru na disk.

<div class="note">Poznámka: tato funkce pracuje s vložením dodatečných parametrů do http hlavičky (''Content-Disposition'' apod.). Záleží na prohlížeči, zda tyto druhy hlaviček podporuje, funkčnost ve všech existujících www prohlížečích není zaručena. Pokud daný prohlížeč tyto hlavičky ignoruje, dojde ke standardnímu zobrazení souboru v prohlížeči.</div>

Pokud parametr ''down'' není uveden nebo má jakoukoli jinou hodnotu než ''yes'', dodatečné parametry do http hlavičky se nevkládají a soubor je odesílán do prohlížeče tak, jak je.

=== URL pro přesměrování ===
K dispozici je skript, pomocí kterého lze přesměrovat na zadané URL. Skript je umístěn na adrese ''/scripts/modules/redir/default.php''. Jako jediný parametr má parametr ''trg'', do kterého se vkládá cílové URL. Skript akceptuje http metody GET a POST.

Skript provádí bezpečnostní kontroly na hodnoty parametru ''trg'' a dále kontrolu na to, že se nevolá přesměrování mimo daný server (cílové URL začíná lomítkem). Pokud kontroly projdou v pořádku, přesměruje na URL dané parametrem ''trg'', pokud kontroly v pořádku neprojdou, vyvolá se http chyba 404.

Příkladem využití může být případ, kdy chceme ve stránce zobrazit rozevírací nabídku formuláře, kde se po výběru položky z nabídky a potvrzení tlačítkem formuláře přechází na stránku danou výběrem z této nabídky. Kód formuláře je pak cca následující:

<code>
<nowiki><form action="/scripts/modules/redir/default.php" method="get"></nowiki>
<nowiki><select name="trg"></nowiki>
<nowiki><option value="url1">Položka 1</option></nowiki>
<nowiki><option value="url2">Položka 2</option></nowiki>
<nowiki><option value="url3">Položka 3</option></nowiki>
<nowiki></select></nowiki>
<nowiki><br /></nowiki>
<nowiki><input type="submit" value="Vyhledat" class="button" /></nowiki>
<nowiki></form></nowiki>
</code>

=== URL stránek modulů ===

Většina modulů WebToDate obsahuje svoje prezentační skripty. Např. URL stránky pro vyhledávání v databázi zpráv modulu [[../../Fulltext|Fulltext]] má tvar ''/scripts/modules/fulltext/fulltxt.php''. Konkrétní seznamy prezentačních skriptů a jejich parametrů naleznete v příručkách k jednotlivým modulům.

== Možnosti změn ve tvaru URL stránek ==
Techniky popsané v této kapitole slouží ke změně tvaru nativních URL zpráv či stránek v prezentační části. Cílem je dosáhnout přehlednějších a pro vyhledávače lépe přizpůsobených tvarů URL, které se zpravidla označují jako ''Cool URI'', ''SEO-friendly URLs'' apod.

Tyto techniky vyžadují nasazení modulu www serveru [http://httpd.apache.org Apache]. ''[http://httpd.apache.org/docs/2.2/rewrite/ mod_rewrite]'' (podobné ISAPI moduly třetích stran existují i pro [http://www.iis.net Microsoft IIS], resp. jej firma Microsoft dodává pro [http://www.iis.net/download/URLRewrite IIS 7]). Typická pravidla pro nasazení ''mod_rewrite'' v kombinaci s WebToDate jsou popsána v návodu [[../../Návody/Doporučené přepisy URL|Doporučené přepisy URL]].

=== Odkaz nadpisu využívající ID zprávy ===
URL zpráv mohou mít místo nativního tvaru ''/scripts/detail.php?id=xxx'' např. tvar ''/dokumentxxx.htm'', ale i např. ''/zpravy/zahranicni/KLDR-a-USA-zahajily-rozhovory-o-krocich-k-normalizaci-vztahu-54253''/,'' což je vhodnější tvar např. pro vyhledávací roboty.

Princip této funkce je následující:

* WebToDate připouští dva možné "fyzické" tvary URL zprávy - ''/scripts/detail.php?id=xxx'' (ID zprávy je automaticky přidělované celé číslo) nebo ''/scripts/detail.php?abbrev=yyy'' (parametr ''abbrev'' je obsah textového pole '''Zkratka''' ve vstupním formuláři pro zprávy, které může být definováno ručně nebo generováno automaticky, musí být unikátní v rámci celé databáze zpráv.
* Pomocí sady konfiguračních konstant se definuje, v jakém tvaru se generuje obsah pole '''Odkaz nadpisu''' nebo eventuálně '''Zkratka''', kdy se automaticky tento obsah při uložení zprávy obnovuje a další potřebné vlastnosti, což umožňuje, aby URL zpráv byla optimální z hlediska SEO.
* Pomocí ''mod_rewrite'' se nadefinuje vhodné pravidlo, které převádí vygenerovaná URL na "fyzická" URL zpráv. Přitom pokud se ve výsledném URL může vyskytovat ID zprávy, převádí příslušné pravidlo URL na tvar ''/scripts/detail.php?id=xxx'', pokud je požadováno, aby se číselné ID v URL nevyskytovalo a URL mělo čistě textový tvar, využívá se obsah pole '''Zkratka''' a pravidle ''mod_rewrite'' převod na tvar ''/scripts/detail.php?abbrev=yyy''.

Z hlediska konfigurace WebToDate je pro tuto funkci primární nastavení tvaru přidělovaného URL. Jedná se o konstantu

<code>
<nowiki>define( 'DETAILURL', '/scripts/detail.php?id=' );</nowiki>
</code>

Pokud tuto konstantu přepíšete na

<code>
<nowiki>define( 'DETAILURL', '/dokument.htm' );</nowiki>
</code>

budou automaticky přidělovaná URL pro nově vkládané zprávy (v poli '''Odkaz nadpisu''') v tvaru podle předchozího příkladu. Lze zde ovšem použít výběr z následujících výrazů:

* <nowiki></nowiki> - ID zprávy
* <nowiki></nowiki> - zkratka zprávy
* <nowiki></nowiki> - konvertovaný nadpis (konverze ošetřuje to, aby v URL nebyly znaky s diakritikou a další nežádoucí znaky)
* <nowiki></nowiki> - cesta daná stromem kategorií (dle výchozí kategorie zprávy), tedy např. /zahranicni/evropa/
* <nowiki></nowiki> - zkratka jazyka zprávy převedená na malá písmena
* <nowiki></nowiki> - část cesty podle data zprávy, tedy např. /2007/08/22/.

Druhá konfigurační konstanta NEWSABBREV_AUTOFILL definuje tvar obsahu pole '''Zkratka'''.

<code>
<nowiki>define( 'NEWSABBREV_AUTOFILL', '');</nowiki>
</code>

V definici této konstanty lze použít výrazy:

* <nowiki></nowiki> - ID zprávy
* <nowiki></nowiki> - konvertovaný nadpis

Následující tabulka uvádí různé možnosti konfigurace těchto dvou základních konstant - cílové tvary URL a způsob jejich nastavení.

{| class="prettytable"
| URL (Odkaz nadpisu)
| /domaci/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /2007/09/07/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /domaci/2007/09/07/lidovci-a-zeleni-zuzili-vyber-kandidatu-77628/

|-
| Zkratka
| ''Prázdná hodnota''

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>-</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| ''Prázdná hodnota''

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /clanky/lidovci-a-zeleni-zuzili-vyber-kandidatu/

|-
| Zkratka
| lidovci-a-zeleni-zuzili-vyber-kandidatu

|-
| Předpis pro vyplňování - Odkaz nadpisu
| /clanky/<nowiki></nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| <nowiki></nowiki>

|-
| colspan="2" |

|-
| URL (Odkaz nadpisu)
| /domaci/clanky/lidovci-a-zeleni-zuzili-vyber-kandidatu/

|-
| Zkratka
| lidovci-a-zeleni-zuzili-vyber-kandidatu

|-
| Předpis pro vyplňování - Odkaz nadpisu
| <nowiki>clanky/</nowiki>/

|-
| Předpis pro vyplňování - Zkratka
| <nowiki></nowiki>

|}

Pokud se do URL vkládá zkratka jazyka <nowiki></nowiki>, lze předefinovat vkládání konkrétních zkratek jazyků. Použije se pole

<nowiki>$g_urlLanguageAbbrevs = array('en' => 'en', 'cs' => '');</nowiki>

Toto konfigurační PHP pole mapuje zkratky jazyků tak jak jsou zadány v nastavení jazyků a uloženy v databázi, a zkratky použité následně v URL. Např. v tomto konkrétním případě se ve výsledku pro jazyk en vloží zkratka en a pro jazyk cs se zkratka nevloží.

Kromě základních konfiguračních konstant DETAILURL a NEWSABBREV_AUTOFILL je ovšem k dispozici sada dalších nastavení, pomocí kterých se definuje:

* Způsob případné konverze pole Nadpis do URL
* Omezení maximálních délek pro URL a zkratky
* Způsob řešení toho, jak se automaticky řeší případ, kdy by algoritmus vygeneroval zkratku, která již v databázi existuje (pro případ, že by byl např. stejný nadpis několika různých zpráv)
* Kdy se URL či zkratka automaticky generuje či mění
* Jak mohou uživatelé WebToDate do procesu generování URL či zkratek zasahovat

Následující čtyři konstanty definují převod znaků do URL (při konverzi nadpisu zpráv do pole '''Zkratka''' a '''Odkaz nadpisu'''). První dvě konstanty definují mapování jednotlivých znaků (tj. obě musí obsahovat stejný počet znaků), třetí konstanta definuje, které znaky se nahrazují za prázdný řetězec. Čtvrtá konstanta pak definuje, zda se provádí převod znaků na malá nebo velká písmena nebo zůstává rozlišení malých a velkých písmen jako v nadpisu zprávy.

<code>
<nowiki>define( 'URL_CONVERT_FIND', ',. \\/&' );</nowiki>
<nowiki>define( 'URL_CONVERT_REPLACE', '------' );</nowiki>
<nowiki>define( 'URL_CONVERT_NOCHAR', '\'"#$%()+@?!' );</nowiki>
<nowiki>define( 'URL_CONVERT_CASE', 'LOWER' );</nowiki>
</code>

Pokud se do nadpisu vloží nějaký znak, který není v cílové znakové sadě serveru, převede se na číselnou HTML entitu, která se pak objeví ve vygenerovaném URL zprávy, což zpravidla není příliš žádoucí. Aby byla možnost zamezit přenosu těchto entit do URL, jsou k dispozici následující nastavení:

<code>
<nowiki>$url_convert_entities_map = array(</nowiki>

<nowiki>'&#187;' => '-',</nowiki>

<nowiki>'&#51;' => '3'</nowiki>

<nowiki>);</nowiki>

<nowiki>define( 'URL_CONVERT_OTHER_ENTITIES', true );</nowiki>

<nowiki>define( 'URL_CONVERT_ENTITIES_CHAR', '' );</nowiki>
</code>

Nejprve se nahrazují entity podle pole ''$url_convert_entities_map''. V druhém kroku se všechny zbylé numerické entity nahradí za znak URL_CONVERT_ENTITIES_CHAR (může být i prázdný znak), ale jen v případě, že je nastaveno URL_CONVERT_OTHER_ENTITIES = true.

Postup převodu znaků z nadpisu zprávy do URL je tedy následující:

# Nahrazují se HTML entity a numerické entity
# Znaky uvedené v konstantě URL_CONVERT_FIND se nahrazují za znaky v URL_CONVERT_REPLACE a znaky uvedené v URL_CONVERT_NOCHAR se nahrazují prázdným znakem
# Takto vzniklý řetězec se převádí na spodních 128 znaků ASCII tabulky (tedy znak č na c apod.)
# Podle nastavení konstanty URL_CONVERT_CASE se provádí případný převod na malá nebo velká písmena.

Je nutné omezit maximální délku zkratky a URL - vzhledem k volitelnému nastavení tvaru zkratky či URL je možný případ, kdy by vygenerovaný řetězec byl delší než maximální počet znaků pro tato pole v databázi. K tomu jsou určeny konstanty:

<code>
<nowiki>define( 'NEWSURL_MAXLENGTH', 255);</nowiki>
</code>

NEWSURL_MAXLENGTH definuje maximální délku obsahu pole '''Odkaz nadpisu'''. Pokud je sestavený řetězec delší, ořízne se zprava na tuto hodnotu.

<code>
<nowiki>define( 'NEWSURL_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

NEWSURL_CONVERT_MAXLENGTH definuje maximální délku té části URL, která vzniká konverzí s využitím výrazu <nowiki></nowiki>. Pokud je tedy výsledek konverze nadpisu delší než zadaná konstanta, ořízne se zprava.

<code>
<nowiki>define( 'NEWSABBREV_MAXLENGTH', 150);</nowiki>
</code>

NEWSABBREV_MAXLENGTH definuje maximální celkovou délku zkratky, význam je stejný jako u NEWSURL_MAXLENGTH, pouze se aplikuje na obsah pole '''Zkratka'''.

<code>
<nowiki>define( 'NEWSABBREV_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

Význam konstanty NEWSABBREV_CONVERT_MAXLENGTH je stejný jako NEWSURL_CONVERT_MAXLENGTH, pouze se aplikuje na obsah pole '''Zkratka'''.

U zkratky se musí počítat s tím, že může v případě konverze nadpisu do zkratky dojít k vytvoření zkratky, která není unikátní, unikátnost zkratky je ale nutným předpokladem fungování URL založených na zkratkách. Proto je zde konstanta

<code>
<nowiki>define ('NEWSABBREV_UNIQUE_DELIMITER', '_');</nowiki>
</code>

V případě vygenerování zkratky, která již existuje, se postupuje tak, že se unikátní hodnoty pole '''Zkratka''' vytvářejí pomocí oddělovače plus čísla na konci; konstanta NEWSABBREV_UNIQUE_DELIMITER definuje tento oddělovač. Nedochází k efektu dvou oddělovačů za sebou, tj. pokud již existuje zpráva ze zkratkou např. abc_2, nová zpráva má zkratku abc_3 a nikoli abc_2_1.

Konstanta NEWSURL_AUTOUPDATE definuje režim automatických změn obsahu polí '''Odkaz nadpisu''' a '''Zkratka'''.

<code>
<nowiki>define( 'NEWSURL_AUTOUPDATE', 0);</nowiki>
</code>

Možné hodnoty jsou:

* 0 - zkratka se automaticky nevyplňuje, URL se přidělí podle konstanty DETAILURL při prvním uložení zprávy a už se nikdy automaticky nemění
* 1 - zkratka se automaticky vyplňuje pokud je konstanta NEWSABBREV_AUTOFILL neprázdná. Jak zkratka tak URL se vyplní při prvním uložení zprávy a už se automaticky nemění
* 2 - zkratka a URL se může automaticky změnit při uložení, pokud se změnily údaje, podle kterých se tvoří (seznam údajů je daný konstantami NEWSABBREV_AUTOFILL resp. DETAILURL) a pokud zpráva není ve stavu ''Publikováno'' či ''Archivováno''.
* 3 - stejné jako předchozí případ, ale změna zkratky i URL je povolena i v případě, že zpráva je ve stavu ''Publikováno'' či ''Archivováno''.

Konstanta NEWSURL_AUTOUPDATE tedy v zásadě definuje úroveň možnosti změnit URL zprávy v průběhu zpracování a změn. Hodnota 0 znamená nejjednodušší stav, kdy se zkratka nepoužívá a URL se na začátku vytvoří a již se pak nemění, čím vyšší číslo, tím méně je zaručeno, že zpráva si zachová původní URL, ale na druhou stranu se tím více URL přizpůsobuje (z hlediska tvaru pro SEO) aktualizaci metadat zprávy (změně nadpisu, změně kategorie apod.).

Algoritmus automatického sestavování URL a zkratky popisuje následující diagram.

[[Image:referencniprirucka-urlstranek-img171.png|center]]

V rámci verzování zpráv lze chování URL nastavit pomocí konfigurační konstanty ABBREV_AUTOFILL_ON_PUBLISH.

<code>
<nowiki>define('ABBREV_AUTOFILL_ON_PUBLISH', false);</nowiki>
</code>

Hodnota ''true'' znamená, že je požadováno zachování URL mezi různými verzemi zpráv (tj. při publikaci nové verze se přebírá zkratka a URL předchozí publikované verze), hodnota ''false'' znamená, že URL různých verzí zprávy spolu nesouvisejí a chovají se z tohoto hlediska jako samostatné zprávy. Tato možnost zachovávání URL je popsána v následující kapitole.

Konstanta NEWSABBREV_LOCK definuje, zda uživatelé mohou ručně měnit zkratku.

<code>
<nowiki>define('NEWSABBREV_LOCK', false);</nowiki>
</code>

Hodnota ''false'' znamená, že pole je možné běžným způsobem editovat. Hodnota ''true'' znamená, že uživatelé s výjimkou členů týmu ''Administrátoři'' nemají možnost hodnotu tohoto pole měnit.

Pro zdroje lze určit, zda se systém uživatelsky definovatelných URL a zkratek používá i pro ně (myšleno pro pole '''Odkaz nadpisu''' ve zdroji).

<code>
<nowiki>define('ASSETS_FRIENDLY_URL', false);</nowiki>
</code>

Pokud je konstanta ASSETS_FRIENDLY_URL nastavena na hodnotu ''true'', generují se zkratky a URL pro zdroje stejně jako pro zprávy, v opačném případě se zkratky negenerují a URL se vytvářejí v systémovém tvaru.

Další pravidla lze v ''mod_rewrite'' definovat i pro vybrané stránky jiného typu. Pokud chcete, aby taková stránka byla např. výchozí stránka nějaké kategorie (na kterou se odkazují navigace), která je zobrazovaná dynamicky, označte ji jako výchozí stránku a zároveň do pole URL ve vlastnostech kategorie zadejte URL tak jak je definováno v ''mod_rewrite''.

=== Zkratky a zachování URL verzí zpráv ===

Jak je uvedeno výše, zprávy lze zobrazovat i s využitím pole '''Zkratka'''. Výchozí tvar URL je pak ''/scripts/detail.php?abbrev=zkratka'', samozřejmě pak lze pomocí ''mod_rewrite'' nadefinovat jiný tvar URL využívající zkratku. Není-li pole v konfiguraci uzamčeno pro editaci, je obsah pole '''Zkratka''' je volně upravovatelný. V případě využívání této možnosti je třeba si uvědomit následující skutečnosti:

* Nekontroluje se vyplnění tohoto pole, pole může být i prázdné
* Když je pole vyplněno a v předpisu pro URL zprávy se zkratka využívá, může se změnit URL zprávy v poli '''Odkaz nadpisu'''.

Pokud je nastavena konfigurační konstanta ABBREV_AUTOFILL_ON_PUBLISH na hodnotu ''false'', znamená to, že není požadováno zachování URL mezi verzemi a jednotlivé verze zpráv se v tomto smyslu chovají jako samostatné zprávy.

Pokud je nastavena konstanta ABBREV_AUTOFILL_ON_PUBLISH na hodnotu ''true'', znamená to, že se při publikaci zprávy spouští funkce na převzetí URL a zkratky z předchozí publikované verze. Vyhodnocení toho, co je předchozí verze nezáleží na pořadovém číslu verze, hledá se jiná publikovaná verze zprávy.

Funkce pro převzetí URL z předchozí verze pracuje následovně:

# publikovaná zpráva přebírá zkratku i URL předchozí verze
# pro předchozí verzi se spouští algoritmus vygenerování zkratky a URL dle konfiguračních konstant. To znamená, že předchozí verze přecházející do jiného stavu dostane URL a zkratku v podstatě jako kdyby tato zpráva byla nově založena.

To pak má následující efekt:

* Pokud se postupně publikují nové verze stejné zprávy, URL se nemění pro aktuální verzi zprávy.
* Mění se URL pro zprávy, které nejsou ve "viditelném" stavu (toto URL se nikdy v prezentační vrstvě nepoužije) a případně pro zprávy ve stavu ''Archivováno'', tj. pokud je zpráva nahrazena novou verzí a stará přechází do stavu ''Archivováno'', nová verze má převzaté URL a archivovaná má jiné URL, než původně měla.

Pokud je tedy požadováno zachovávání URL mezi různými verzemi zpráv, nejdůležitější zásadou je, že je třeba nakonfigurovat automatické vyplňování pole Zkratka. S využitím pouze ID zprávy nelze funkčnost zachování URL mezi verzemi zpráv implementovat. Potřebné pravidlo pro ''mod_rewrite'' pak musí využívat tvar URL zpráv WebToDate s uvedením obsahu pole zkratka.

Možné nastavení konfiguračních konstant podporujících zachování URL mezi verzemi zpráv je např.:

<code>
<nowiki>define( 'DETAILURL', '/dokument.html' );</nowiki>
<nowiki>define( 'NEWSABBREV_AUTOFILL', '');</nowiki>
<nowiki>define( 'NEWSURL_AUTOUPDATE', 2);</nowiki>
<nowiki>define( 'ABBREV_AUTOFILL_ON_PUBLISH', true);</nowiki>
<nowiki>define( 'NEWSABBREV_LOCK', true);</nowiki>
</code>

=== Způsoby změny URL stránek ===
V prezentační části webu se používá '''Prezentační URL''' stránky. Tato funkce je zavedena proto, aby bylo možné používat v prezentační části srozumitelnější a pro vyhledávače více vhodná URL stránek. Sestavení prezentačního URL automatickým postupem se zásadně liší pro statické stránky (plně generované stránky, které se odesílají z disku www serveru tak jak jsou) a dynamické stránky (stránky obsahující nějaký prvek, který se doplňuje před odesláním stránky do prohlížeče uživatele, nejčastěji se jedná o seznamy zpráv).

==== Konfigurace tvarů URL pro statické stránky ====
Pro statické stránky se výchozí z '''Fyzického URL''' stránky. Při založení stránky je možné fyzické URL nadefinovat dle potřeby, takže se předpokládá, že takové URL nepotřebuje další optimalizaci. Výjimkou je poslední část URL - název souboru. Fyzické URL vyžaduje zadání názvu (např. ''index.htm''), ale tato část URL se nemusí používat v případě, že se jedná o výchozí dokument (z konfigurace www serveru) a jeho uvádění ani zpravidla není žádoucí z hlediska SEO (např. URL ''/mojerubrika/index.htm'' a ''/mojerubrika/'' pak poskytují stejný obsah, což může být vyhledávači penalizováno).

Proto je možno pro statické stránky nadefinovat, že v prezentačním URL má být název výchozích dokumentů odstraněn. Použijí se následující konfigurační konstanty v souboru ''[[../Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'':

<code>
<nowiki>define('REMOVE_DEFAULT_DOCUMENTS_FROM_URL', true );</nowiki>
<nowiki>define('DEFAULT_DOCUMENTS', 'default.htm;default.html;default.php' );</nowiki>
</code>

Konstanta REMOVE_DEFAULT_DOCUMENTS_FROM_URL nastavená na hodnotu ''true'' vyznačuje, že se při sestavování prezentačního URL statické stránky mají odstraňovat názvy výchozích dokumentů. Konstanta DEFAULT_DOCUMENTS pak definuje názvy těchto výchozích dokumentů oddělené středníkem. Zpravidla postačuje nadefinovat

<code>
<nowiki>define('DEFAULT_DOCUMENTS', NEW_CATEGORY_PAGE_NAME );</nowiki>
</code>

což znamená, že se název výchozího dokumentu přebírá z konstanty, kterým se definuje výchozí název nově zakládané stránky ve stromu kategorií.

Je nutné, aby názvy výchozích dokumentů v konfiguraci WebToDate odpovídaly názvům výchozích dokumentů www serveru. Výše uvedené nastavení tedy odpovídá v konfiguraci serveru Apache direktivě

<code>
<nowiki>DirectoryIndex default.htm default.html default.php</nowiki>
</code>

==== Konfigurace tvarů URL pro dynamické stránky ====
Pro definici tvaru prezentačního URL dynamických stránek slouží konfigurační konstanta SPAGEURL. Může se jednat např. o tvar

<code>
<nowiki>define( 'SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/cz/zahranicni/evropa/nejnovejsi-zpravy-pg273/''

Typické nastavení (do URL se vkládá jen cesta ve stromu kategorií a ID stránky) je

<code>
<nowiki>define('SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/zahranicni/evropa/-pg273/''

nebo pro vícejazyčné weby

<code>
<nowiki>define('SPAGEURL', '-pg/' );</nowiki>
</code>

což ve výsledku generuje tvar typu

''/cz/zahranicni/evropa/-pg273/''

V definici konstanty SPAGEURL lze použít následující výrazy:

* <nowiki></nowiki> - ID stránky
* <nowiki></nowiki> - ID kategorie, ve které se stránka nachází
* <nowiki></nowiki> - konvertovaný titulek stránky (konverze ošetřuje to, aby v URL nebyly znaky s diakritikou a další nežádoucí znaky)
* <nowiki></nowiki> - cesta daná stromem kategorií (dle kategorie stránky), tedy např. ''/zahranicni/evropa/''
* <nowiki></nowiki> - zkratka jazyka stránky převedená na malá písmena

Výchozí hodnota konstanty (pokud není v ''global.php'' vůbec nadefinována) je

<code>
<nowiki>define( 'SPAGEURL', '/scripts/detail.php?pgid=' );</nowiki>
</code>

což odpovídá nativním URL dynamických stránek.

Při sestavování prezentačního URL se aplikují stejná nastavení ohledně zpracování URL jako [[#Odkaz nadpisu využívající ID zprávy|u zpráv]], tedy konfigurační konstanty URL_CONVERT_FIND, URL_CONVERT_REPLACE, URL_CONVERT_NOCHAR, URL_CONVERT_CASE, URL_CONVERT_OTHER_ENTITIES, URL_CONVERT_ENTITIES_CHAR a $url_convert_entities_map.

Navíc se pro stránky aplikují nastavení

PAGEURL_MAXLENGTH – maximální délka prezentačního URL pro dynamické stránky

PAGEURL_CONVERT_MAXLENGTH – maximální délka konvertovaného titulku stránky

tedy např.

<code>
<nowiki>define( 'PAGEURL_MAXLENGTH', 255);
define( 'PAGEURL_CONVERT_MAXLENGTH', 150);</nowiki>
</code>

Způsob využívání konstant pro maximální délku, ošetření vzniku více lomítek za sebou, způsob konverze titulku apod. je analogický jako u URL zpráv.

==== Stránkování seznamů a tvary URL ====
Jsou-li pomocí konfigurační konstanty SPAGEURL pozměněny tvary URL dynamických stránek, je třeba v případě, že se používají stránkované seznamy zpráv, předefinovat i výchozí chování stránkovací lišty, jinak by sice první stránka v rámci stránkování měla přidělené prezentační URL, ale další stránky v rámci stránkování by již měly nativní tvar URL.

Pro tyto účely jsou v definici [[../Funkce Nastavení#Stránkování|stránkovacích lišt]] tři pole:

* '''Sestavovat odkazy''' – radiopřepínač ''Výchozí tvar'' / ''Čistá URL''
* '''URL první stránky''' – textové pole
* '''Suffix URL dalších stránek''' – textové pole

[[Image:referencniprirucka-urlstranek-strankovaci-lista.png|center]]

Radiopřepínač '''Sestavovat odkazy''' definuje, jak se budou sestavovat URL dosazovaná za klíčové slovo <nowiki></nowiki>. Výchozí hodnota je '''Výchozí tvar''', což reprezentuje nativní URL. Přepnutí na ''Čistá URL'' znamená, že se využijí další dvě pole pro definici tvaru odkazů. Tato definice vychází z toho, že první stránka v rámci stránkování má nějaké URL (v podstatě prezentační URL stránky) a URL dalších stránek v rámci stránkování vzniká tak, že se k URL první stránky připojí nějaký další řetězec (typicky obsahující informaci o stránkovaném seznamu a číslu stránky v rámci stránkování).

Máme-li v konfiguračním souboru nastaveno

<code>
<nowiki>define( 'SPAGEURL', '/scripts/detail.php?pgid=' );</nowiki>
</code>

a zároveň pole nastavena následovně:

'''URL první stránky:''' <nowiki></nowiki>

'''Suffix URL dalších stránek:''' <nowiki>&amp;conn=&amp;pg=</nowiki>

pak tento aparát opět generuje URL dynamických stránek i URL dalších stránek v rámci stránkování v nativním tvaru.

Kromě výrazu <nowiki></nowiki>, který reprezentuje prezentační URL stránky (nebo URL zprávy, pokud se jedná o stránkování příloh ke zprávě), lze ještě v poli '''URL první stránky''' použít výraz <nowiki></nowiki> reprezentující ID stránky nebo zprávy. Pro tato pole jsou k dispozici následující výrazy:

<nowiki></nowiki> - ID zobrazované stránky (URL první stránky lze definovat např. jako ''<nowiki>/scripts/detail.php?pgid=</nowiki>'')

<nowiki></nowiki> - zkratka zobrazované zprávy

<nowiki></nowiki> - prezentační URL zobrazované stránky

<nowiki></nowiki> - ID stránkovaného seznamu

<nowiki></nowiki> - číslo stránky v rámci stránkování seznamu

<nowiki></nowiki> - část URL za otazníkem tak jej generuje stránkovací lišta v nativním tvaru, čili např. ''<nowiki>pgid=173&conn=609&pg=4</nowiki>''

Klíčové slovo <nowiki></nowiki> dosazuje URL první stránky v rámci stránkování kontextově podle toho, o jaký typ zobrazovaného obsahu se jedná. V případě, že jde místo stránek o zprávy (např. se stránkovanou fotogalerií), můžeme požadovat tvar URL

''/zpravy/domaci/nadpis-zpravy-190870/''

pro první stránku zprávy v rámci stránkování, a

''/zpravy/domaci/nadpis-zpravy-190870/70/2/''

pro další stránku v rámci stránkování.

Pokud chceme dosáhnout URL typu ''/zahranicni/evropa/nejnovejsi-zpravy-pg173/609/4/'' (první část je prezentační URL první stránky v rámci stránkování, ''609'' je ID seznamu, ''4'' je číslo stránky v rámci stránkování), nastavíme:

'''URL první stránky''': <nowiki></nowiki>

'''Suffix URL dalších stránek''': <nowiki>//</nowiki>

Pokud se např. stránkuje fotogalerie a pro identifikaci zpráv se používá zkratka, je nativní tvar URL ''/scripts/detail.php?abbrev=29143&conn=614&pg=2''. Vzhledem k tomu, že <nowiki></nowiki> v tomto případě dosadí URL zprávy, lze použít uvedené nastavení i pro tento případ a URL typu ''<nowiki>/zpravy/domaci/nadpis-zpravy-3333/70/2/</nowiki>'' by mělo být funkční i v tomto případě (''3333'' je zde ovšem zkratka zprávy, což musí ošetřit příslušný ''rewrite rule'').

Kategorie:WebToDate Fulltext SOLR

2017-08-15T14:27:53Z

Jardac: Založena nová stránka s textem „Category:Uživatelská dokumentace WebToDate Category:Fulltext“

[[Category:Uživatelská dokumentace WebToDate]]
[[Category:Fulltext]]

WebToDate/Fulltext SOLR

2017-08-15T14:26:56Z

Jardac: Založena nová stránka s textem „Category:WebToDate Fulltext SOLR Category:Fulltext '''Manuál modulu Fulltext SOLR''' #O produktu #:/O produktu#Základní vlastn…“

[[Category:WebToDate Fulltext SOLR]]
[[Category:Fulltext]]
'''Manuál modulu Fulltext SOLR'''
#[[/O produktu|O produktu]]
#:[[/O produktu#Základní vlastnosti modulu|Základní vlastnosti modulu]]
#:[[/O produktu#Co modul umožňuje|Co modul umožňuje]]
#:[[/O produktu#Porovnání modulů Fulltext a Fulltext SOLR|Porovnání modulů Fulltext a Fulltext SOLR]]
#[[/Instalace|Instalace]]
#:[[/Instalace#Manuální instalace|Manuální instalace]]
#::[[/Instalace#Soubory|Soubory]]
#::[[/Instalace#Registrace plánovaných úloh|Registrace plánovaných úloh]]
#[[/Začínáme|Začínáme]]
#:[[/Začínáme#Indexace webu|Indexace webu]]
#:[[/Začínáme#Vyhledávání na webu – vytvoření vyhledávací stránky|Vyhledávání na webu – vytvoření vyhledávací stránky]]
#[[/Reference|Reference]]
#:[[/Reference#Administrační rozhraní|Administrační rozhraní]]
#::[[/Reference#Nabídka modulu|Nabídka modulu]]
#::[[/Reference#Nástroje|Nástroje]]
#::[[/Reference#Nastavení|Nastavení]]
#::[[/Reference#Administrace|Administrace]]
#::[[/Reference#Data|Data]]
#:[[/Reference#Veřejné skripty|Veřejné skripty]]
#::[[/Reference#Prezentační skript|Prezentační skript]]
#::[[/Reference#Klíčová slova modulu|Klíčová slova modulu]]
#::[[/Reference#Formulářová pole a další možné parametry skriptu|Formulářová pole a další možné parametry skriptu]]
#[[/Tipy a návody|Tipy a návody]]
#:[[/Tipy a návody#Volba způsobu formátování výsledků hledání|Volba způsobu formátování výsledků hledání]]
#[[/Dodatky|Dodatky]]
#:[[/Dodatky#Vyhledávací podmínky|Vyhledávací podmínky]]
#:[[/Dodatky#Databázové struktury|Databázové struktury]]
#:[[/Dodatky#XML protokol pro výsledky hledání|XML protokol pro výsledky hledání]]

WebToDate

2017-08-15T14:20:11Z

Jardac: /* Příručky modulů, extenzí a rozšíření WebToDate */

[[Category:Uživatelská dokumentace WebToDate]]
=== Příručky systému WebToDate ===
:[[/Redaktorská|Příručka redaktora]]
:[[/Referenční|Referenční příručka]]
:[[/WYSIWYG editor|WYSIWYG editor]]
:[[/Utility|Příručka WebToDate utility]]

===Příručky modulů, extenzí a rozšíření WebToDate===
:[[/Ankety|Příručka modulu Ankety]]
:[[/Cachování|Příručka extenze pro cachování zpráv]]
:[[/Diskuze|Příručka modulu Diskuze]]
:[[/Formuláře a katalogy|Příručka modulu Formuláře a katalogy]]
:[[/Fulltext|Příručka modulu Fulltext]]
:[[/Fulltext Google|Příručka modulu Fulltext Google]]
:[[/Fulltext SOLR|Příručka modulu Fulltext SOLR]]
:[[/Import Newton|Příručka modulu Import Newton]]
:[[/Kalendář akcí|Příručka modulu Kalendář akcí]]
:[[/Neveřejná část|Příručka modulu Neveřejná část]]
:[[/Offline generátor|Příručka modulu Offline generátor]]
:[[/Poradny a rozhovory|Příručka modulu Poradny a rozhovory]]
:[[/Publikace a vydání|Příručka modulu Publikace a vydání]]
:[[/Registrace a personalizace|Příručka modulu Registrace a personalizace]]
:[[/Rozesílání e-mailem|Příručka modulu Rozesílání e-mailem]]
:[[/Soutěže|Příručka modulu Soutěže]]
:[[/Stránkování zpráv|Příručka modulu Stránkování zpráv]]
:[[/Tvůrci obsahu|Příručka modulu Tvůrci obsahu]]
:[[/Verifikace|Příručka modulu Verifikace]]
:[[/Veřejné zakázky|Příručka modulu Veřejné zakázky]]
:[[/Výpisy zpráv|Příručka modulu Výpisy zpráv]]
:[[/XML export - import|Příručka modulu XML Export - import]]
:[[/Generování sitemap.xml|Úlohy pro generování sitemap.xml]]

:[[/Extenze|Standardně dodávané extenze WebToDate]]

:[[/Přehled plánovaných úloh|Přehled plánovaných úloh]]

=== Dokumentace pro vývojáře ===
:[[/Příručka vývojáře|Příručka vývojáře]]
:[[/Struktura databáze|Popis struktury databáze]]

Hlavní strana

2017-05-10T10:05:42Z

Jardac: /* Odstranění odkazu na návod k Project Tracking */

Wiki dokumentace systému pro správu obsahu WebToDate.
== Příručky k produktu ==

{| border="1" cellpadding="2" cellspacing="0" width="600"
|-
! width="50%" | Dokumentace WebToDate
! Dokumentace k modulům WebToDate
|- bgcolor="#efefef"
! colspan="2" | Nejpoužívanější dokumentace
|- valign="top"
|
* [[WebToDate/Referenční|Referenční příručka WebToDate]]
* [[WebToDate/WYSIWYG editor|WYSIWYG editor]]
* [[WebToDate/Redaktorská|Příručka redaktora]]
|
* Modul [[WebToDate/Ankety|Ankety]]
* Modul [[WebToDate/Diskuze|Diskuze]]
* Modul [[WebToDate/Formuláře a katalogy|Formuláře a katalogy]]
* Modul [[WebToDate/Kalendář akcí|Kalendář akcí]]
* Modul [[WebToDate/Neveřejná část|Neveřejná část]]
* Modul [[WebToDate/Poradny a rozhovory|Poradny a rozhovory]]
* Modul [[WebToDate/Registrace a personalizace|Registrace a personalizace]]
|- bgcolor="#efefef"
! colspan="2" | Kompletní seznam dokumentace
|- valign="top"
|
* [[WebToDate#Příručky systému WebToDate|Manuály WebToDate]]
|
* [[WebToDate#Příručky modulů, extenzí a rozšíření WebToDate|Příručky všech modulů]]
|- bgcolor="#efefef"
! colspan="2" | Informace pro redaktory a editory
|- valign="top"
|
* [[WebToDate/Redaktorská|Příručka redaktora]]
* [[WebToDate/WYSIWYG editor|WYSIWYG editor]]
* [[WebToDate/Referenční/Zprávy|Práce se zprávami]]
* [[WebToDate/Referenční/Zdroje|Práce se zdroji]]
* [[WebToDate/Referenční/Stránky a předlohy#Vybraná stránka|Práce se stránkami]]
* [[WebToDate/Referenční/Workflow obsahu|Workflow a verzování obsahu]]
* [[WebToDate/Referenční/Strom kategorií|Správa struktury prezentace]]
|
* [[WebToDate/Diskuze/Reference#Data|Moderování diskuzních skupin]]
* [[WebToDate/Ankety/Reference#Data|Vkládání anket]]
* [[WebToDate/Poradny a rozhovory/Reference#Data|Správa obsahu poraden]]
* [[WebToDate/Kalendář akcí/Reference#Data|Správa obsahu kalendáře akcí]]
|}

WebToDate/Registrace a personalizace/Tipy a návody

2017-05-10T10:02:50Z

Jardac: /* Zobrazování informací o přihlášeném uživateli */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Možné způsoby aktivace a deaktivace registračních záznamů ==
Aby mohl registrovaný uživatel registrační záznam využívat, tj. přihlásit se na něj, musí být tento záznam aktivní. Z tohoto hlediska nabízí modul následující možnosti:

# záznam se stává aktivní hned při jeho vytvoření – tato možnost se nastaví tak, že se ve formuláři '''Předvolby''' nastaví ''Výchozí stav registrace : Aktivní''.
# záznam aktivuje uživatel, který se registroval pomocí odkazu v potvrzovacím e-mailu. Funkce je vhodná zejména pro ověření platnosti zadaných e-mailů. Tato možnost se nastaví tak, že se ve formuláři '''Předvolby''' nastaví ''Výchozí stav registrace : Neaktivní'', zvolí se zde ''Zasílat potvrzení : Nové registrace'' a zaškrtne se ''Aktivace z e-mailu''. Musí být správně nadefinovaná předloha pro tyto e-maily včetně klíčového slova <nowiki></nowiki>, které dosadí do e-mailu aktivační URL.
# záznam aktivuje ručně obsluha modulu. Tato možnost se nastaví tak, že se ve formuláři '''Předvolby''' nastaví ''Výchozí stav registrace : Neaktivní''. Dále je vhodné pomocí nastavení ''Zasílat administrátorovi : nové registrace'' generovat e-mailová upozornění na nové registrace. Záznamy uživatelů se upravují pomocí funkce '''Data''' – '''Uživatelé''', v kartě uživatele je zaškrtávací okénko ''Aktivní'', které je třeba zaškrtnout a formulář uložit.

Záznamy mohou mít rovněž datum expirace, podle kterého lze řídit vypršení platnosti záznamu, tj. jeho deaktivaci. Aby se deaktivace automaticky prováděly, musí být v pravidelných intervalech spouštěna plánovaná úloha '''Expirace registrovaných uživatelů'''. Možnosti nastavení data expirace jsou následující:

# Datum je nastavováno automaticky jako určitý počet dní od data registrace. Toto se nastaví ve formuláři '''Předvolby''' ve volbě ''Datum expirace automaticky'', možnost ''vložit x dnů po registraci''.
# Datum je nastavováno automaticky jako určitý počet dní od data aktivace. Toto se nastaví ve formuláři '''Předvolby''' ve volbě ''Datum expirace automaticky'', možnost ''vložit x dnů po aktivaci''. Pokud se aktivace provádí ručně z administračního rozhraní, doplní se datum v praxi při první aktivaci. Pokud se následně záznam deaktivuje a po nějaké době zase aktivuje, datum expirace se již automaticky nezmění.
# Datum se zadá ručně v administračním rozhraní ve formuláři pro úpravu registračního záznamu.

Další manipulace s daty expirace (např. prodloužení platnosti apod.) je třeba již řešit ručně přímou úpravou registračního záznamu uživatele.

== Ukládání, zpracování a využívání údajů anonymních uživatelů ==
Pokud modul nějakým způsobem aktivně pracuje s uživateli veřejné části (např. obsahuje vstupní formuláře s osobními daty uživatele) nebo dokonce má být přístupný pouze pro registrované uživatele, využívá knihovny a funkce modulu Registrace a personalizace.

Tyto funkce mají za cíl:

* Standardizovanou metodou ošetřit přístup ke stránkám určeným pouze pro registrované uživatele
* Vést databázi anonymních uživatelů a sbírat osobní údaje těchto uživatelů
* Použít informace z databáze anonymních či registrovaných uživatelů tak, aby uživatel nemusel vyplňovat opakovaně údaje již jednou na server zadané.

Každý modul, u kterého to má smysl (nebo jeho část), je přepnutelný z hlediska přístupu uživatelů do jednoho ze čtyř výše zmíněných režimů (např. '''Pouze registrovaní, explicitní přihlášení''' apod.).

Pro manipulaci s osobními údaji se používají následující zásady:

* Údaje uživatele potřebné pro práci modulu se vždy ukládají to příslušné tabulky konkrétního modulu (např. zadává-li v modulu '''Poradny''' uživatel svůj e-mail, na který mu má přijít odpověď z poradny, zapíše se tento e-mail do databáze dotazů poradny).
* Osobní údaje uživatele se kromě datových tabulek modulů zapisují do tabulky anonymních uživatelů ve všech případech s výjimkou toho, kdy je daný modul v režimu '''Anonymní uživatelé bez rozpoznávání'''.
* Osobní údaje se předvyplňují do formulářů ve všech případech kromě toho, kdy je modul přepnut do režimu '''Anonymní uživatelé bez rozpoznávání'''. Přitom se data načítají z tabulky anonymních uživatelů v případě, že je modul v režimu '''Anonymní uživatelé, automatické rozpoznávání''', z tabulky registrovaných v ostatních případech.
* Data v tabulce registrovaných uživatelů se nikdy nemění automaticky, vždy pouze explicitně v rámci modulu '''Registrace a personalizace''' (registračním formulářem nebo z administrační části).

Data modulu '''Registrace a personalizace''' se nacházejí v tabulkách s názvem začínajícím '''X''' (viz následující kapitola). Struktura uložených dat uživatelů je schématicky znázorněna na následujícím diagramu.

[[Image:registraceapersonalizace-tipyanavody-img029.png|center]]

Uživatel částí vyžadujících registraci a i ostatních modulů je opatřen XUSERID, na které jsou navázána všechna data tohoto uživatele. V tomto pojetí se pak registrace (XREGISTR) považuje za další datovou strukturu svázanou s daným XUSERID. Možný postup plnění tabulek v čase je pak např. následující:

# Uživateli se při návštěvě nějaké stránky modulu přiřadí nějaké GUID. To automaticky neznamená, že se něco zapisuje do databáze.
# Uživatel např. něco zapíše do anonymní diskusní skupiny – v tom případě vznikne zápis v XUSERGUID, XUSER a tabulkách diskusí.
# Uživatel se zaregistruje – vznikne zápis v XREGISTR odkázaný na příslušné XUSERID.
# Dokud nedojde k nestandardní situaci, na dané USERID se odkazují další a další záznamy v datových tabulkách modulů.
# Pokud dojde ke ztrátě cookie apod. (obdobná logická situace může nastat v případě, že uživatel např. používá dva počítače a přihlašuje se k databázi registrovaných uživatelů), může dojít k problémové situaci: díky nějaké činnosti se tomuto uživateli přidělilo nové GUID, XUSERID i eventuálně nějaké záznamy v datových tabulkách modulů. Pokud se potom uživatel následně přihlásí k registrované databázi, dochází k logickému konfliktu – má v tuto chvíli dvě USERID, kterým mohou v datových tabulkách odpovídat dvě sady dat. Konflikt se v rámci přihlašovacího skriptu řeší tímto postupem (USER1 je starší číslo platné do ztráty cookie, USER2 je nové číslo spřažené s novým cookie):

* V XUSERGUID se XUSERID přepíše u USER2 na USER1 pro aktuálně platné GUID
* Projdou se všechny tabulky všech modulů, ve kterých se vyskytuje nové USER2 a přesměrují se na USER1 podle tohoto pravidla: je-li v dané tabulce USER2, přečíslují se tyto záznamy na USER1 s výjimkou tabulek XREGISTR A XANONYMOUS; v XREGISTR se nikdy nic nemění, v XANONYMOUS platí, že je-li v dané tabulce pouze USER2, přečíslují se tyto záznamy na USER1, pokud jsou v dané tabulce USER1 i USER2, záznamy USER2 se mažou (přednost musí mít data svázaná s registrací)
* V tabulce XUSERGUID a XUSER se smažou záznamy s USER2, neboť již nikam neukazují.

Fungování lze v praxi ozřejmit na následujícím příkladu:

Modul '''Poradny a rozhovory''' má implementovanou poradnu, ve které je nastaveno ''Přihlašovací režim : Rozpoznávat anonymní uživatele''. Ve formuláři pro zadání nového dotazu je položka pro přezdívku:

<code>
<nowiki> <input type="text" name="nickname" value="" maxlength="80" /></nowiki>
</code>

Uživatel zadá nějaký dotaz do poradny a vyplní toto pole. Jeho hodnota bude v tu chvíli (kromě tabulky pro dotazy v poradně) uložena v databázi v poli XANONYMOUS.NICKNAME.

Modul '''Diskuze''' má implementovanou diskuzi, ve které je opět nastaveno ''Přihlašovací režim : Rozpoznávat anonymní uživatele''. Ve formuláři pro nový diskuzní příspěvek je pole pro přezdívku:

<code>
<nowiki><input type="text" name="nickname" value="" /></nowiki>
</code>

Ve chvíli, kdy se prázdný formulář zobrazí, je zde za klíčové slovo <nowiki></nowiki> vložena uchovaná přezdívka z XANONYMOUS.NICKNAME, tj. pole je již předvyplněno Pokud uživatel přezdívku nezmění, provede se ve chvíli uložení diskusního příspěvku zápis pouze do odpovídající tabulky diskuzí, pokud dojde ke změně, aktualizuje se i obsah pole XANONYMOUS.NICKNAME touto naposledy zadanou hodnotou.

== Avatary ==
Součástí modulu Registrace a personalizace je možnost vkládat avatary, tj. malé ikony s obrázky uživatelů, které se mohou následně zobrazovat např. v seznamech diskuzních příspěvků modulu Diskuze.

Je tedy možné:

* Do registračního formuláře pro novou registraci vložit pole pro upload obrázku avataru
* Do registračního formuláře pro změnu existující registrace vložit odkaz pro odstranění avataru z registračního profilu a pole pro upload obrázku avataru, pomocí kterého uživatel změní svůj avatar
* Do stránky s potvrzením registrace (nové i změny registrace) vložit zobrazení obrázku s avatarem.

=== První kroky ===

V předvolbách modulu je třeba povolit ukládání avatarů a nastavit další parametry. Výchozí adresář pro ukládání avatarů je ''/images/avatars''/,'' cestu je možné eventuálně změnit. Dále se v předvolbách nastavují povolené koncovky souborů pro obrázky s avatary, maximální velikost a maximální rozměry.

Na úrovni konfigurace přístupových práv systému je třeba na serveru povolit ukládání a změny souborů pro uživatele, pod kterým běží web server v adresáři, který je zvolen pro ukládání avatarů.

Formulář pro novou registraci a změnu registrace musí být v HTML kódu změněn na

<code>
<nowiki><form action="/scripts/modules/registration/registration.php" method="post" enctype="multipart/form-data"></nowiki>
</code>

čili musí být uvedeno ''enctype="multipart/form-data''".''

=== Implementace ===

Část registračního formuláře pro novou registraci či změnu registrace může vypadat např. následovně:

<code>
<nowiki><tr><td>Avatar</td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki>" width="" height="" alt="Váš avatar" /> <a href="">Odstranit avatar</a>")--></nowiki>
<nowiki> </td></nowiki>
<nowiki></tr></nowiki>
</code>

Využívá se zde podmíněné vkládání podle toho, zda uživatel již má či nemá avatar, tudíž je stejný kód použitelný pro novou registraci i její změnu. Pole ''<nowiki><input type="file" name="avatarfile"></nowiki>'' slouží pro upload avataru, ostatní klíčová slova slouží pro zobrazení avataru resp. pro zobrazení odkazu na smazání avataru.

Pokud je využívána možnost zobrazit stránku pro potvrzení registračních údajů, lze v ní použít kód zhruba ve tvaru

<code>
<nowiki><tr><td>Avatar</td></nowiki>
<nowiki><td></nowiki>
<nowiki></nowiki>
<nowiki>" alt="Váš avatar" />")--></nowiki>
<nowiki> </td></nowiki>
<nowiki></tr></nowiki>
</code>

Pokud tedy uživatel nevložil avatar, zobrazí se pouze informační text, v opačném případě je v potvrzovací stránce obrázek s avatarem.

Avatary lze vkládat a měnit jednotlivým uživatelům i z administračního rozhraní, jak je popsáno v kapitole [[../Reference#Data|Data]].

== Zobrazování informací o přihlášeném uživateli ==

Modul obsahuje aparát pomocí kterého lze zobrazovat v prezentační části webu informace o aktuálně přihlášeném uživateli. Tento aparát podporuje zobrazování v dynamických stránkách, tj. ve zprávách, ve stránkách zobrazovaných dynamicky a ve stránkách modulů. Pokud jsou stránky generované staticky (typicky úvodní stránka webu, stránky sekcí apod.), není zde jednoduchá možnost zobrazit informace o přihlášeném uživateli podporována.

Nejprve je třeba zaregistrovat extenzi modulu ''_user_inc.php'' (viz [[../Instalace#Umístění extenzí|Umístění extenzí]]).

Pak je třeba do šablon resp. předloh stránek ve kterých se mají údaje zobrazovat umístit kód, pomocí kterého se tyto údaje zobrazují, typicky cca

<code>
<nowiki> </strong>,
odhlásit se můžete <a href="/scripts/modules/registration/logout.php">zde</a>.</div>")--></nowiki>
</code>

Extenze podporuje podmíněné vkládání HTML kódu v případech že uživatel je či není přihlášen, a vložení základních informací o uživateli (křestní jméno, příjmení apod.). Více viz [[../Reference#Klíčová slova modulu|Klíčová slova modulu]].

WebToDate/Registrace a personalizace

2017-05-09T14:51:31Z

Jardac:

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
'''Manuál modulu Registrace a personalizace'''
#[[/O produktu|O produktu]]
#:[[/O produktu#Základní vlastnosti modulu|Základní vlastnosti modulu]]
#::[[/O produktu#Úvod|Úvod]]
#::[[/O produktu#Funkce modulu|Funkce modulu]]
#::[[/O produktu#Spolupráce s jinými moduly|Spolupráce s jinými moduly]]
#:[[/O produktu#Co modul umožňuje|Co modul umožňuje]]
#:[[/O produktu#Co modul neumožňuje|Co modul neumožňuje]]
#:[[/O produktu#Co je nového|Co je nového]]
#::[[/O produktu#Verze 4.0.2.1 modulu|Verze 4.0.2.1 modulu]]
#:[[/O produktu#Některé typické scénáře nasazení|Některé typické scénáře nasazení]]
#::[[/O produktu#Neveřejná zóna webu pro obchodní partnery|Neveřejná zóna webu pro obchodní partnery]]
#::[[/O produktu#Profesní komora|Profesní komora]]
#::[[/O produktu#Diskuze pouze pro registrované uživatele|Diskuze pouze pro registrované uživatele]]
#::[[/O produktu#Archív článků pro předplatitele|Archív článků pro předplatitele]]
#::[[/O produktu#Rozesílání newsletterů|Rozesílání newsletterů]]
#[[/Instalace|Instalace]]
#:[[/Instalace#Automatická instalace|Automatická instalace]]
#:[[/Instalace#Manuální instalace|Manuální instalace]]
#::[[/Instalace#Soubory|Soubory]]
#::[[/Instalace#Umístění extenzí|Umístění extenzí]]
#::[[/Instalace#Registrace plánovaných úloh|Registrace plánovaných úloh]]
#[[/Začínáme|Začínáme]]
#:[[/Začínáme#První kroky|První kroky]]
#:[[/Začínáme#Vytvoření registračního formuláře|Vytvoření registračního formuláře]]
#::[[/Začínáme#Úvod|Úvod]]
#::[[/Začínáme#Postup|Postup]]
#:[[/Začínáme#Vytvoření přihlašovací stránky|Vytvoření přihlašovací stránky]]
#::[[/Začínáme#Úvod|Úvod]]
#::[[/Začínáme#Postup|Postup]]
#:[[/Začínáme#Skupiny registrovaných uživatelů|Skupiny registrovaných uživatelů]]
#[[/Reference|Reference]]
#:[[/Reference#Administrační rozhraní|Administrační rozhraní]]
#::[[/Reference#Nabídka modulu|Nabídka modulu]]
#::[[/Reference#Administrace|Administrace]]
#::[[/Reference#Nastavení|Nastavení]]
#::[[/Reference#Nástroje|Nástroje]]
#::[[/Reference#Data|Data]]
#:[[/Reference#Veřejné skripty|Veřejné skripty]]
#::[[/Reference#Prezentační skripty|Prezentační skripty]]
#::[[/Reference#Klíčová slova modulu|Klíčová slova modulu]]
#::[[/Reference#Formulářová pole a další možné parametry prezentačních skriptů|Formulářová pole a další možné parametry prezentačních skriptů]]
#:[[/Reference#Plánované úlohy|Plánované úlohy]]
#:[[/Reference#Externí autentifikace uživatelů|Externí autentifikace uživatelů]]
#:[[/Reference#Rozhraní pro napojení jiných aplikací|Rozhraní pro napojení jiných aplikací]]
#::[[/Reference#Úvod|Úvod]]
#::[[/Reference#Vlastní API|Vlastní API]]
#::[[/Reference#XML formát|XML formát]]
#[[/Tipy a návody|Tipy a návody]]
#:[[/Tipy a návody#Možné způsoby aktivace a deaktivace registračních záznamů|Možné způsoby aktivace a deaktivace registračních záznamů]]
#:[[/Tipy a návody#Ukládání, zpracování a využívání údajů anonymních uživatelů|Ukládání, zpracování a využívání údajů anonymních uživatelů]]
#:[[/Tipy a návody#Avatary|Avatary]]
#::[[/Tipy a návody#První kroky|První kroky]]
#::[[/Tipy a návody#Implementace|Implementace]]
#:[[/Tipy a návody#Zobrazování informací o přihlášeném uživateli|Zobrazování informací o přihlášeném uživateli]]
#[[/Dodatky|Dodatky]]
#:[[/Dodatky#Databázové struktury|Databázové struktury]]

WebToDate/Registrace a personalizace/Tipy a návody

2017-05-09T14:50:02Z

Jardac: /* Zobrazování informací o přihlášeném uživateli */

WebToDate/Registrace a personalizace/Reference

2017-05-09T14:46:14Z

Jardac: /* Klíčová slova modulu */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.
* '''Minimální délka uživatelského jména a hesla''' - zadává se minimální délka už. jména a hesla, která se pak následně kontroluje při změně těchto údajů přes redakční rozhraní i v prezentační části. Uživatelským jménem je zde myšlen údaj označený jako '''Unikátní identifikátor''', může to tedy být uživatelské jméno nebo e-mailová adresa. Pokud není vyplněno, délka těchto údajů se nekontroluje
* '''Validace uživatelského jména''' - regulární výraz oproti kterému se kontroluje uživatelské jméno nebo e-mail (to co je označeno jako unikátní identifikátor). Pokud není vyplněno, údaj se nijak nekontroluje.
* '''Validace hesla''' - regulární výraz oproti kterému se kontroluje heslo. Pokud není vyplněno, údaj se nijak nekontroluje. Použití je analogické jako [[../../Referenční/Bezpečnost#Nastavení síly hesla|Nastavení síly hesla]] pro uživatele redakční části WebToDate.

====Práva====
V nabídce '''Práva''' lze zpřístupnit některé funkce modulu i jiným týmům než ''Administrátoři'', toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci '''Data''' nabídky modulu funkce '''Uživatelé''', '''Export''' a '''Statistika'''.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předlohách pro dynamické stránky WebToDate a modulů, které mají zobrazit údaje o přihlášeném uživateli pomocí extenze tohoto modulu.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách pro dynamické stránky WebToDate a jiných modulů

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|}

Extenze používá ještě následující konstrukce:

<nowiki></nowiki> - kód se vloží v případě, že uživatel je přihlášen
<nowiki></nowiki> - kód se vloží v případě, že uživatel není přihlášen

Typické použití je cca

<code>
<nowiki> </strong>,
odhlásit se můžete <a href="/scripts/modules/registration/logout.php">zde</a>.</div>")--></nowiki>
</code>

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|-
| USERNAMEVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání uživatelského jména neprošel tento údaj kontrolou (validačními pravidly) zadanou v předvolbách modulu

|-
| PASSWORDVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání hesla neprošlo heslo kontrolou (validačními pravidly) zadanou v předvolbách modulu

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

WebToDate/Registrace a personalizace/Reference

2017-05-09T14:45:21Z

Jardac: /* Klíčová slova modulu - klíčová slova extenze pro zobrazení jména přihlášeného uživatele */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.
* '''Minimální délka uživatelského jména a hesla''' - zadává se minimální délka už. jména a hesla, která se pak následně kontroluje při změně těchto údajů přes redakční rozhraní i v prezentační části. Uživatelským jménem je zde myšlen údaj označený jako '''Unikátní identifikátor''', může to tedy být uživatelské jméno nebo e-mailová adresa. Pokud není vyplněno, délka těchto údajů se nekontroluje
* '''Validace uživatelského jména''' - regulární výraz oproti kterému se kontroluje uživatelské jméno nebo e-mail (to co je označeno jako unikátní identifikátor). Pokud není vyplněno, údaj se nijak nekontroluje.
* '''Validace hesla''' - regulární výraz oproti kterému se kontroluje heslo. Pokud není vyplněno, údaj se nijak nekontroluje. Použití je analogické jako [[../../Referenční/Bezpečnost#Nastavení síly hesla|Nastavení síly hesla]] pro uživatele redakční části WebToDate.

====Práva====
V nabídce '''Práva''' lze zpřístupnit některé funkce modulu i jiným týmům než ''Administrátoři'', toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci '''Data''' nabídky modulu funkce '''Uživatelé''', '''Export''' a '''Statistika'''.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předlohách pro dynamické stránky WebToDate a modulů, které mají zobrazit údaje o přihlášeném uživateli pomocí extenze tohoto modulu.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách pro dynamické stránky WebToDate a jiných modulů

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|}

Extenze používá ještě následující konstrukce:

<nowiki></nowiki> - kód se vloží v případě, že uživatel je přihlášen
<nowiki></nowiki> - kód se vloží v případě, že uživatel není přihlášen

Typické použití je cca

<code>
<nowiki> </strong>,
odhlásit se můžete <a href="/scripts/modules/registration/logout.php">zde</a>.</div>")--></nowiki>
</code>

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|-
| USERNAMEVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání uživatelského jména neprošel tento údaj kontrolou (validačními pravidly) zadanou v předvolbách modulu

|-
| PASSWORDVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání hesla neprošlo heslo kontrolou (validačními pravidly) zadanou v předvolbách modulu

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

WebToDate/Registrace a personalizace/O produktu

2017-05-09T14:20:20Z

Jardac: /* Co je nového - verze 4.3.0.0 */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Základní vlastnosti modulu ==
=== Úvod ===

Modul Registrace a personalizace řeší obecně problematiku registrovaných uživatelů webové prezentace. Po instalaci modulu je zpřístupněna jeho "viditelná" část, která umožňuje vytvářet registrační formuláře, spravovat databázi registrovaných uživatelů apod. K modulu patří ale i sada knihoven, která není na první pohled viditelná a která je instalována s každou instalací WebToDate (i bez tohoto modulu). Tyto knihovny řeší zejména napojení na jiné moduly (Neveřejná část, Diskuze apod.) a funkce pracující na úrovni anonymních uživatelů. I anonymní uživatele lze pomocí cookies rozpoznávat a pomocí tohoto modulu řešit zejména to, aby opakovaně nebylo nutné zadávat některé osobní údaje (např. e-mailové adresy apod.).

Modul sám o sobě bez instalace dalších modulů nemá praktické použití, snad s výjimkou případu, kdy je žádoucí nechat uživatele dobrovolně zanechat na serveru svoje kontaktní údaje pro další potřeby dalších obchodních kontaktů s potenciálním zákazníkem. Modul je vhodné nasadit a využít např. v následujících případech:

* Chceme zpřístupnit část webové prezentace (část obsahu – zpráv, příloh ke stažení apod.) pouze vybraným skupinám registrovaných uživatelů. Kromě tohoto modulu je třeba nasadit modul '''Neveřejná část'''.
* Chceme založit diskuzní skupiny přístupné (některé nebo všechny) pouze registrovaným uživatelům. Kromě tohoto modulu je třeba nasadit modul '''Diskuze'''.
* Chceme provozovat webové poradny přístupné pouze registrovaným uživatelům. Kromě tohoto modulu je třeba nasadit modul '''Poradny a rozhovory'''.
* Chceme publikovat nějaká strukturovaná data (obsah nějakých databází) nebo naopak nějaká data přes www stránky shromažďovat (např. registrace na semináře či podobné akce) s omezením přístupu na určitou skupinu registrovaných uživatelů. Kromě tohoto modulu je třeba nasadit modul '''Formuláře a katalogy'''.

Pod pojmem "registrovaní uživatelé" se v předchozích případech může skrývat jak případ, kdy je skupina uživatelů omezená a chceme tento seznam spravovat my jako provozovatelé serveru (tj. zadat seznam uživatelů, přidělit jim hesla apod.), tak případ, kdy pouze vyžadujeme nějakou formu registrace přes veřejně přístupný www formulář, kterou provádí sám uživatel (např. pro případ, že chceme získat kontaktní údaje apod.).

=== Funkce modulu ===

Funkce modulu jsou znázorněny na následujícím diagramu.

[[Image:registraceapersonalizace-oproduktu-img001.png|center]]

V modulu je vedena databáze registrovaných uživatelů. Modul má integrován seznam možných položek tvořících strukturu této databáze (jméno, adresa, e-mail, uživatelské jméno, heslo, přezdívka atd.), ze kterých lze vybrat, které údaje se skutečně budou v daném nasazení používat. Uživatelé mohou být děleni do skupin, každý uživatel patří do právě jedné skupiny.

Registrace jsou označeny příznakem udávajícím, zda je daná registrace ''aktivní''. Pouze na aktivní registraci se lze přihlásit. Registrace mohou mít dále časovou platnost, tj. omezení konkrétním datem. Lze nadefinovat, co se s ukončením platnosti má s danou registrační položkou stát (zneaktivnit, přesunout do jiné skupiny uživatelů apod.).

Správa databáze registrovaných uživatelů je vždy možná přes administrační rozhraní modulu. Navíc lze vytvořit registrační formuláře, kterými lze vkládat nové registrace z veřejně přístupné části www prezentace. Tyto funkce umožňují zejména:

* Vkládat nové registrace
* Měnit existující registrace (po přihlášení)
* Formuláře mohou mít i potvrzovací část, kde lze v druhém kroku zkontrolovat zadané údaje
* Definovat, kdy se stává registrace aktivní. Možnosti jsou např. ihned po registraci, aktivování klepnutím na odkaz v e-mailu (vhodné pro ověření, že zadaná adresa existuje) či ruční aktivace obsluhou WebToDate.
* Definovat, zda je registrace opatřena časovou platností, např. daný interval od data registrace či aktivace.
* Definovat, zda je účet aktivní i po změně uživatelem nebo vyžaduje opět aktivaci

K tomu se váží funkce pro odesílání e-mailů. Jedná se zejména o:

* Možnost zasílání informací administrátorovi o všech nových nebo i změněných registracích
* Možnost zasílat potvrzení registrace uživatelům včetně možnosti aktivace přes odkaz v e-mailu
* Možnost nasazení funkce pro zasílání zapomenutých hesel

Dále jsou součástí modulu skripty pro přihlášení a odhlášení registrovaného uživatele.

=== Spolupráce s jinými moduly ===

Možnosti spolupráce s jinými moduly lze rozdělit v zásadě na dva okruhy nasazení:

# Přístup k určité části modulu má být umožněn pouze registrovaným uživatelům. Může se jednat o vybrané diskuze apod., speciálním případem je modul '''Neveřejná část''' řešící přístup registrovaných uživatelů přímo k obsahu spravovaném samotnou aplikací WebToDate (zprávám, stránkách či souborům z databáze zdrojů).
# Vybrané personální údaje vložené anonymními uživatele v některém modulu mají být použity opakovaně v daném modulu nebo v jiném modulu, který nějakým způsobem aktivně pracuje s uživateli.

<code>
<nowiki>Příklad: vytvoříme anonymní diskuzní skupinu, kde uživatel v rámci zadání diskusního příspěvku zadává e-mailovou adresu. Ve spolupráci s tímto modulem můžeme
nadefinovat funkčnost takovou, že při zadání příštího příspěvku se tato adresa danému uživateli automaticky předvyplní, navíc nemusí jít o stejný modul. Stejně tak se adresa může
předvyplnit v případě, že uživatel bude zadávat nový dotaz v rámci modulu '''Poradny a rozhovory''' apod.</nowiki>
</code>

Tyto funkce se v modulech řídí tzv. ''přihlašovacím režimem''. V modulech se můžete setkat s těmito nastaveními přihlašovacího režimu:

* '''Pouze registrovaní, explicitní přihlášení ''' - vkládání dat do modulu vyžaduje průchod přes přihlašovací stránku, údaj o přihlášení se drží v session
* '''Pouze registrovaní, automatické rozpoznávání''' – mohou používat opět pouze registrovaní uživatelé, ale pokud se pomocí cookie zjistí, že jde o registrovaného uživatele, nevyžaduje se přihlášení přes přihlašovací stránku
* '''Anonymní uživatelé, automatické rozpoznávání''' – modul může používat kdokoliv, ale pomocí cookies se uživatel sleduje a modul mu např. předvyplní e-mail v případě, že je tento již na serveru uložen
* '''Anonymní uživatelé bez rozpoznávání''' – v tomto případě se rezignuje na jakékoliv funkce ohledně cookies, pokud např. po sobě dvakrát zadává diskusní příspěvek a diskuse vyžaduje e-mail, musí jej dvakrát vyplnit.

Pokud je modul Registrace a personalizace instalován, jsou typicky v dalších modulech k dispozici všechny tyto volby (výjimkou je např. modul '''Neveřejná část''', kde volby pro anonymní uživatele nemají smysl). Pokud není instalován, jsou k dispozici pouze volby pro anonymní režimy (díky výše zmíněným knihovnám modulu instalovaným s každou verzí WebToDate).

Modul Registrace a personalizace mohou v současnosti aktivně využívat následující dodávané moduly WebToDate:

* Neveřejná část
* Diskuze
* Poradny a rozhovory
* Formuláře a katalogy
* Rozesílání e-mailem
* Soutěže

Knihovny pro práci s anonymními uživateli navíc využívá modul Ankety.

== Co modul umožňuje ==
Modul sám o sobě umožňuje z hlediska veřejně přístupné části webové prezentace vytvořit následující stránky:

# Stránku s registračním formulářem pro nové registrace
# Stránku pro změnu registračních údajů pro registrované uživatele
# Stránku pro přihlášení
# Stránku pro odhlášení
# Stránku pro zaslání zapomenutého hesla e-mailem

V administrační části modulu je pak možné kromě definice výše zmíněných stránek spravovat seznam registrovaných uživatelů a jejich skupin, provádět aktivace registrací a exportovat tyto seznamy.

K modulu patří dvě úlohy pro '''Plánovač úloh''' – jedna úloha může zpracovávat časovou platnost registrací a např. deaktivovat účty, kterým vypršela platnost, druhá úloha slouží k čištění databáze – odstraňování dat anonymních uživatelů, kteří server nenavštívili stanovenou dobu a čištění historie přihlášení registrovaných uživatelů.

== Co modul neumožňuje ==
Modul jednoduchým způsobem neumožňuje zobrazovat jinou podobu stejné stránky registrovaným a neregistrovaným uživatelům. Např. požadavek na to, aby se na každé stránce webu zobrazoval přihlašovací formulář, a pokud je uživatel přihlášen, místo formuláře viděl např. své jméno, je obecně nerealizovatelný. Důvodem je jednak to, že WebToDate generuje některé stránky jako statické a ty jsou pak z principu zobrazovány všem uživatelům stejně, jednak není podporováno modulární chování ve stránkách jiných modulů. To znamená, že lze relativně jednoduše vytvořit extenzi, která by zmíněnou funkčnost realizovala na úrovni např. zobrazování celých textů zpráv, ale nelze toto jednoduše doplnit např. do výpisu výsledků fulltextového hledání, do výpisu seznamů vydání apod., neboli do stránek sestavovaných dalšími moduly WebToDate.

Jeden registrovaný uživatel patří do právě jedné skupiny uživatelů, nelze tedy zařadit jednoho uživatele do více skupin. Toto je třeba zohlednit při nasazení dalších modulů, např. při plánovaní řízení přístupů k neveřejné části apod.

Modul nemá funkci pro import uživatelů, k dispozici je pouze funkce pro export. Pro import je třeba naprogramovat vlastní funkci nebo zákaznický modul WebToDate, který tuto funkci realizuje dle konkrétních okolností a požadavků v dané implementaci.

Autentifikace uživatelů je možná pouze vůči interní databázi registrací, která obsahuje i uživatelská hesla. Není podporována externí autentifikace např. vůči nějakému LDAP serveru, Active Directory či jiné SQL databázi.

Modul neobsahuje funkce, které by umožňovaly rozesílat e-maily všem registrovaným uživatelům nebo nějaké skupině registrovaných uživatelů. Tato funkčnost je implementována v modulu '''Rozesílání e-mailů''', kde lze rozesílat (kromě vlastních seznamů subskripcí modulu) i seznamům uživatelů dle databáze modulu Registrace a personalizace.

<div class="note">Při práci s modulem je třeba mít na paměti, že databáze uživatelů administrační části WebToDate a databáze uživatelů registrovaných v tomto modulu jsou dva naprosto jiné objekty, které nemají nic společného. To, že je nějaký uživatel např. ve WebToDate redaktorem, automaticky neznamená, že má přístup např. ke zprávám s omezením přístupu pomocí modulu '''Neveřejná část''' a naopak.</div>

== Co je nového ==
=== Verze 4.3.0.0 modulu ===

Tato verze obsahuje následující rozšíření:

* Pomocí funkce '''Práva''' lze nastavit týmy, které mají oprávnění v administraci modulu k sekci '''Data'''.
* Verze obsahuje funkce pro vynucení síly uživatelského jména a hesla uživatelů registrovaných v modulu.
* Modul obsahuje extenzi umožňující do dynamicky zobrazovaných stránek WebToDate a modulů vložit jméno přihlášeného uživatele a případně další údaje.

=== Verze 4.0.2.1 modulu ===

Verze 4.0.2.1 obsahuje následující rozšíření:

* V registracích lze využívat pole pro registrační kód, které je možné použít pro zadání předplatitelského čísla apod. V předvolbách lze nastavit, zda modul má při ukládání registrace hlídat unikátnost registračního kódu nebo lze zadávat tento kód libovolně.
* Jsou podporovány uživatelské avatary – uživatel může při registraci vložit svůj obrázek, který se pak může zobrazovat např. v modulu Diskuze v seznamech diskuzních příspěvků.
* Jsou odděleny předlohy pro novou registraci a změnu registrace. Pro dodatečné změny tak lze zpřístupnit jen některé registrační údaje, aby si uživatel nemohl měnit např. jednou zvolené uživatelské jméno apod.
* Je k dispozici jednoduché rozhraní pro napojení jiných aplikací, které poskytuje informace o registracích, buď formou uživatel je / není registrován nebo formou poskytnutí výpisu údajů o uživateli.

== Některé typické scénáře nasazení ==
=== Neveřejná zóna webu pro obchodní partnery ===

'''Problém'''

Chceme vytvořit část webové prezentace (stránky, zprávy, dokumenty ke stažení), která je přístupná pouze obchodním partnerům.

'''Řešení'''

Kromě tohoto modulu je třeba modul '''Neveřejná část'''. Databázi registrovaných uživatelů spravujeme ručně a individuálně jim přidělíme uživatelské jméno a heslo. V modulu Registrace a personalizace je třeba implementovat pouze přihlašovací stránku, registrační formuláře apod. není potřeba vytvářet.

Neveřejnou zónu vytvoříme nejjednodušeji jako jednu větev stromu kategorií WebToDate včetně podřízených kategorií, zde zvolíme ukládání stránek a souborů ze zdrojů do privátní zóny. V modulu '''Neveřejná část''' nadefinujeme odpovídající pravidla, která stanoví, jaká skupina uživatelů může přistupovat k této kategorii včetně podkategorií.

=== Profesní komora ===

'''Problém'''

Chceme vytvořit část webové prezentace, kde budou informace pouze pro členy profesní komory. Chceme vytvořit diskuzní skupinu, kde budou moci přispívat členové komory, ale příspěvky číst všichni uživatelé. Chceme vytvořit webovou poradnu, kde svoje dotazy budou klást členové komory, odpovídat bude vedení komory a obsah poradny bude dostupný pouze členům komory.

'''Řešení'''

Kromě tohoto modulu je třeba modul '''Neveřejná část''', '''Diskuze''' a '''Poradny a rozhovory'''. Členové komory se nemohou sami registrovat, tudíž je třeba vytvořit v modulu pouze stránku pro přihlášení a eventuálně stránku pro zaslání zapomenutého hesla.

Seznam členů komory bude pravděpodobně početnější. Bude třeba mimo aplikaci WebToDate vypracovat tento seznam a přidělit uživatelská jména a hesla. Rovněž import do tabulky registrovaných uživatelů je třeba řešit mimo standardní moduly WebToDate – buď specializovanou aplikací pracující přímo s databází nebo vývojem zákaznického modulu (vhodné zejména v případě periodických importů či synchronizací s jinou databází). Součástí tohoto zákaznické řešení bude i funkce umožňující rozeslání přístupových kódů na e-mailové adresy členů.

Neveřejná část prezentace bude vytvořena analogicky jako v předchozím případě. Výše uvedené požadavky na diskuze a poradnu jsou jednoduše splnitelné nastavením odpovídajících předvoleb v modulech '''Diskuze''' a '''Poradny a rozhovory'''.

=== Diskuze pouze pro registrované uživatele ===

'''Problém'''

Provozujeme běžnou webovou prezentaci s diskuzemi ke článkům, chceme, aby se uživatelé vkládající nové příspěvky do diskuzí registrovali.

'''Řešení'''

Kromě tohoto modulu je třeba modul '''Diskuze'''. Vytvoříme registrační formulář a stránku pro přihlášení. V modulu '''Diskuze''' nastavíme odpovídající předvolby, pro jednoduchost zde zvolíme režim '''Pouze registrovaní, automatické rozpoznávání''' – uživatel zadávající příspěvek pak nebude nucen zadat přihlašovací údaje vždy, ale jen ve chvíli, kdy nebude přes cookies rozpoznán (přejde na jiný počítač či prohlížeč apod.).

=== Archív článků pro předplatitele ===

'''Problém'''

Provozujeme elektronické noviny, chceme archív článků (tj. např. všechny články na serveru starší než 14 dní) zpřístupnit pouze předplatitelům, ať už skutečně platícím uživatelům nebo např. předplatitelům tištěné verze periodika.

'''Řešení'''

Kromě tohoto modulu je třeba modul '''Neveřejná část'''. Pomocí modulu '''Neveřejná část''' nadefinujeme pojem archív – články starší než, z kterých kategorií či publikací apod. V modulu Registrace a personalizace vytvoříme přinejmenším přihlašovací stránku.

Další postup může mít několik variant:

* Chceme, aby se uživatelé zaregistrovali sami, ale budeme provádět ručně jejich aktivaci. Lze použít např. pro skutečně placenou část – po registraci se uživateli zobrazí údaje pro platbu, po obdržení platby (řeší se mimo systém WebToDate) obsluha WebToDate ručně provede aktivaci účtu.
* Máme databázi předplatitelů a chceme jim archív automaticky zpřístupnit. Jako v případě ''Profesní komora'' je třeba řešit import resp. synchronizaci uživatelů a případné rozeslání přihlašovacích údajů. Registrační formulář pak není vůbec třeba.

V tomto scénáři lze rovněž využít možnost časové platnosti registrace. Lze nastavit např. to, že jednotlivé účty mají vypršet rok od aktivace, manuálně zadat datum vypršení platnosti (v případě předplatného na omezený počet měsíců) apod.

=== Rozesílání newsletterů ===

'''Problém'''

Chceme uživatelům rozesílat e-mailem zpravodajství (novinky apod.) z několika různých oblastí, uživatel si sám zvolí oblasti, ze kterých chce zprávy dostávat.

'''Řešení'''

Tuto úloha primárně řeší modul '''Rozesílání e-mailů'''. Modul Registrace a personalizace není pro provozování tohoto modulu podmínkou. Bej jeho instalace ale lze implementovat pouze jednoduché přihlašování k odběru zadáním e-mailové adresy z www stránky, odhlásit se lze pouze pomocí odkazu z e-mailu.

Pro uživatele registrované v modulu Registrace a personalizace lze navíc v modulu '''Rozesílání e-mailů''' vytvořit stránku, kde mohou po přihlášení měnit dle potřeby svoje nastavení těchto odběrů – zaškrtat požadované odběry, změnit e-mailovou adresu či požadovaný formát e-mailu apod.

WebToDate/Registrace a personalizace/Instalace

2017-05-09T14:16:08Z

Jardac: /* Umístění extenzí - extenze pro zobrazování jména přihlášeného uživatele */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Automatická instalace ==
Instalace modulu je součástí instalace WebToDate varianty Enterprise.

== Manuální instalace ==
=== Soubory ===

Zkopírujte obsah instalačního adresáře modulu do adresáře WebToDate. Soubory v instalačním adresáři modulu jsou uloženy v příslušných podadresářích, kopírování musí zachovat uložení v těchto adresářích.

Soubory se kopírují do adresářů

* application/modules/registration
* rdata/resources/modules/registration
* scripts/modules/registration
* scheduler/tasks/modules/registration
* gate/registration

<div class="note">Poznámka: v adresáři gate/registration se nachází strojové rozhraní pro ověřování registrovaných uživatelů nebo poskytování údajů o nich. Tento adresář by neměl být přístupný anonymně, jinak hrozí získání osobních dat registrovaných uživatelů nepovolanou osobou. Adresář je třeba na úrovni web serveru nebo operačního systému zabezpečit pro přístup pouze z těch aplikací, které mají ověřování registrací využívat, např. omezením přístupu na nějakou IP adresu nebo potřebný rozsah IP adres. Pokud tuto integrační funkci nebudete využívat, není nutné vůbec obsah tohoto adresáře instalovat.</div>

Po zkopírování těchto souborů vyvolejte z prohlížeče následující URL:

''Název_serveru/název_administračního adresáře/modules/registration/install.php''

Tedy např.

''www.mujserver.cz/admin/modules/registration/install.php''

Modul má funkci pro exporty seznamů uživatelů z databáze registrovaných uživatelů. Soubory se exportují do adresáře ''wwwroot/data/katalogy/export''/.'' Pokud tedy chcete tuto funkci využívat, ujistěte se, že daný adresář existuje (exportní funkce jej ale v případě potřeby zakládá automaticky).

=== Umístění extenzí ===

Do souboru ''config/_preprocess_inc.php'' umístěte následující kód:

<code>
<nowiki> $arrModules[] = 'common/_xutils_inc.php';</nowiki>
</code>

Pokud chcete v dynamicky zobrazovaných stránkách zobrazovat identifikaci přihlášeného uživatele (např. jeho jméno), do souborů ''config/_modules_inc.php'' a ''config/_mod_extensions_inc.php'' umístěte kód

<code>
<nowiki> $arrModules[] = 'registration/_user_inc.php';</nowiki>
</code>

=== Registrace plánovaných úloh ===

V adresářích ''scheduler/tasks/modules/registration/remove_old_data'' a ''scheduler/tasks/modules/registration/regexpire'' naleznete soubor ''_registration_node.xml''. XML kód z tohoto souboru vložte do souboru ''offlinedata/scheduler/registration.xml'' (registrační soubor plánovaných úloh) jako nový XML element pod kořenovým elementem ''<nowiki><registrationdb''></nowiki>.''

WebToDate/Registrace a personalizace/Reference

2017-05-09T14:09:56Z

Jardac: /* Klíčová slova modulu - informace o nedostatečné síle uživatelského jména nebo hesla */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.
* '''Minimální délka uživatelského jména a hesla''' - zadává se minimální délka už. jména a hesla, která se pak následně kontroluje při změně těchto údajů přes redakční rozhraní i v prezentační části. Uživatelským jménem je zde myšlen údaj označený jako '''Unikátní identifikátor''', může to tedy být uživatelské jméno nebo e-mailová adresa. Pokud není vyplněno, délka těchto údajů se nekontroluje
* '''Validace uživatelského jména''' - regulární výraz oproti kterému se kontroluje uživatelské jméno nebo e-mail (to co je označeno jako unikátní identifikátor). Pokud není vyplněno, údaj se nijak nekontroluje.
* '''Validace hesla''' - regulární výraz oproti kterému se kontroluje heslo. Pokud není vyplněno, údaj se nijak nekontroluje. Použití je analogické jako [[../../Referenční/Bezpečnost#Nastavení síly hesla|Nastavení síly hesla]] pro uživatele redakční části WebToDate.

====Práva====
V nabídce '''Práva''' lze zpřístupnit některé funkce modulu i jiným týmům než ''Administrátoři'', toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci '''Data''' nabídky modulu funkce '''Uživatelé''', '''Export''' a '''Statistika'''.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|-
| USERNAMEVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání uživatelského jména neprošel tento údaj kontrolou (validačními pravidly) zadanou v předvolbách modulu

|-
| PASSWORDVALIDATIONFAILED
| Registrační stránka a stránka pro změnu registrace
| Při zadání hesla neprošlo heslo kontrolou (validačními pravidly) zadanou v předvolbách modulu

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

WebToDate/Registrace a personalizace/Reference

2017-05-09T14:04:28Z

Jardac: /* Předvolby - nastavení síly už. jména a hesla */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.
* '''Minimální délka uživatelského jména a hesla''' - zadává se minimální délka už. jména a hesla, která se pak následně kontroluje při změně těchto údajů přes redakční rozhraní i v prezentační části. Uživatelským jménem je zde myšlen údaj označený jako '''Unikátní identifikátor''', může to tedy být uživatelské jméno nebo e-mailová adresa. Pokud není vyplněno, délka těchto údajů se nekontroluje
* '''Validace uživatelského jména''' - regulární výraz oproti kterému se kontroluje uživatelské jméno nebo e-mail (to co je označeno jako unikátní identifikátor). Pokud není vyplněno, údaj se nijak nekontroluje.
* '''Validace hesla''' - regulární výraz oproti kterému se kontroluje heslo. Pokud není vyplněno, údaj se nijak nekontroluje. Použití je analogické jako [[../../Referenční/Bezpečnost#Nastavení síly hesla|Nastavení síly hesla]] pro uživatele redakční části WebToDate.

====Práva====
V nabídce '''Práva''' lze zpřístupnit některé funkce modulu i jiným týmům než ''Administrátoři'', toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci '''Data''' nabídky modulu funkce '''Uživatelé''', '''Export''' a '''Statistika'''.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

Soubor:Registraceapersonalizace-reference-img012.png

2017-05-09T13:38:46Z

Jardac: Jardac načtena nová verze "Soubor:Registraceapersonalizace-reference-img012.png"

[[Category:WebToDate Registrace a personalizace]]
Registrace a personalizace - nastavení předvoleb modulu

WebToDate/Registrace a personalizace/Reference

2017-05-09T13:35:45Z

Jardac: /* Práva */

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.

====Práva====
V nabídce '''Práva''' lze zpřístupnit některé funkce modulu i jiným týmům než ''Administrátoři'', toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci '''Data''' nabídky modulu funkce '''Uživatelé''', '''Export''' a '''Statistika'''.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

WebToDate/Registrace a personalizace/Reference

2017-05-09T13:25:11Z

Jardac: /* Nabídka modulu - položka Práva*/

[[Category:WebToDate Registrace a personalizace]]
[[Category:Registrace a personalizace]]
== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nástroje'''

:Registrační formulář

:Potvrzení – stránky

:Potvrzení – e-mail

:Přihlašovací formulář

:Zapomenuté heslo

'''Nastavení'''

:Globální

::Stránky

::E-maily

::Zapomenuté heslo

'''Administrace'''

:Předvolby

:Práva

:Údaje

:Skupiny

'''Data'''

:Uživatelé

:Export

:Statistika

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

=== Administrace ===
====Předvolby====
Ve formuláři '''Předvolby''' se nastavuje základní chování modulu.

[[Image:registraceapersonalizace-reference-img012.png|center]]

Nastavují se následující předvolby:

* '''Přihlašovací režim''' – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci ''Změna registrace'' – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti ''session''.
* '''Unikátní identifikátor''' – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
* '''Registrační kód''' – volí se možnost ''Unikátní'' / ''Libovolný'' – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se ''Unikátní'', v opačném případě se ponechává volba ''Libovolný''.
* '''Potvrzovací stránka''' ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
* '''Výchozí stav registrace''' – Pokud je zvolena možnost ''neaktivní'', musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
* '''Výchozí skupina''' – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
* '''Při změně registrace''' – podobný význam jako ''Výchozí stav registrace'', volba ale určuje chování po změně registrace.
* '''Zasílat administrátorovi''' – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: ''nové registrace'' / ''i změněné registrace'' / ''nezasílat''.
* '''E-mail administrátora''' – na tuto adresu se zasílají e-maily z předchozího bodu
* '''Zasílat potvrzení''' – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze ''nové registrace'' / ''i změněné'' registrace / ''nezasílat''.
* '''Aktivace z e'''-'''mailu''' – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá ''Výchozí stav registrace'' neaktivní).
* '''Datum expirace automaticky''' – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.

Možné volby pro vkládání data expirace jsou:

* ''Nevkládat'' – datum expirace se automaticky nikdy nedoplňuje
* ''Vložit x dnů po registraci'' – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
* ''Vložit x dnů po aktivaci'' – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.

* '''Autentifikace''' - interní / externí. Interní autentifikace provádí přihlašování vůči interní databázi uživatelů, [[#Externí autentifikace uživatelů|externí]] provádí autentifikaci přes autentizační plugin, který může ověřit uživatele vůči jiné aplikaci (Active Directory, LDAP, jiné databázi apod.)
* '''Automatické zakládání uživatelů''' - možné volby Ano / Ne, volba je přístupná pouze pro externí autentifikaci. Pokud je zvoleno Ano, může autentizační plugin při přihlášení nového uživatele převzít jeho osobní údaje z externí aplikace a vložit je jako nový účet do databáze modulu.
* '''Povolit vkládání avatarů''' – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
* '''Cesta k adresáři s avatary''' – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je ''/images/avatars''/,'' modul pak zakládá pod zvoleným adresářem ještě adresář ''temp'', do kterého ukládá dočasné soubory.
* '''Maximální rozměry avatarů''' – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
* '''Povolené koncovky souborů''' – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
* '''Maximální velikost souborů''' – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.

====Údaje====
Ve formuláři '''Údaje''' se definuje, která pole se v registračních záznamech využívají.

[[Image:registraceapersonalizace-reference-img013.png|center]]

V tabulce jsou údaje organizovány do 4 sloupců:

* '''Název pole''' (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
* '''Popis''' (předvyplněný) – obsahuje popisek pole.
* Zaškrtávací okénko '''Použít''' definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
* Zaškrtávací okénko '''Vyžadovat''' určuje, zda bude vyplnění pole pro uživatele povinné.

Unikátní identifikátor je vždy zvolen a označen jako povinný.

Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce '''Nástroje''' – '''Registrační formulář''') a případně potvrzovací formulář ('''Nástroje''' – '''Potvrzení - stránka''') a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:

* Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři '''Údaje''' se na webové prezentaci nijak neprojeví.
* Pokud se přidá dodatečně další pole do struktury ve sloupci '''Použít''', pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci '''Použít''' dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
* Pokud změníte některou položku ve sloupci '''Vyžadovat''', změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení '''Údaje''' toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.

====Skupiny====
Funkce '''Skupiny''' definuje seznam skupin registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img014.png|center]]

Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.

=== Nastavení ===
====Stránky====
Ve formuláři '''Stránky''' se nastavují předlohy pro různé typy stránek používané modulem.

[[Image:registraceapersonalizace-reference-img015.png|center]]

Jedná se o následující typy stránek:

* '''Předloha pro registrační stránku''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
* '''Předloha pro potvrzovací stránku''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
* '''Předloha pro přihlašovací stránku''' – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
* '''Předloha pro automatickou aktivaci registraci''' – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
* '''Předloha pro změnu registrace''' – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
* '''Předloha pro potvrzení změny registrace''' – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.

Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. ''/scripts/modules/registration/registration.php'' apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.

====E-maily====
Ve formuláři '''E-maily''' se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.

[[Image:registraceapersonalizace-reference-img016.png|center]]

První pole '''E-mail od''' je globální a určuje, z které adresy se budou všechny e-maily odesílat.

<div class="note">Toto pole je třeba vyplnit vždy, když má modul rozesílat jakékoliv e-maily. Není-li vyplněno, žádné e-maily nejsou odesílány.</div>

Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:

* '''Předloha pro e-maily uživatelům''' – šablona pro e-maily odesílané jako potvrzení uživatelům
* '''Formát e-mailu uživatelům''' – formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu uživatelům''' – předmět (''subject'' těchto e-mailů)

E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript ''/scripts/modules/registration/registration.php''. V předvolbách (volba ''Zasílat potvrzení'') se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.

Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora ('''E-mail administrátora''') a stejné volby pro zasílání jako v předchozím případě ('''Zasílat administrátorovi''').
====Zapomenuté heslo====
Formulář '''Zapomenuté heslo''' definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky ''/scripts/modules/registration/lostpassw.php''.

[[Image:registraceapersonalizace-reference-img017.png|center]]

Ve formuláři se nastavují následující volby:

* '''Předloha žádosti o zaslání hesla''' – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
* '''Předloha potvrzovací stránky''' – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
* '''Předloha e-mailu''' – šablona pro e-mail se zapomenutým heslem
* '''Formát e-mailu''' - formát těchto e-mailů (text nebo HTML)
* '''Předmět e-mailu''' - předmět (''subject'' těchto e-mailů)

=== Nástroje ===

Podskupina '''Nástroje''' obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:

# Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři '''Údaje''' nastaví, co má být obsahem formuláře.
# Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
# Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
# Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.

K dispozici jsou následující nástroje:
* '''Registrační formulář''' – generuje HTML kód registračního formuláře dle nastavení ve formuláři '''Údaje'''.
* '''Potvrzení – stránka''' – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři '''Údaje.'''
* '''Potvrzení – e-mail''' – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v '''Údaje''' (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
* '''Přihlašovací formulář''' – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby''', tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
* '''Zapomenuté heslo''' – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři '''Předvolby'''.

Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem '''Přidat HTML fragment''' vytvořte požadovaný fragment.

[[Image:registraceapersonalizace-reference-img018.png|center]]

=== Data ===

V sekci '''Data''' nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
====Uživatelé====
Pomocí funkce '''Uživatelé''' se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.

Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz '''Vyhledat''', který zobrazuje formulář pro vyhledávání:

[[Image:registraceapersonalizace-reference-img019.png|center]]

Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".

Ve spodním formuláři lze měnit údaje uživatele.

[[Image:registraceapersonalizace-reference-img020.png|center]]

Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři '''Údaje'''. Jinak lze měnit a přidávat uživatele bez omezení.

Vedle pole ''Přezdívka'' je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.

Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.

[[Image:registraceapersonalizace-reference-img021.png|center]]

Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.

[[Image:registraceapersonalizace-reference-img022.png|center]]

====Export====
Pomocí funkce '''Export''' lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá '''Tabulka'''. Lze v ní specifikovat:

* Které sloupce vybrané SQL tabulky se exportují
* Které záznamy tabulky se exportují
* V jakém pořadí se exportují

[[Image:registraceapersonalizace-reference-img023.png|center]]

V prvé řadě se ve sloupci '''Vybrat''' pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

<div class="note">Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko '''Vše''' a tím vybrat všechny sloupce tabulky.</div>

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci '''Splňující podmínku''' vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci '''Vzhledem k '''se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor ''LIKE'' znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce '''Primárně''' a '''Sekundárně'''), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce '''Soubor''' se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

[[Image:registraceapersonalizace-reference-img024.png|center]]

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka '''Test''' lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (''wwwroot/data/katalogy/export''/).''

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

{| class="prettytable"
| rowspan="2"| DBF

| Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.

|-
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| rowspan="2"| XML

| Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
*Název kořenového elementu je stejný jako název exportované datové tabulky (tedy XREGISTR)
*Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <nowiki><row></nowiki>
*Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <nowiki><JOBTITLE></nowiki> apod., názvy nemají délkový limit jak je tomu u DBF souborů.

|-
| Výstupní kódování je vždy utf-8.

|-
| rowspan="4"|CSV

| Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.

|-
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.

|-
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.

|-
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

|}

====Statistika====
Pomocí funkce '''Statistika''' lze zobrazovat údaje o přihlašování registrovaných uživatelů.

[[Image:registraceapersonalizace-reference-img025.png|center]]

Možné volby jsou:

* '''Nejaktivnější uživatelé''' – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
* '''Sumární statistika''' – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
* '''Seznam záznamů''' – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil

== Veřejné skripty ==
=== Prezentační skripty ===

V adresáři ''/scripts/modules/registration/'' se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| registration.php
| Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku)

|-
| login.php
| Skript zobrazující formulář pro přihlášení

|-
| logout.php
| Skript pro odhlášení

|-
| lostpassw.php
| Skript pro funkci zaslání zapomenutého hesla

|-
| noaccess.php
| Skript pro zobrazení stránky odmítnutí přístupu

|-
| activation.php
| Skript pro aktivaci registrace z e-mailu

|-
| aremove.php
| Používá se pro smazání avataru uživatelem

|}

Logiku fungování registračního skriptu ''registration.php'' popisuje následující diagram.

[[Image:registraceapersonalizace-reference-img026.png|center]]

Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v ''hidden'' polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <nowiki></nowiki>) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v ''hidden'' parametru ''url'' přímo v kódu formuláře.

Přihlašovací skript ''login.php'' se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.

Podobné chování má i odhlašovací skript ''logout.php''. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v ''session'') a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.

Skript pro zasílání zapomenutého hesla ''lostpassw.php'' nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <nowiki></nowiki>. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.

Skript pro aktivaci registrace z e-mailu ''activation.php'' nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <nowiki></nowiki>.

=== Klíčová slova modulu ===

Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla)

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|-
| <nowiki></nowiki>
| Název formátu e-mailu
| Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.)

|-
| <nowiki></nowiki>
| Hodnota formátu e-mailu
| Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno

|-
| <nowiki></nowiki>
| Volba formátu ''text''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát text

|-
| <nowiki></nowiki>
| Volba formátu ''HTML''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvolen formát HTML

|-
| <nowiki></nowiki>
| Křestní jméno
|

|-
| <nowiki></nowiki>
| Příjmení
|

|-
| <nowiki></nowiki>
| Přezdívka
|

|-
| <nowiki></nowiki>
| Název firmy
|

|-
| <nowiki></nowiki>
| Pracovní pozice
|

|-
| <nowiki></nowiki>
| GSM předvolba
|

|-
| <nowiki></nowiki>
| GSM číslo
|

|-
| <nowiki></nowiki>
| Telefonní číslo
|

|-
| <nowiki></nowiki>
| Adresa
|

|-
| <nowiki></nowiki>
| Město
|

|-
| <nowiki></nowiki>
| Země
|

|-
| <nowiki></nowiki>
| PSČ
|

|-
| <nowiki></nowiki>
| Pohlaví - označení
| Vkládá interní označení pohlaví ("M" - muž, "F" - žena)

|-
| <nowiki></nowiki>
| Pohlaví - název
| Vkládá název označení pohlaví jako text

|-
| <nowiki></nowiki>
| Volba pohlaví ''muž''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''muž''

|-
| <nowiki></nowiki>
| Volba pohlaví ''žena''
| Vkládá řetězec ''checked="checked&quot''; v případě, že je zvoleno pohlaví ''žena''

|-
| <nowiki></nowiki>
| Věk
|

|-
| <nowiki></nowiki>
| Registrační kód
|

|-
| <nowiki></nowiki>
| Cesta k obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Šířka obrázku s avatarem
|

|-
| <nowiki></nowiki>
| Výška obrázku s avatarem
|

|-
| <nowiki></nowiki>
| URL pro odstranění avataru
| Má smysl jen v předloze pro změnu registrace

|}

Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (''login.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro přihlašovací stránku

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (''lostpassw.php'').

{| class="prettytable"
| colspan="3" | Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| E-mail
|

|}

Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.

Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód

<code>
<nowiki></nowiki>
</code>

Tyto konstrukce mají vždy tvar

<code>
<nowiki></nowiki>
</code>

Následující tabulka shrnuje možné podmínky a to, kde je lze použít.

{| class="prettytable"
| '''Podmínka'''
| '''Možné použití'''
| '''Možné hlášení (zobrazovaný text)'''

|-
| REGISTERED
| Registrační formulář a potvrzovací stránka
| Registrace proběhla úspěšně.

|-
| REQUIRED
| Registrační formulář a potvrzovací stránka
| Vyplňte prosím všechny povinné údaje.

|-
| DUPUSERNAME
| Registrační formulář a potvrzovací stránka
| Toto uživatelské jméno je již registrováno. Zadejte prosím jiné.

|-
| DUPNICKNAME
| Registrační formulář a potvrzovací stránka
| Tato přezdívka je již registrována. Zadejte prosím jinou.

|-
| DUPEMAIL
| Registrační formulář a potvrzovací stránka
| Tento e-mail je již registrován. Zadejte prosím jiný.

|-
| DUPREGCODE
| Registrační formulář a potvrzovací stránka
| Tento registrační kód je již použit jiným uživatelem.

|-
| NOAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel nemá avatar.

|-
| HASAVATAR
| Změna registrace, potvrzovací stránka
| Uživatel má avatar.

|-
| BADUSERNAME
| Přihlašovací formulář
| Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| BADEMAIL
| Přihlašovací formulář
| Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři.

|-
| ACTEMAIL
| Potvrzení registrace e-mailem (předloha pro e-mail)
| Vaši registraci lze aktivovat pomocí této stránky: <nowiki></nowiki>

|-
| BADCODE
| Stránka pro aktivaci registrace z e-mailu
| Chybné ID nebo registrační kód.

|-
| ACTIVATED
| Stránka pro aktivaci registrace z e-mailu
| Váš účet byl aktivován.

|-
| USERNOTFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Podle zadaného údaje nebyl žádný uživatel nelezen.

|-
| NOEMAIL
| Stránka potvrzující odeslání zapomenutého hesla
| Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu.

|-
| USERFOUND
| Stránka potvrzující odeslání zapomenutého hesla
| Heslo bylo úspěšně odesláno.

|-
| NOAUTHENT
| Stránka odmítnutí přístupu
| Autentizační plugin nevrátil uživatelské jméno uživatele

|-
| UNKNOWNUSER
| Stránka odmítnutí přístupu
| Autentizační plugin vrátil jméno uživatele, ale uživatel není v interním seznamu uživatelů a není povoleno automatické zakládání uživatelů

|-
| INACTIVE
| Stránka odmítnutí přístupu
| Uživatel je autentifikován přes externí autentifikace a je v interním seznamu uživatelů, ale není zde aktivní

|-
| REGFAILED
| Stránka odmítnutí přístupu
| V rámci externí autentifikace se spustila funkce pro automatické založení nového uživatele, ale plugin nevrátil nějaký povinný údaj dle nastavení '''Údaje'''

|}

Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci

<code>
<nowiki> ")--></nowiki>
</code>

Klíčové slovo <nowiki></nowiki> doplňuje URL začínající lomítkem (tedy ''/scripts''/…).'' Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (''http.//www.neco.cz''), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.

=== Formulářová pole a další možné parametry prezentačních skriptů ===

Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat '''username''', odpovídající klíčové slovo modulu pro uživatelské jméno je <nowiki></nowiki>, ve formuláři se pak zpravidla použije následující konstrukce:

<code>
<nowiki><input type="text" name="username" value="" maxlength="20" /></nowiki>
</code>

<div class="note">V názvech polí formulářů se '''rozlišují''' malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.</div>

Následující názvy parametrů se používají v registračních formulářích.

{| class="prettytable"
| colspan="3" | Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů)

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|-
| email
| E-mail
|

|-
| mailformat
| Hodnota formátu e-mailu
| Možné hodnoty"H" - HTML, "T" - text

|-
| firstname
| Křestní jméno
|

|-
| lastname
| Příjmení
|

|-
| nickname
| Přezdívka
|

|-
| companyname
| Název firmy
|

|-
| jobtitle
| Pracovní pozice
|

|-
| gsm_prefix
| GSM předvolba
|

|-
| gsm
| GSM číslo
|

|-
| phonenumber
| Telefonní číslo
|

|-
| address
| Adresa
|

|-
| city
| Město
|

|-
| country
| Země
|

|-
| zip
| PSČ
|

|-
| sex
| Pohlaví - označení
| Možné hodnoty "M" - muž, "F" - žena

|-
| age
| Věk
|

|-
| regcode
| Registrační kód
|

|-
| avatarfile
| Soubor s avatarem
| Používá se jako ''<nowiki><input type="file" name="avatarfile"></nowiki>''

|-
| url
| URL finální stránky
| Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka.

|}

Skript ''registration.php'' může dále z URL přijmout následující parametry

* '''action''' – uvedení parametru s hodnotou ''action=change'' znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
* '''tmplid''' – ID šablony, která se má použít místo standardně nastavené
* '''lid''', '''locale''' – jazykové parametry umožňující přepnout na jiný jazyk

Skript ''login.php'' používá formulářová pole '''username''', '''password''' a '''email''', pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď '''username''' nebo '''email''', nikoliv obě zároveň.

Skript ''lostpassw.php'' používá '''username''' nebo '''email''' podle toho, které pole je nastaveno jako unikátní identifikátor.

Skript ''activation.php'' používá z URL parametry '''id''' a '''regcode�''' pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <nowiki></nowiki>.

== Plánované úlohy ==
Součástí modulu jsou dvě úlohy pro '''Plánovač úloh'''.

'''Registrace – odstranění starých dat''' slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.

[[Image:registraceapersonalizace-reference-img027.png|center]]

V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.

<div class="note">Údaje registrovaných uživatelů se samozřejmě nikdy automaticky touto úlohou neodstraní.</div>

Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).

Úloha '''Expirace registrovaných uživatelů''' slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.

[[Image:registraceapersonalizace-reference-img028.png|center]]

Je zde možné:

# Zvolit '''Nastavit jako neaktivní''', což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
# '''Přeřadit do předvolené skupiny''' – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
# Zvolit obě výše uvedené možnosti najednou.

Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce ''offlinedata/logs/registrexpiration''/.'' Protokoly jsou ve formátu

Datum Čas ID uživatele Popis

Popis může být ''Uživatel deaktivován'' nebo Uživatel ''přeřazen do skupiny název_skupiny'' nebo obojí.

Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.

== Externí autentifikace uživatelů ==
=== Princip externí autentifikace ===
V režimu interní autentifikace umožňuje modul Registrace a personalizace autentizace uživatelů pouze přihlašovacím formulářem ''/scripts/modules/registration/login.php''. Autentizace pracuje tak, že vyplněné údaje se ověřují vůči databázové tabulce uživatelů modulu, pokud je ověření úspěšné, je uživatel přihlášen. Dále se pak typicky postupuje dle daného nasazení, tj. modulu, který přihlášení vyvolal – pokud jde např. o zprávy přístupné jen registrovaným uživatelům, uživatel je přesměrován zpět na původní URL, které volal a tam proběhne ověření přístupu přes modul Neveřejná část již se znalostí identity uživatele.

Pomocí externí autentifikace lze zpřístupnit další možnosti autentizace uživatelů, kdy ověřování identity probíhá jiným způsobem (Active Directory, LDAP) přičemž princip fungování modulu zůstává zachován. Jde tedy o následující funkce:

* Uživatel může být autentizován jinak než přes přihlašovací formulář modulu
* Nadále je vyžadován registrační záznam v tabulce uživatelů modulu
* Po úspěšné autentizace se postupuje jako ve standardním režimu, tj. uživatel je přihlášen a ostatní moduly mohou pracovat s údaji uživatele
* Volitelně je podporováno automatické zakládání registračních záznamů dle údajů načtených z externího autentizačního systému
* Je podporováno nastavení profilu uživatele přes prezentační část – přihlášený uživatel může mít přístup k formuláři pro změnu registrace, kde může pod svým účtem uložit další údaje jako adresa, telefon apod.

V režimu externí autentifikace se při přihlašování volají funkce pluginu uloženého na URL ''/scripts/modules/registration/external/_com_inc.php''. Tento plugin má zhruba následující interface:

* Funkce pro poskytování uživatelského loginu – plugin zjistí nějakou metodou uživatelské jméno nebo e-mail (podle toho, co je v modulu nastaveno jako unikátní identifikátor uživatele) a vrátí jej, pokud je prázdný, není uživatel autentizován.
* Funkce pro načtení uživatelských údajů – funkce vrací v poli uživatelské údaje používané registračním modulem (jméno, příjmení, adresa atd.).

Algoritmus přihlašování je pak následující:

# Pokud ve standardním režimu dochází k přesměrování na přihlašovací stránku, v režimu externí autentifikace se volá funkce pluginu pro zjištění loginu.
# Pokud funkce vrátí login, uživatel se považuje za autentizovaného a vyhledá se v tabulce modulu. Je-li nalezen a aktivní, načtou se jeho údaje a dále se postupuje stejně, jako kdyby prošel přes přihlašovací formulář. Je-li nalezen, ale není aktivní, je přesměrován na stránku pro odmítnutí přístupu.
# Pokud funkce nevrátí login, uživatel není autentizován a je přesměrován na stránku pro odmítnutí přístupu.
# Pokud je vrácen login, ale uživatel není v tabulce uživatelů nalezen, jsou dvě možnosti. Buď je povoleno automatické zakládání nových uživatelů. V tom případě se zavolá funkce pluginu pro získání údajů o uživateli a vytváří se nový záznam v tabulce uživatelů modulu. Po vytvoření tohoto záznamu je uživatel přihlášen. Nebo není povoleno automatické zakládání uživatelů, v tom případě je uživatel opět přesměrován na stránku pro odmítnutí přístupu.

=== Plugin pro http autentifikaci ===
Standardně je k modulu dodáván plugin pro http autentifikaci, který umožňuje např. autentifikaci vůči Active Directory. Plugin ve funkci pro poskytování loginu čte z http hlavičky jméno uživatele, odstraní z něj případný název domény apod. a vrací toto jméno modulu. Plugin nemá funkci pro navrácení uživatelských údajů, resp. vrací prázdné údaje. Tento plugin je na adrese ''/scripts/modules/registration/external/_com_inc.php''.

To aby v http hlavičce bylo jméno přihlášeného uživatele je třeba zajistit na systémové úrovni.

=== Nastavení externí autentifikace ===
V [[#Předvolby|předvolbách]] modulu je třeba zvolit '''Autentifikace : externí'''. Dále dle potřeb zvolit požadované chování ohledně automatického zakládání nových uživatelů pomocí přepínače '''Automatické zakládání uživatelů'''.

Dále je třeba ve formuláři [[#Stránky|'''Nastavení''' - '''Globální''' - '''Stránky''']] definovat předlohu pro odmítnutí přístupu, která se použije v případě, že uživatel není pluginem autentifikován.

=== Chování vybraných funkcí v režimu externí autentifikace ===
Pokud je modul v režimu externí autentifikace, mají pro tyto funkce vybraná nastavení předvoleb následující význam:

* '''Výchozí stav registrace''' – je-li nastaveno na neaktivní a přitom je vyvolán proces založení nového záznamu uživatele, vytvořený záznam je neaktivní a uživatel je přesměrován na odmítnutí přístupu.
* '''Zasílat administrátorovi''' – je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, odesílá se e-mail administrátorovi stejně jako ve standardním režimu autentifikace při nové registraci.
* '''Zasílat potvrzení''' - je-li zvoleno ''Nové registrace'' nebo ''Nové i změněné'' a je vyvolán proces automatického založení nového uživatele, je odesílán e-mail uživateli, ale pouze v případě, že uživatelův e-mail je autentizačním pluginem vrácen.

Proces automatického zakládání uživatelů pracuje s údaji (položka '''Administrace''' - '''Údaje''' nabídky). To znamená, že:

* V databázi registrovaných vyplní jen ty údaje, u kterých je zvoleno '''Použít'''
* Pokud autentizační plugin nevrátí některou z položek, u kterých je zvoleno '''Vyžadovat''', registrační záznam se nezakládá a uživatel je přesměrován na odmítnutí přístupu.

== Rozhraní pro napojení jiných aplikací ==
=== Úvod ===

API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.

API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře ''gate'', který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.

Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):

* '''Akce''' - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
* '''Uživatelské jméno''' - uživatelské jméno zadané uživatelem
* '''Heslo''' - heslo zadané uživatelem
* '''Detailní výpis''' - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli

Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.

Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.

=== Vlastní API ===

V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr ''un'' (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.

Komunikační skript je na adrese ''/gate/registration/userget.php'', získávat data z něj lze pomocí http GET.

Jeho parametry uváděné za otazníkem jsou v následující tabulce.

{| class="prettytable"
| '''Parametr'''
| '''Povinný'''
| '''Popis'''

|-
| a
| ano
| Akce, jediná v současnosti podporovaná hodnota je ''verify''.

|-
| un
| ano
| Uživatelské jméno

|-
| pw
| ano
| Heslo uživatele

|-
| det
| ne
| Žádost o detailní výpis; pokud má hodnotu ''yes'', vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení.

|}

Parametry ''un'' a ''pw'' musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:

<code>
<nowiki>http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345</nowiki>
</code>

Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:

* Číslo 0 v případě, že není požadován detailní výpis
* XML výpis registrace v případě, že je požadován detailní výpis.

Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je ''kód chyby - hláška'', mohou nastat následující možnosti:

* ''E1 - Uživatel nenalezen'' - v databázi neexistuje uživatel s daným jménem
* ''E2 - Špatné heslo'' - uživatel s daným jménem nalezen, ale heslo nesouhlasí
* ''E3 - Registrace není aktivní'' - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
* ''E9 - Nastala chyba při ověřování uživatele'' - nastala jakákoli jiná chyba při ověřování

=== XML formát ===

Pokud je v žádosti o ověření uveden v URL parametr ''det=yes'' a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.

<code>
<nowiki><?xml version="1.0" encoding="UTF-8"?></nowiki>
<nowiki><user></nowiki>
<nowiki> <id>123</id></nowiki>
<nowiki> <username>jarda</username></nowiki>
<nowiki> <password>heslo</password></nowiki>
<nowiki> <email>jardac@macron.cz</email></nowiki>
<nowiki> <regcode>46339806</regcode></nowiki>
<nowiki> <firstname>Jaroslav</firstname></nowiki>
<nowiki> <lastname>Procházka</lastname></nowiki>
<nowiki> <nickname>jarda</nickname></nowiki>
<nowiki> <companyname>Macron</companyname></nowiki>
<nowiki> <gsm_prefix>602</gsm_prefix></nowiki>
<nowiki> <gsm>123456</gsm></nowiki>
<nowiki> <address>Dlouhá 11</address></nowiki>
<nowiki> <city>Praha 1</city></nowiki>
<nowiki> <country>ČR</country></nowiki>
<nowiki> <zip>11000</zip></nowiki>
<nowiki> <jobtitle>Programátor</jobtitle></nowiki>
<nowiki> <phonenumber>234877444</phonenumber></nowiki>
<nowiki> <sex>male</sex></nowiki>
<nowiki> <age>35</age></nowiki>
<nowiki> <avatarfile>754034578222019854.jpg</avatarfile></nowiki>
<nowiki> <avatarwidth>60</avatarwidth></nowiki>
<nowiki> <avatarheight>60</avatarheight></nowiki>
<nowiki> <groups></nowiki>
<nowiki> <group id="1">Registrovaní uživatelé</group></nowiki>
<nowiki> </groups></nowiki>
<nowiki></user></nowiki>
</code>

XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.

Pro element ''sex'' jsou možné hodnoty ''male / female''. V elementu ''groups'' se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.

WebToDate/Utility/Vytvoření výchozí stránky kategorie podle jiné stránky

2016-11-12T10:49:24Z

Jardac: /* Zavedení parametru default */

[[Category:WebToDate Utility]]
[[Category:Utility]]
== Funkcionalita ==
Pomocí této utility lze ve zvolené kategorii rychle založit výchozí stránku podle vzoru - jiné existující zvolené stránky. Ve volání utility se zadávají parametry:

* ID kategorie, ve které chceme založit novou výchozí stránku
* ID stránky, která bude sloužit jako vzor
* Zda se zakládá výchozí stránka kategorie nebo další stránka v kategorii

Utilita pak založí výchozí stránku pro jazykovou mutaci stejnou, v jakém jazyce je vzorová stránka, název stránky a její titulek je totožný s příslušným lokalizovaným názvem kategorie, URL stránky se vytvoří dle nastavení v konfiguračním souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'', šablona stránky je stejná jako u vzorové stránky, stejně jako další vlastnosti stránky a oblasti stránky jsou naplněny stejnými elementy, jako u vzoru (navigace, fragmenty, seznamy, zprávy). U oblastí se přebírají práva dle nastavení jako u vzorové stránky.

== Spuštění utility ==
Funkce se spouští na adrese ''adresa_serveru/adresář_s_redakčním_rozhraním/default_page.php?id=id_kategorie&pgid=id_stranky'', tedy např. na adrese <nowiki>http://www.mujserver.cz/admin/default_page.php?id=127&pgid=275</nowiki>.

Parametrem ''default=no'' lze navíc vyznačit že nově zakládaná stránka nemá být označena jako výchozí. V takovém případě se ze vzorové stránky přebere i název souboru s HTML kódem stránky, který se vytvoří.

== Obsluha funkce ==
Po zadání URL skriptu do prohlížeče se funkce založení nové výchozí stránky kategorie okamžitě spustí, není vyžadováno žádné potvrzení.

WebToDate/Utility/Vytvoření výchozí stránky kategorie podle jiné stránky

2016-11-11T15:51:55Z

Jardac: /* Zavedení parametru default */

[[Category:WebToDate Utility]]
[[Category:Utility]]
== Funkcionalita ==
Pomocí této utility lze ve zvolené kategorii rychle založit výchozí stránku podle vzoru - jiné existující zvolené stránky. Ve volání utility se zadávají parametry:

* ID kategorie, ve které chceme založit novou výchozí stránku
* ID stránky, která bude sloužit jako vzor
* Zda se zakládá výchozí stránka kategorie nebo další stránka v kategorii

Utilita pak založí výchozí stránku pro jazykovou mutaci stejnou, v jakém jazyce je vzorová stránka, název stránky a její titulek je totožný s příslušným lokalizovaným názvem kategorie, URL stránky se vytvoří dle nastavení v konfiguračním souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'', šablona stránky je stejná jako u vzorové stránky, stejně jako další vlastnosti stránky a oblasti stránky jsou naplněny stejnými elementy, jako u vzoru (navigace, fragmenty, seznamy, zprávy). U oblastí se přebírají práva dle nastavení jako u vzorové stránky.

== Spuštění utility ==
Funkce se spouští na adrese ''adresa_serveru/adresář_s_redakčním_rozhraním/default_page.php?id=id_kategorie&pgid=id_stranky'', tedy např. na adrese <nowiki>http://www.mujserver.cz/admin/default_page.php?id=127&pgid=275</nowiki>.

== Obsluha funkce ==
Po zadání URL skriptu do prohlížeče se funkce založení nové výchozí stránky kategorie okamžitě spustí, není vyžadováno žádné potvrzení.

WebToDate

2014-09-12T07:48:11Z

Jardac: /* Příručky systému WebToDate - odstranění instalačních manuálů */

[[Category:Uživatelská dokumentace WebToDate]]
=== Příručky systému WebToDate ===
:[[/Redaktorská|Příručka redaktora]]
:[[/Referenční|Referenční příručka]]
:[[/WYSIWYG editor|WYSIWYG editor]]
:[[/Utility|Příručka WebToDate utility]]

===Příručky modulů, extenzí a rozšíření WebToDate===
:[[/Ankety|Příručka modulu Ankety]]
:[[/Cachování|Příručka extenze pro cachování zpráv]]
:[[/Diskuze|Příručka modulu Diskuze]]
:[[/Formuláře a katalogy|Příručka modulu Formuláře a katalogy]]
:[[/Fulltext|Příručka modulu Fulltext]]
:[[/Fulltext Google|Příručka modulu Fulltext Google]]
:[[/Import Newton|Příručka modulu Import Newton]]
:[[/Kalendář akcí|Příručka modulu Kalendář akcí]]
:[[/Neveřejná část|Příručka modulu Neveřejná část]]
:[[/Offline generátor|Příručka modulu Offline generátor]]
:[[/Poradny a rozhovory|Příručka modulu Poradny a rozhovory]]
:[[/Publikace a vydání|Příručka modulu Publikace a vydání]]
:[[/Registrace a personalizace|Příručka modulu Registrace a personalizace]]
:[[/Rozesílání e-mailem|Příručka modulu Rozesílání e-mailem]]
:[[/Soutěže|Příručka modulu Soutěže]]
:[[/Stránkování zpráv|Příručka modulu Stránkování zpráv]]
:[[/Tvůrci obsahu|Příručka modulu Tvůrci obsahu]]
:[[/Verifikace|Příručka modulu Verifikace]]
:[[/Veřejné zakázky|Příručka modulu Veřejné zakázky]]
:[[/Výpisy zpráv|Příručka modulu Výpisy zpráv]]
:[[/XML export - import|Příručka modulu XML Export - import]]
:[[/Generování sitemap.xml|Úlohy pro generování sitemap.xml]]

:[[/Extenze|Standardně dodávané extenze WebToDate]]

:[[/Přehled plánovaných úloh|Přehled plánovaných úloh]]

=== Dokumentace pro vývojáře ===
:[[/Příručka vývojáře|Příručka vývojáře]]
:[[/Struktura databáze|Popis struktury databáze]]

WebToDate/Neveřejná část

2014-06-03T12:41:28Z

Jardac: /* Implementace řízení přístupu k jednotlivým zprávám */

[[Category:WebToDate Neveřejná část]]
[[Category:Neveřejná část]]
'''Manuál modulu Neveřejná část'''
#[[/O modulu|O modulu]]
#:[[/O modulu#Základní vlastnosti modulu|Základní vlastnosti modulu]]
#:[[/O modulu#Co modul umožňuje|Co modul umožňuje]]
#:[[/O modulu#Co modul neumožňuje|Co modul neumožňuje]]
#[[/Instalace|Instalace]]
#:[[/Instalace#Manuální instalace|Manuální instalace]]
#::[[/Instalace#Návaznost na modul Registrace a personalizace|Návaznost na modul Registrace a

personalizace]]
#::[[/Instalace#Soubory|Soubory]]
#::[[/Instalace#Umístění extenzí|Umístění extenzí]]
#[[/Začínáme|Začínáme]]
#:[[/Začínáme#Základní principy|Základní principy]]
#:[[/Začínáme#První kroky|První kroky]]
#[[/Reference|Reference]]
#:[[/Reference#Veřejné skripty|Veřejné skripty]]
#::[[/Reference#Prezentační skripty|Prezentační skripty]]
#::[[/Reference#Klíčová slova modulu|Klíčová slova modulu]]
#::[[/Reference#Formulářová pole a další možné parametry|Formulářová pole a další možné parametry]]
#:[[/Reference#Administrační rozhraní|Administrační rozhraní]]
#::[[/Reference#Nabídka modulu|Nabídka modulu]]
#::[[/Reference#Nastavení|Nastavení]]
#::[[/Reference#Administrace|Administrace]]
#:[[/Reference#Kontrola dat|Kontrola dat]]
#:[[/Reference#Externí autentifikace|Externí autentifikace]]
#::[[/Reference#Úvod|Úvod]]
#::[[/Reference#Postup konfigurace|Postup konfigurace]]
#::[[/Reference#Plugin pro bránu POSTABO|Plugin pro bránu POSTABO]]
#[[/Tipy a návody|Tipy a návody]]
#:[[/Tipy a návody#Vytváření pravidel modulu|Vytváření pravidel modulu]]
#:[[/Tipy a návody#Zabezpečení přístupu ke stránkám a souborům z databáze zdrojů|Zabezpečení přístupu

ke stránkám a souborům z databáze zdrojů]]
#:[[/Tipy a návody#Optimální nasazení z hlediska zátěže|Optimální nasazení z hlediska zátěže]]
#:[[/Tipy a návody#Zprávy a zdroje ve více kategoriích|Zprávy a zdroje ve více kategoriích]]
#:[[/Tipy a návody#Implementace řízení přístupu k jednotlivým zprávám|Implementace řízení přístupu k jednotlivým zprávám]]
#[[/Dodatky|Dodatky]]
#:[[/Dodatky#Databázové struktury|Databázové struktury]]

WebToDate/Neveřejná část/Tipy a návody

2014-06-03T12:40:22Z

Jardac: /* Implementace řízení přístupu k jednotlivým zprávám */

[[Category:WebToDate Neveřejná část]]
[[Category:Neveřejná část]]
== Vytváření pravidel modulu ==
Při vytváření pravidel modulu je vhodné si uvědomit, že modul sám o sobě nezajišťuje přímou závislost mezi pravidly určujícími, které položky nejsou veřejně přístupné a pravidly určujícími, která skupina uživatelů má přístup ke kterým zprávám. Při nevhodné definici těchto pravidel lze tak např. vytvořit stav, kdy existují zprávy, ke kterým nemá přístup nikdo. Jednoduchý příklad vedoucí k tomuto nežádoucímu jevu je následující:

Ve stromu kategorií WebToDate máme kategorii K0, která má přímo podřízené kategorie K1 a K2. Pravidlo pro veřejně nepřístupné zprávy nadefinujeme tak, že se jedná o položky z kategorie K0 včetně všech podkategorií. V modulu '''Registrace a personalizace''' máme dvě skupiny uživatelů A a B. Pro každou skupinu nadefinujeme jedno pravidlo – pro skupinu A přístup do kategorie K1 a pro skupinu B přístup do kategorie K2. V takovém případě jsou pravidla korektně nadefinovaná, jednoduše se rozliší neveřejné zprávy od veřejných apod., ale zprávy vložené přímo do kategorie K0 nejsou přístupné nikomu – jsou označeny jako neveřejné, ale pro žádnou skupinu uživatelů k nim není zřízen přístup.

V tomto příkladu patrně budeme chtít, aby zprávy přímo vložené do kategorie K0 byly přístupné oběma skupinám uživatelů A i B. Pro tyto účely musíme v modulu definovat ještě jedno pravidlo, která vybírá zprávy z kategorie K0 (pouze z této kategorie, bez podkategorií). Toto pravidlo pak přiřadíme jak skupině A tak skupině B, čímž dosáhneme požadovaného efektu – obsah celé kategorie K0 a všech jejích podkategorií není veřejně přístupný, zprávy přímo v kategorii K0 zobrazí skupina A i B, zprávy z kategorie K1 pouze skupina A a zprávy z kategorie K2 pouze skupina B.

== Zabezpečení přístupu ke stránkám a souborům z databáze zdrojů ==
Od verze WebToDate 4.0 je zaveden strom kategorií, který umožňuje opatřit vhodnými metadaty nejen zprávy, ale i stránky a soubory (v databázi zdrojů). Zatímco dřívější verze tohoto modulu umožňovaly řídit přístup pouze k samotným zprávám, od verze WebToDate 4.0 je toto možné díky stromu kategorií i pro stránky a soubory. Je tudíž možné vytvářet kompletní neveřejné zóny, kde se kontroluje přístup ke všem zmíněným typům objektů.

Pro jiné typy objektů než zprávy v prvé řadě platí, že přístupová práva může modul kontrolovat jen v případě, že objekt se zobrazuje dynamicky. Ani tato podmínka ale nestačí – ve WebToDate lze volit, zda se objekty tohoto typu uloží do veřejné nebo privátní zóny. Pokud je třeba zajistit přístup pouze vybrané skupině registrovaných uživatelů, musí být chráněné objekty uloženy v privátní zóně. V opačném případě jsou tyto objekty uloženy v adresáři přímo přístupném přes www server (''wwwroot'') a pokud kdokoliv zjistí URL objektu, může jej v takovém případě bez omezení zobrazit či stáhnout, i kdyby podléhal pravidlům modulu.

Funkce '''Kontrola dat''' vyhledává stránky a soubory, které podle pravidel modulu patří do neveřejné části, ale jsou volně vystaveny v tomto veřejně přístupném adresáři.

<div class="note">Dále je třeba si uvědomit, že při přístupu na stránky je jediným smysluplným kritériem v pravidlech modulu ''kategorie'', ostatní vlastnosti jako publikace či téma stránky nemají a tudíž jsou při vyhodnocování pravidel v rámci zobrazení stránky ignorovány. Pro zprávy a zdroje jsou platná všechna kritéria, která lze v pravidlech nastavit.</div>

== Optimální nasazení z hlediska zátěže ==
Při vyhodnocování pravidel modul postupuje následovně:

# při vyhodnocování toho, zda je zpráva veřejná nebo neveřejná se vyhodnocují postupně zadaná pravidla tak dlouho, dokud se nezjistí, že zpráva není veřejně přístupná nebo jsou vyhodnocena všechna pravidla. Toto vyhodnocování se spouští při zobrazení každé zprávy.
# při vyhodnocování toho, zda je zpráva přístupná danému uživateli se vyhodnocují postupně pravidla pro skupinu ve které se uživatel nachází tak dlouho, dokud se nezjistí, že zprávu lze uživateli zobrazit nebo jsou vyhodnocena všechna pravidla. Toto vyhodnocování se spouští pouze pokud je v předchozím kroku zjištěno, že zpráva není veřejně přístupná.

Z výše uvedených skutečností vyplývá, že počet pravidel je vhodné udržet co nejmenší, přičemž daleko důležitější to je pro pravidla zařazená jako pravidla pro ''Neveřejné zprávy''. Tato pravidla se spouštějí při každém zobrazení zprávy, a tudíž v celkovém objemu více zatěžují server. Doporučení je tedy následující:

* Pro výkon serveru je nejlepší, když je pravidlo určující, jak se pozná veřejná zpráva od neveřejné, jen jedno.
* Pravidel pro skupiny uživatelů může být i více, ale počet těchto pravidel (nastavených pro jednu konkrétní skupinu uživatelů) je vždy vhodné udržovat co nejmenší.

== Zprávy a zdroje ve více kategoriích ==
Zprávy i zdroje lze ve WebToDate zařadit do více než jedné kategorie, přičemž právě jedna kategorie je označena jako výchozí.

Pro tento modul je zařazení do výchozí kategorie irelevantní, zpráva se považuje za neveřejnou v případě, že alespoň jedna kategorie, do které je zařazena, je označena v pravidlech modulu jako neveřejná, lhostejno, zda se jedná o výchozí nebo další kategorii.

Pro stránky platí, že se vždy nacházejí v právě jednom uzlu stromu kategorií, takže zde je situace jasná a vyhodnocuje se na základě právě této jedné kategorie.

== Implementace řízení přístupu k jednotlivým zprávám ==
Standardně se modul Neveřejná část používá na znepřístupnění části webové prezentace anonymním uživatelům pravidly, která definují hromadný výběr neveřejného obsahu - např. zprávy a stránky z dané kategorie apod. V případě, že nelze nějakým hromadným způsobem stanovit, který obsah je neveřejný, lze možnost volit co je a co není veřejné delegovat na uživatele spravující obsah, a to pomocí práce s hodnotami nějakého vstupního pole.

V tomto případě postupujte následovně:

* V [[../../Referenční/Struktura_obsahu|přizpůsobitelné struktuře databáze zpráv]] definujte nějaké pole, které bude vyznačovat, zda je zpráva veřejná nebo neveřejná.
* Zvažte možné hodnoty pro toto pole a volitelně pro něj nadefinujte [[../../Referenční/Struktura_obsahu#Číselníky|číselník]]. Pokud existuje jen jedna skupina uživatelů, kteří mohou daný neveřejný obsah zobrazovat, postačí vkládat např. hodnotu 1 u zpráv, které jsou neveřejné, a nevyplňovat (nebo hodnotu 0) u veřejně přístupných zpráv. Pokud existuje např. více skupin a u zpráv je zároveň vhodné definovat, pro kterou skupinu je zpráva určena, může číselník nabývat např. hodnot 1,2,3 (tři skupiny uživatelů). Pokud používáte číselník, mějte na paměti, že do databáze se ukládají (a tím pádem zde porovnávají) [[../../Referenční/Struktura_obsahu#Číselníky|hodnoty číselníku]], nikoli systémové nebo lokalizované názvy položek číselníku.
* Založte nové [[../Reference#Pravidla|pravidlo modulu]] podle následujícího otisku obrazovky. Vzhledem k tomu, že více kritérií v pravidle se spojuje logickou spojkou "a zároveň", typicky půjde o samostatné pravidlo, které využívá jen možnost '''Vstupní pole obsahuje hodnotu'''.

[[Image:neverejnacast-pravidla-pole-hodnota.png|center]]

* Pomocí nastavení [[../Reference#Neveřejné zprávy|'''Administrace''' - '''Neveřejné zprávy''']] zahrňte toto pravidlo do použitých pravidel. V tu chvíli jsou zprávy vyhovující tomuto kritériu neveřejné.
* Pomocí nastavení [[../Reference#Uživatelé|'''Administrace''' - '''Uživatelé''']] přiřaďte toto pravidlo skupině nebo skupinám uživatelů, kteří k těmto zprávám mají mít přístup.

Poslední krok platí pro případ, kdy se nerozlišují okruhy zpráv pomocí hodnoty daného pole. Pokud různé hodnoty mají vyznačovat, že různé skupiny uživatelů mají k různým zprávám přístup, je třeba definovat další pravidla. Tedy v [[../Reference#Neveřejné zprávy|'''Administrace''' - '''Neveřejné zprávy''']] se použije jen jedno pravidlo definující, že pokud dané pole obsahuje hodnotu ''NOTNULL'' (jakoukoli neprázdnou), je zpráva neveřejná, ale v [[../Reference#Uživatelé|'''Administrace''' - '''Uživatelé''']] se nastaví pro každou skupinu jiné pravidlo, tj. např. pokud má zpráva v daném poli hodnotu 1, je přístupná skupině A, pokud hodnotu 2, je přístupná skupině B apod.

Soubor:Neverejnacast-pravidla-pole-hodnota.png

2014-06-03T11:10:45Z

Jardac: Definice pravidla modulu neveřejná část - vstupní pole obsahuje hodnotu

Definice pravidla modulu neveřejná část - vstupní pole obsahuje hodnotu

WebToDate/Neveřejná část/Tipy a návody

2014-06-03T11:08:13Z

Jardac: /* Implementace řízení přístupu k jednotlivým zprávám */

WebToDate/Neveřejná část/Reference

2014-06-03T11:02:59Z

Jardac: /* Pravidla */

[[Category:WebToDate Neveřejná část]]
[[Category:Neveřejná část]]
== Veřejné skripty ==
=== Prezentační skripty ===

Využití skriptů veřejné části se liší podle toho, zda modul pracuje v režimu interní nebo externí autentifikace. Pokud se jedná o interní autentifikaci, všechno se odehrává v rámci přihlašovacího skriptu modulu '''Registrace a personalizace''' a ve skriptech WebToDate pro dynamické zobrazování obsahu (zpráv, stránek a souborů). Pokud se jedná o externí autentifikaci, využívají se následující skripty v adresáři ''/scripts/modules/access''/.''

{| class="prettytable"
| '''Skript'''
| '''Funkce'''

|-
| login.php
| Přihlašovací stránka, na které je umístěn přihlašovací formulář

|-
| logout.php
| Odhlašovací skript

|}

Přihlašovací skript ve skutečnosti v tomto případě žádné přihlášení neprovádí, pouze se naplní údaje v uživatelské ''session''. To znamená, že se ve chvíli odeslání přihlašovacího formuláře nekomunikuje s externím autentifikačním serverem, to se děje až při prvním pokusu o zobrazení stránky, která není veřejně přístupná. Vyplývá z toho mimo jiné to, že uživatel zde může zadat i špatné nevalidní údaje, v tomto kroku se tato skutečnost nezjistí.

Odhlašovací skript pak vymaže v ''session'' všechny relevantní údaje týkající se přístupů uživatele a přesměruje na stránku, ze které byl volán, pokud není schopen tuto stránku identifikovat tak přesměruje na úvodní stránku. Skript je určen k tomu, aby uživatel mohl následně znovu zadat jiné přihlašovací údaje.

Více viz kapitola [[../Reference#Externí autentifikace|Externí autentifikace]].

=== Klíčová slova modulu ===

V předloze pro přihlašovací stránku login.php lze použít následující klíčová slova.

{| class="prettytable"
| colspan="3" | '''Klíčová slova použitelná v předloze pro přihlašovací stránku'''

|-
| '''Klíčové slovo'''
| '''Význam'''
| '''Poznámka'''

|-
| <nowiki></nowiki>
| Uživatelské jméno
|

|-
| <nowiki></nowiki>
| Heslo
|

|-
| <nowiki></nowiki>
| Nejsou vyplněny oba povinné údaje
|

|}

=== Formulářová pole a další možné parametry ===

Přihlašovací skript používá následující parametry

{| class="prettytable"
| colspan="3" | '''Parametry skriptu login.php pro přihlášení'''

|-
| '''Název pole nebo parametru'''
| '''Význam'''
| '''Poznámka'''

|-
| username
| Uživatelské jméno
|

|-
| password
| Heslo
|

|}

Příklad přihlašovacího formuláře uvádí následující kód.

<code>
<nowiki><form action="/scripts/modules/access/login.php" method="post"></nowiki>
<nowiki><table></nowiki>
<nowiki><tr></nowiki>
<nowiki> <td align="right"></nowiki>
<nowiki> <label for="username">Uživatelské jméno</label></nowiki>
<nowiki> </td></nowiki>
<nowiki> <td></nowiki>
<nowiki> <input type="text" name="username" id="username" value="" maxlength="20" /></nowiki>
<nowiki> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr></nowiki>
<nowiki> <td align="right"></nowiki>
<nowiki> <label for="password">Heslo</label></nowiki>
<nowiki> </td></nowiki>
<nowiki> <td></nowiki>
<nowiki> <input type="password" name="password" id="password" value="" maxlength="20" /></nowiki>
<nowiki> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki><tr></nowiki>
<nowiki> <td align="right" colspan="2"></nowiki>
<nowiki> <input type="submit" name="send" id="send" value="Odeslat" /></nowiki>
<nowiki> </td></nowiki>
<nowiki></tr></nowiki>
<nowiki></table></nowiki>
<nowiki></form></nowiki>
</code>

== Administrační rozhraní ==
=== Nabídka modulu ===

Nabídka modulu vypadá následovně:

'''Nastavení'''

:Globální

:Stránky

'''Administrace'''

:Předvolby

:Přístupové kódy

:Pravidla

:Neveřejné zprávy

:Uživatelé

:Kontrola dat

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

=== Nastavení ===

==== Stránky ====

Zde se nastavuje zejména stránka, která se má zobrazit, pokud je uživatel přihlášen, ale k dané zprávě nemá přístup ('''Stránka pro odmítnutí přístupu'''). Nastavit lze tuto stránku pro každý jazyk, přesměrování na příslušnou stránku se pak řídí jazykem zprávy, která se má zobrazit.
<div class="note">Poznámka: Nic ovšem nebrání administrátorovi nastavit tu samou stránku pro všechny jazyky a tuto stránku opatřit příslušným hlášením ve všech jazycích.</div>

Pokud je v předvolbách nastavena externí autentifikace, zobrazuje se v tomto formuláři ještě volba druhé stránky – '''Předloha přihlašovací stránky'''. Jedná se o předlohu pro skript ''/scripts/modules/access/login.php'', který se používá pro přihlášení v případě externí autentifikace.

[[Image:neverejna_cast03-nastaveni-stranky-odmitnuti-pristupu.jpg|center]]

=== Administrace ===

==== Předvolby ====

Ve formuláři '''Předvolby''' se nastavuje pouze způsob autentifikace, ve většině případů se volí ''interní''.

[[Image:neverejna_cast04-autentifikace.jpg|center]]

Volbu nastavte hned na začátku konfigurace modulu, volbu lze změnit i dodatečně. Volba má vliv na chování administrační části, např. na seznam stránek, které se nastavují v nabídce '''Nastavení''' – '''Globální''' – '''Stránky'''.

==== Přístupové kódy ====

Pomocí této funkce se zadávají přístupové kódy odpovídající definovaným pravidlům modulu. Funkci má smysl používat pouze v případě, že je autentifikace nastavena na ''externí''.

V pravé horní části se objevuje seznam položek obsahující název pravidla a přístupový kód. Klepnutím na název pravidla se ve spodní části zobrazuje formulář pro editaci této položky.

[[Image:neverejna_cast05-uprava-pristupovych-kodu.jpg|center]]

Ve formuláři musí být povinně vyplněna obě pole. Stejný přístupový kód lze zadat i pro více pravidel, naopak jednomu pravidlu je možné přiřadit pouze jeden přístupový kód. Do pole ''Kód'' lze zadat jakýkoliv textový řetězec, nabídka ''Pravidla'' obsahuje seznam pravidel definovaných pomocí funkce '''Administrace''' – '''Pravidla'''.

Význam zde nastavovaných položek je takový, že pokud zobrazovaná stránka (zpráva, stránka, zdroj) vyhovuje zvolenému pravidlu, je použit zadaný kód pro vyhodnocení přístup. Externímu autentifikačnímu serveru se zasílá trojice uživatelské jméno – heslo – kód, externí server vrátí zpět informaci o tom, zda uživatel má či nemá přístup. Tato funkce je podrobně popsána v kapitole [[../Reference#Externí autentifikace|Externí autentifikace]].

==== Pravidla ====

Hlavním objektem, se kterým pracuje administrátor tohoto modulu jsou tzv. '''Pravidla'''. Pravidlem se rozumí skupina kritérií, u kterých lze jednoznačně říci, zda daná položka těmto kritériím vyhovuje. Součástí těchto kritérií může být:

* Stav - je možné vztáhnout pravidlo pouze na stav ''Archivováno'', na stav ''Publikováno'' či na oba tyto stavy
* Publikace
* Téma
* Kategorie s možností "Včetně podkategorií"
* Jazyk
* Datum starší než (resp. počet dní, po kterém je zpráva považována za neveřejnou)
* Datum mladší než (resp. počet dní, před kterým je zpráva považována za neveřejnou)
* Vstupní pole obsahuje hodnotu (pole [[../../Referenční/Struktura_obsahu|přizpůsobitelné struktury databáze zpráv]] má nějakou zadanou hodnotu)

Poslední uvedená možnost umožňuje řídit přístup k zprávám individuálně. Ve WebToDate se nadefinuje nějaké pole přizpůsobitelné struktury zpráv, do kterého uživatelé spravující obsah zapisují nějaké hodnoty ručně neboje volí pomocí [[../../Referenční/Struktura_obsahu#Číselníky|číselníku]]. Pravidlo pak testuje na zadanou hodnotu, připadně lze jako hodnotu v pravidle použít výraz ''NOTNULL'', který znamená, že pravidlo platí pokud pole obsahuje jakoukoli neprázdnou hodnotu.

Administrátor pak definuje jedno pravidla určující, zda daná zpráva patří do neveřejné části (toto pravidlo určuje, které zprávy jsou neveřejné, ostatní, které tomuto pravidlu nevyhovují, jsou veřejné).

[[Image:neverejna_cast06-nastaveni-pravidel.png|center]]

Dále může administrátor definovat libovolné množství pravidel, která mohou jemněji dělit množinu neveřejných zpráv a tato pravidla přiřadit různým skupinám uživatelů (skupiny uživatelů jsou definovány v modulu '''Registrace a Personalizace''').

<div class="note">V definici pravidel se nastavená kritéria v jednom pravidle spojují logickou spojkou "a zároveň". Např. na předchozím otisku obrazovky se tudíž jedná o výběr položek, které patří do kategorie "Dokumenty" a zároveň jsou starší než 30 dní.</div>

Při vyvolání skriptu pro zobrazení položky se postupuje takto:

# Zjistí se, zda daná položka vyhovuje alespoň jednomu pravidlu pro neveřejné zprávy, pokud ano, uživatel je přesměrován na přihlašovací skript (pokud se ještě nepřihlásil)
# Jakmile se uživatel přihlásil, je vrácen zpět na stránku pro zobrazení vybrané položky, přičemž díky přihlášení je známo, v jaké je skupině.
# Spustí se algoritmus pro testování pravidel přiřazených dané skupině uživatelů. Jakmile nějaké pravidlo vrátí, že daná zpráva tomuto pravidlu vyhovuje, dál se již netestuje a zpráva se zobrazí. Pokud se zjistí, že daná zpráva nevyhovuje žádnému pravidlu pro danou skupinu uživatelů, je uživatel přesměrován na příslušnou stránku, která říká, že k dané zprávě nemá přístup. V tomto případě pravidlo určuje, zda daná skupina uživatelů má k dané zprávě přístup.

U každé položky je volba '''všechny''', což znamená, že daná položka není do pravidla zahrnuta. Stejně jako seznamy obsahuje formulář pro pravidla tlačítko '''Test''', které zobrazí prvních 10 zpráv vyhovujících danému pravidlu.

Pravidla se aplikují při zobrazování zpráv, stránek a souborů z databáze zdrojů. Co se týká stránek WebToDate, mohou vyvstat dva různé požadavky na přístup k nim. Chceme např. omezit přístup k obsahu určité kategorie ve stromu kategorií WebToDate. To v praxi může znamenat, že buď požadujeme přihlášení pro kompletní obsah, tj. zprávy, soubory i stránky, které prezentují seznamy položek v této kategorii apod., nebo chceme zamezit přístupu anonymních uživatelů ke zprávám a souborům, ale naopak chceme, aby uživatelé měli možnost zobrazit výpis obsahu dané kategorie, tj. zobrazit běžné stránky WebToDate v této kategorii a teprve po klepnutí na odkaz na konkrétní zprávu vyžadovat přihlášení. Pro tyto účely je v definici pravidla zaškrtávací okénko '''Aplikovat i na stránky'''. Pokud není zaškrtnuto, při zobrazení stránky WebToDate (což odpovídá URL ''/scripts/detail.php?pgid=xxx'') je dané pravidlo ignorováno.

==== Neveřejné zprávy ====

V sekci '''Neveřejné zprávy''' se vybírají pravidla pro stanovení, zda zpráva je neveřejná. Formulář obsahuje pouze dvě pole, na jedné straně seznam použitých pravidel a na druhé seznam ostatních pravidel (obdobný interface jako pro nastavení přístupových práv pro moduly).

[[Image:neverejna_cast07-pravidla-pro-neverejne-zpravy.jpg|center]]

==== Uživatelé ====

V sekci '''Uživatelé''' se nastavuje, která pravidla určují přístup kterým skupinám uživatelů. V horní části se zobrazuje seznam skupin uživatelů a počet nastavených pravidel (aby administrátor viděl, kterým kategoriím nastavil pravidla), v dolním formulář stejný jako pro '''Neveřejné zprávy''', kde ovšem nastavení platí pro skupinu uživatelů vybranou nahoře.

[[Image:neverejna_cast08-pravidla-pro-skupinu-uzivatelu.jpg|center]]

<div class="note">Využití této funkce má smysl jen v případě, že je nastaven typ autentifikace ''interní'', v opačném případě se nepoužívá.</div>

Pokud potřebujete vytvořit novou skupinu uživatelů, musíte se přejít do administrace modulu '''Registrace a personalizace''', kde se skupiny uživatelů spravují.

To, že je nějaké pravidlo v poli ''Použitá pravidla'' znamená, že právě upravovaná skupina uživatelů ke zprávám vyhovujícím tomuto pravidlu '''má''' přístup.

== Kontrola dat ==
Aby byla pravidla modulu funkční nejen pro zprávy, ale i pro stránky a soubory z databáze zdrojů, musí být tyto soubory a stránky uloženy v ''privátní zóně'' – to znamená, že se nenacházejí v části www serveru, která je přímo přístupná, ale jsou uloženy v adresářích, na které není přímý přístup a odtud se načítají ve chvíli zobrazení pomocí dynamických skriptů. Jedině v tom případě je zajištěno, že lze ověřit přístupová práva a stránku či soubor poskytnout pouze tomu, kdo k této položce má dle pravidel modulu Neveřejná část přístup.

Funkce '''Kontrola dat''' vyhledává položky, které nejsou odpovídajícím způsobem zabezpečené. To znamená, že vyhovují pravidlům stanoveným pro neveřejné položky, ale nenacházejí se v privátní zóně.

[[Image:neverejna_cast09-kontrola-dat.jpg|center]]

Více o veřejné a privátní zóně naleznete v Referenční příručce WebToDate. Položky, které se zde vypíší je vhodné přesunout do privátní zóny, jinak je může zobrazovat a stahovat kterýkoli anonymní uživatel.

== Externí autentifikace ==
=== Úvod ===

Modul umožňuje i externí autentifikaci. To znamená, že v takovém případě se při ověřování přístupu nepoužívá modul Registrace a personalizace, ale externí server. Při zobrazení určité položky (zprávy, stránky apod.) se v tomto režimu nejprve vyhodnocuje, zda je položka přístupná anonymním uživatelům či nikoliv – v tomto se oba režimy nijak neliší. V případě, že je zjištěno, že položka není anonymně přístupná, použije se algoritmus externího ověřování. Algoritmus ověřování v případě interní autentifikace je graficky znázorněn v kapitole [[../Začínáme#Základní principy|Základní principy]], algoritmus v případě externí autentifikace znázorňuje následující diagram.

[[Image:neverejna_cast10-diagram-algoritmu-autentifikace.jpg|center]]

V režimu externí autentifikace se nastavují dvojice pravidlo – kód. To znamená, že pokud zpráva (nebo jiný objekt) vyhovuje danému pravidlu modulu, je vyžadován zadaný kód. Kód je textový řetězec zadávaný administrátorem WebToDate pomocí funkce '''Administrace''' - '''Přístupové kódy''' modulu, v rámci uživatelské ''session'' je vytvářeno pole se dvěma sloupci:

* Kód
* Uživatel má / nemá přístup k danému kódu

Při zobrazování objektu se pak postupuje v tomto režimu následovně:

* Je zjišťováno, zda je či není daná stránka anonymně přístupná. Pokud není, vyžaduje se přihlášení, přičemž toto přihlášení se provádí přes formulář modulu ''(/''scripts/modules/access/login.php''). Pokud se již uživatel přes tento formulář přihlásil, je jeho uživatelské jméno a heslo v uživatelské ''session'' a tudíž se stránka pro přihlášení nezobrazí.
* Prochází se pravidla modulu, která mají přidělen nějaký kód. Na základě těchto pravidel se odvodí, zda uživatel má či nemá přístup k dané položce. Pokud má, je položka zobrazena, jinak je přesměrován na stránku ''Odmítnutí přístupu''.

Pro pravidla a jejich kódy platí:

* Každé pravidlo může mít přiřazen maximálně jeden kód.
* Jeden kód může být použit pro více pravidel.

Při testování pravidel a kódů se postupuje následovně:

* Zjišťuje se, zda zpráva vyhovuje pravidlu. Pokud ne, postupuje se na další pravidlo.
* Pokud zpráva pravidlu vyhovuje, zjistí se kód nastavený pro pravidlo. Kód se nejprve hledá ve výše zmíněném poli v ''session'' (aby nedocházelo k zbytečnému dotazování na externí server). Pokud je zde kód nalezen, je použita tato informace a uživateli je stránka zobrazena nebo přístup odmítnut.
* Pokud kód není nalezen v ''session'', vyvolá se dotaz do externího zdroje (zasílá se jméno, heslo a kód). Externí zdroj vrátí informaci, zda k danému kódu je nebo není uživatel autentifikován. Tato informace se v každém případě přidá do tabulky kódů v session. Pokud uživatel je autentifikován, stránka se zobrazí, jinak se pokračuje na další pravidlo.
* Jsou-li projita všechna pravidla a uživateli nebyl přístup podle nějakého pravidla povolen, nelze stránku zobrazit a přístup je zamítnut.

Funkce pro dotazování externího zdroje jsou umístěny do samostatné části tak, aby se jednalo o vyměnitelný plugin. Modul sám používá abstraktní funkci, která má jako parametry už. jméno, heslo a kód, funkce vrací hodnoty povolení / odmítnutí přístupu, takže samotný modul je odstíněn od vlastní komunikace s externím zdrojem.

<div class="note">V této chvíli je dostupný pouze plugin pro bránu POSTABO, která řeší předplatné novinových titulů a registrace těchto předplatitelů, další pluginy mohou být v budoucnu přidány.</div>

=== Postup konfigurace ===

Doporučený postup konfigurace je následující:

# V předvolbách modulu se nastaví externí režim autentifikace.
# Vytvoří se předloha pro přihlašovací stránku, vzorový kód přihlašovacího formuláře je uveden v kapitole [[../Reference#Formulářová pole a další možné parametry|Formulářová pole a další možné parametry]].
# Definují se pravidla modulu a nastavení '''Administrace''' – '''Neveřejné zprávy'''; v tomto se postup nijak neliší od postupů pro interní autentifikaci.
# Pomocí funkce '''Administrace''' – '''Přístupové kódy''' se definují dvojice pravidlo – kód. V tomto režimu se vůbec nepoužívá funkce '''Administrace''' – '''Uživatelé'''. Výslednou funkčnost ovlivňují pouze pravidla, která jsou nastavena pomocí funkce '''Neveřejné zprávy''' a ta, která jsou uvedená v seznamu '''Přístupové kódy'''. V databázi modulu (tj. v seznamu '''Pravidla''') mohou být definována i jiná pravidla než která pak figurují v obou zmíněných nastaveních, ta jsou při vyhodnocování přístupu kompletně ignorována.
# Definuje se stránka ''Odmítnutí přístupu''. Na stránky webové prezentace je možné umístit odkazy na skript pro přihlášení a odhlášení, na přihlašovací skript je ovšem uživatel v případě potřeby přesměrován automaticky.

<div class="note">Poznamenejme ještě jednou, že v tomto režimu se nevyužívají funkce modulu Registrace a personalizace, tedy ani jeho přihlašovací stránka ''/scripts/modules/registration/login.php'', místo toho se využívá vlastní přihlašovací stránka ''/scripts/modules/access/login.php.''</div>

=== Plugin pro bránu POSTABO ===

Momentálně je k dispozici pouze ověřovací plugin pro bránu POSTABO pro správu předplatitelů novinových titulů. Kód pluginu se nachází v souboru ''/scripts/modules/access/external/_com_inc.php''. Jako přístupové kódy se používají číselné kódy odpovídající jednotlivým novinovým titulům, jak je používá tento server.

Do konfiguračního souboru ''[[../../Referenční/Konfigurace WebToDate#Globální konfigurace WebToDate|global.php]]'' je nutné pro komunikaci s tímto serverem umístit konstantu definující URL brány:

<code>
<nowiki>define( 'EXTERNAL_ACCESS_SERVER', 'https://postabo.cpost.cz/pet/pet.php/');</nowiki>
</code>

Komunikace s bránou je vedena před protokol https. Funkce vyžaduje v PHP aktivní extenzi CURL, je tedy třeba např. ve Windows verzi odkomentovat v souboru ''php.ini'' následující řádek:

<code>
<nowiki>extension=php_curl.dll</nowiki>
</code>

Soubor:Neverejna cast06-nastaveni-pravidel.png

2014-06-03T10:48:27Z

Jardac: načtena nová verze "Soubor:Neverejna cast06-nastaveni-pravidel.png": Rozšíření pravidel o testování na hodnotu vstupního pole

[[Category:WebToDate Neveřejná část]]
Neveřejná část - definice pravidel

Soubor:Tvurciobsahu-administrace-sestava.png

2013-10-25T07:54:07Z

Jardac: Category:WebToDate Tvůrci obsahu Category:Tvůrci obsahu Formulář pro sestavu Přehled podle tvůrců a kontaktních osob

[[Category:WebToDate Tvůrci obsahu]]
[[Category:Tvůrci obsahu]]
Formulář pro sestavu Přehled podle tvůrců a kontaktních osob