WebToDate/Offline generátor/Reference

Administrační rozhraní

Nabídka modulu

Nabídka modulu vypadá následovně:

Administrace

Předvolby

Pravidla exportu

Šablony

Export

Protokoly

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

Předvolby

V předvolbách modulu se nastavují zejména cesty k adresářům a způsob pojmenovávání exportovaných souborů.

Ve formuláři předvoleb se nastavují následující položky:

• Název adresáře pro zprávy – název adresáře, do kterého se exportují HTML soubory se zprávami (výchozí hodnota articles)
• Název adresáře pro stránky - název adresáře, do kterého se exportují HTML soubory se stránkami WebToDate (výchozí hodnota pages)
• Název adresáře pro soubory ze zdrojů – název adresáře, do kterého se kopírují soubory z databáze zdrojů, které jsou součástí offline prezentace (výchozí hodnota assets)
• Prefix souborů se zprávami – pro soubory ukládané do adresáře pro zprávy se vytváří název souboru jako tento prefix + ID zprávy + koncovka souboru (výchozí hodnota art)
• Prefix souborů se stránkami - pro soubory ukládané do adresáře pro stránky se vytváří název souboru jako tento prefix + ID stránky + koncovka souboru (výchozí hodnota page)
• Název souboru s úvodní stránkou – každá oflline prezentace má jednu výchozí stránku umístěnou v kořenovém adresáři offline prezentace (výchozí hodnota default.htm)
• Koncovka pro soubory se zprávami a stránkami – koncovka, která se použije pro exportované soubory se zprávami a stránkami (výchozí hodnota htm)
• Ponechat koncovky stránek – pro soubory se zprávami se použije vždy koncovka daná předvolbami, pro stránky rovněž tak s výjimkou seznamu koncovek v tomto nastavení (zadávají se koncovky oddělené středníkem, výchozí hodnota htm;html;css;js)
• Neidentifikovaná URL nahrazovat odkazem – zadává se název stránky v kořenovém adresáři, na kterou povedou odkazy na položky, které nejsou součástí exportovaných souborů, tedy např. odkazy na moduly apod. (výchozí hodnota prázdná, zadejte např. "nopage.htm"). Je možné i ponechat prázdnou hodnotu, pak se takové typy odkazů budou generovat jako prázdné.
• Interpretovat generované PHP stránky – zda se mají stránky WebToDate s koncovkou PHP nejprve spustit a jejich výstup uložit jako statická stránka (výchozí volba zaškrtnuto)

Všechny názvy adresářů se uplatní v rámci dané cesty k exportované prezentaci, tedy jedná se o podadresáře adresáře offlinedata/offgen/exports/ID_pravidla/. Název adresáře pro statické obrázky je dán hodnotou konfigurační konstanty WebToDate WWWIMAGES.

Při vytváření offline verze je podporováno interpretování generovaných PHP stránek. To znamená, že pokud je ve WebToDate ve stromu kategorií nadefinována stránka s koncovkou PHP, která se exportuje, je možné stránku před uložením do adresáře pages spustit a získat tak kompletní HTML kód.

Podmínkou pro spuštění této funkce je, že v předvolbách jsou nastaveny volby:

• Interpretovat generované PHP stránky
• Koncovka PHP není v seznamu Ponechat koncovky stránek.

Pokud není zvolena možnost interpretace, vygenerované PHP kódy se nespouštějí. Pokud koncovka PHP je v seznamu ponechávaných koncovek, je výsledkem stránka typu pagexxx.php, pokud není v seznamu, je výsledkem stránka pagexxx.htm.

Pravidla exportu

V modulu se definují pomocí formuláře kritéria pro export. Kritéria se týkají stránek a zpráv, související zdroje se následně dohledávají automaticky.

Pro stránky se povinně vybírá jedna nebo více kategorií s možností volby všechny, volba se může vztahovat i na všechny podkategorie. Tato základní volba kategorií se vztahuje i na export zpráv, pro zprávy lze ale selekci omezit pomocí výběru dalších metadat (např. publikace). Nastavení voleb exportu lze uložit (případně uložit i více různých nastavení), předpokládá se, že je žádoucí periodicky exportovat nějakou stejnou část webu, tuto volbu tedy není třeba vytvářet opakovaně.

Tato volba se bere jako podklad pro výběr zpráv a stránek. Znamená to, že např. zpráva, která je umístěná na nějakou stránku, ale neodpovídá kritériu výběru pro export, exportována nebude. U stránek lze navíc specifikovat explicitně seznam stránek, které se exportují (nezávisle na volbě exportovaných kategorií). Použití by mělo být zejména takové, že pomocí této funkce se do exportu zařadí pomocné stránky typu css apod.

Pokud je zjištěno, že je ve WebToDate nastaveno více virtuálních serverů, vybírá se povinně právě jeden virtuální server, toto omezení je pak aplikováno na exportované stránky.

V pravém horním rámci je seznam pravidel tříděný podle ID pravidla sestupně, klepnutím na název pravidla se ve spodním rámci prohlížeče zobrazuje formulář pro definici pravidla.

Formulář má tři záložky - Základní, Další a Stránky. V první záložce se vyplňují následující volby:

• Název pravidla (povinné)
• Jazyk – volí se jazyk zpráva a stránek, které se budou exportovat, je možná volba všechny
• Stav - výchozí volba je Publikováno a Archivováno, dále lze zvolit Publikováno a Archivováno; zobrazuje se až od verze WebToDate 4.1
• Server - zobrazuje se jen pokud je databázová tabulka s definicemi virtuálních serverů neprázdná, v takovém případě je třeba povinně vybrat právě jeden server
• Výchozí stránka - povinně se vybírá standardním dialogem právě jedna stránka ze stromu kategorií, která budou výchozí stránkou exportované prezentace
• Kategorie - vybírá se seznam kategorií k exportu dialogem podobným tomu, jakým se vybírají ve WebToDate např. kategorie ve formuláři pro editaci zprávy. Navíc je v dialogu možnost označit při přidání kategorie do seznamu, že se má exportovat včetně podkategorií, tento příznak se pak zobrazí značkou (S) za názvem kategorie v seznamu kategorií. Povinně se vybírá alespoň jedna kategorie.

V druhé záložce Další se specifikuje omezení exportu na publikace a témata WebToDate. V levé části jsou položky, na které je export omezen, vpravo zbývající publikace resp. témata, mezi seznamy se přesouvá tlačítky se šipkami. Význam těchto nastavení je takový, že pokud není např. žádná publikace v seznamu Exportované publikace, exportují se všechny publikace, v opačném případě pouze uvedené publikace.

Ve třetí záložce Stránky se specifikuje explicitní seznam stránek, které se zařazují do exportu (tj. kromě stránek, které vyhovují ostatním nastavením pravidla, zejména zařazení do stromu kategorií). V levé části je seznam názvů zařazených stránek, tlačítkem Přidat se zobrazí standardní dialog pro výběr jedné stránky ze stromu kategorií, tlačítko Odebrat odebere vybranou stránku ze seznamu vlevo (klepnutím na položku v seznamu lze tedy vybrat jednu položku k odebrání).

Zakládat, měnit i mazat pravidla lze dle potřeby. V případě mazání pravidla se maže i adresář offlinedata/offgen/definitions/ID_pravidla včetně obsahu, adresář s vygenerovanou offline verzí se touto funkcí nemaže.

Šablony

Modul podporuje mapování šablon a předloh. To znamená, že lze v modulu pro libovolnou stránku ze stromu šablon zvolit jako párovou jinou takovou stránku.

Každá stránka ve WebToDate má šablonu, každá zpráva předlohu. Pokud se při generování offline verze z dané položky zjistí, že k předloze / šabloně, která je pro danou položku ve WebToDate zvolena existuje mapovaná stránka, použije se tato mapovaná namísto původní šablony či předlohy. Tím je vyřešeno to, že některé předlohy či šablony mohou obsahovat ve WebToDate objekty, které není žádoucí v offline verzi použít.

Pomocí této funkce se tedy nastavuje mapování šablon. Význam tohoto nastavení je takový, že před sestavením stránky kteréhokoliv typu si nejprve modul zjistí, jakou ve WebToDate používá šablonu, resp. u zpráv předlohu. Pak se zjistí, zda v modulu není na tuto šablonu namapována jiná stránka a pokud tomu tak je, vynutí se při generování tato namapovaná stránka. Aparát zajišťuje jednoduchou možnost použití jiných šablon pro offline verzi, přičemž není nutné tyto šablony volit na úrovni cílových generovaných stránek, ale na úrovni jejich šablon, což minimalizuje potřebnou práci s nastavením exportu.

Interface je stejný jako funkce Strom šablon WebToDate. V pravém horním rámci se zobrazuje strom šablon ve stejné podobě jako ve WebToDate, klepnutím na položku ve stromu se přechází do editačního formuláře v pravém spodním rámci, kde lze nastavit nebo zrušit mapování.

Význam tlačítek ve formuláři je následující:

• Vybrat ze stromu kategorií - zobrazí dialog pro výběr jedné stránky ze stromu kategorií
• Vybrat z kategorií předloh - zobrazí dialog pro výběr jedné předlohy z kategorií předloh
• Zrušit mapování - zruší mapování, tj. vymaže volbu stránky v poli Mapovat na.

V každém případě (i při zrušení mapování) se změna v databázi provádí až použitím tlačítka Uložit.

Nemá smysl mapovat tu samou stránku na sama sebe, takže toto formulář neumožňuje uložit, jinak lze pro každou stránku ve stromu šablon zvolit maximálně jedno mapování.

Export

Po vytvoření pravidla se používá tato funkce pro vlastní export prezentace. Tento export probíhá ve dvou krocích:

1. Generování XML souborů se seznamy položek k exportu
2. Vlastní export prezentace

V horním rámci se zobrazuje seznam pravidel identicky jako u funkce Pravidla exportu. Klepnutím na pravidlo se ve spodním rámci zobrazuje formulář pro export.

V první části formuláře se v podstatě jedná o výpis obsahu adresáře offlinedata/offgen/definitions/ID_pravidla. Pokud je zde odpovídající soubor nalezen, vypíše se jeho velikost v kB, jinak se zobrazí nápis Ne. Vedle informace o souboru jsou tři odkazy:

• Zobrazit - zobrazí XML soubor v novém okně prohlížeče; aktivní jen když soubor existuje
• Stáhnout - pošle XML do prohlížeče s informací o určení ke stažení v http hlavičce; aktivní jen když soubor existuje
• Odeslat na server - otevře v novém okně prohlížeče dialogové okénko pro upload XML souboru; aktivní vždy.

Dále jsou ve formuláři čtyři tlačítka, která slouží ke spouštění obou kroků exportu a ke smazání korespondujících souborů exportu:

• Generovat seznamy přegeneruje tři XML soubory se seznam položek. Pokud v adresáři alespoň jeden soubor existuje, zobrazí se potvrzení "Alespoň jeden soubor se seznamem položek existuje, přepsat?". Tlačítko je aktivní vždy.
• Smazat seznamy maže zmíněné tři XML soubory, opět je vyžadováno potvrzení "Opravdu chcete smazat soubory se seznamy položek k exportu?". Tlačítko je aktivní, jen pokud existuje aspoň jeden XML soubor.
• Smazat všechny soubory offline verze maže celý obsah adresáře offlinedata/offgen/exports/ID_pravidla (resp. podle toho, jak je to nastaveno v předvolbách modulu). Je vyžadováno potvrzení "Opravdu chcete smazat všechny vygenerované soubory?" Tlačítko je aktivní, jen pokud v daném adresáři je aspoň jedna položka (soubor nebo adresář).
• Generovat offline verzi spouští samotný proces generování. Je aktivní, jen pokud existují všechny tři XML soubory se seznamy položek.

Generování seznamů i offline verze zobrazuje průběh exportu ("teploměr"), může se jednat o časově poměrně náročný proces.

Protokoly

Modul zapisuje svoje protokoly do adresáře offlinedata/offgen/logs/. K prohlížení protokolů se používá standardní interface jako ve WebToDate či v jiných modulech.

Protokolují se zejména následující události:

• Zápis jakéhokoli souboru do adresáře pro vygenerovanou offline verzi
• Zápis do kteréhokoli XML souboru
• Upload XML souboru
• Smazání obsahu adresáře s XML soubory nebo s offline verzí (jako jeden zápis)
• Jakékoli chyby (nelze zapsat soubor apod.).

Formát seznamů položek k exportu

V prvním kroku exportu se do adresáře definitions/číslo ukládají vždy tři XML soubory, které obsahují seznam položek k exportu. Jedná se o soubory:

• articles.xml - obsahuje seznam článků k exportu
• assets.xml - obsahuje seznam souborů z databáze zdrojů k exportu
• pages.xml - obsahuje seznam stránek k exportu

Jejich formát je následující:

articles.xml:

<?xml version="1.0" encoding="UTF-8"?>
<offline type="articles">
	<created date="2006-08-13"/>
	<items>
		<item id="3214" title="Výroční zpráva za rok 2004" export="auto"/>
		<item id="3217" title="Usnesení městského zastupitelstva ze dne 2.6.2007" export="auto"/>
		<item id="1065" title="Výběrové řízení na www stránky úřadu" export="auto"/>
	</items>
</offline>

assets.xml:

<?xml version="1.0" encoding="UTF-8"?>
<offline type="assets">
	<created date="2006-08-13"/>
	<items>
		<item id="1101" assetid="516" title="Výroční zpráva za rok 2004 (formát DOC)" export="auto"/>
		<item id="1222" assetid="522" title="Usnesení městského zastupitelstva ze dne 2.6.2007 (formát PDF)" export="auto"/>
		<item id="106" assetid="444" title="Ilustrační foto - stavební práce" export="auto"/>
	</items>
</offline>

pages.xml:

<?xml version="1.0" encoding="UTF-8"?>
<offline type="pages">
	<created date="2006-08-13"/>
	<items>
		<item id="17" title="Výroční zprávy" export="auto"/>
		<item id="20" title="Usnesení městského zastupitelstva" export="auto"/>
		<item id="121" title="Výběrová řízení" export="auto"/>
	</items>
</offline>

Formát všech tří souborů je v zásadě stejný. Kořenový element je offline, jeho atributem je typ type, možné hodnoty jsou articles | assets | pages. Dále mohou následovat metadata, export v případě založení souboru zde zapíše element created s atributem date obsahujícím datum vytvoření. Pak následuje element items obsahující vlastní seznam exportovaných položek.

Každá položka je reprezentována jedním elementem item, který má v atributech informace o tom, o jakou položku se jedná. Tyto atributy jsou:

• id - ID položky (zprávy, souboru či stránky)
• assetid - používá se pouze v assets.xml, zapisuje se ID zdroje, do kterého soubor patří
• title - nadpis či název (zprávy, zdroje či stránky)
• export - atribut ovlivňuje chování druhého kroku exportu.

Možné hodnoty atributu export jsou auto | yes | no | prázdná hodnota. Pokud první krok exportu přidává do XML souboru novou položku, vždy nastaví tento atribut na auto. Druhý krok exportu exportuje všechny položky uvedené v XML souboru s výjimkou těch, které mají nastaveno export na hodnotu no. Tato možnost slouží k vyloučení položky z exportu jednou provždy - pokud by se řádek s položkou item jednoduše smazal a pak provedl druhý krok exportu, nežádoucí položka by se sice neexportovala, ale opětovné spuštění prvního kroku by ji znovu doplnilo. Je tedy možné ručně změnit atribut na hodnotu no a tím tomuto jevu zabránit.