Základní nastavení modulu

Studijní publikace » Základní nastavení modulu

NASTAVENÍ SYSTÉMU
Následující informace popisují nastavení týkající se serveru, na kterém je celý sytém provozován, a jsou proto určeny pouze pro správce tohoto systému. Běžný uživatel by se jimi neměl nechat zneklidnit.
Úvodní informace
Systém přípravy studijních publikací je poměrně komplexní systém, ve kterém je řada míst, která lze označit za slabší či více problematická. Je proto třeba věnovat zvýšenou pozornost nejen instalaci, ale i nastavení potřebných parametrů tak, aby byl další provoz celé aplikace bezproblémový.
Nastavení provedené během instalace v souboru def.inc je pouze základní. Pozornost je třeba věnovat souboru cml/setup.inc a nastavení okolního prostředí (webserver a pod.).
Okolí ...
Celý systém kromě PHP 4 s modulem pro přístup k databázi Oracle potřebuje tyto, řádně nainstalované, programy:
Kromě toho je třeba zajistit, aby výstup generovaný stránkou soubor.php nebyl překódováván. Sám pošle správnou HTTP hlavičku tak, aby klient mohl správně uložit soubor na disk v kódování, které je očekáváno. Pokud používáte server Apache s modulem CSáček, lze toho docílit např. umístěním souboru .htaccess do adresáře cml, jehož obsah bude cca následující:
<files "soubor.php">                                                                            
 csacekengine off                                                                                   
</files>
cml/setup.inc ...
Drtivou většinu nastavení lze realizovat v souboru cml/setup.inc. Jako první jsou definovány typy částí, které určují základní vlastnosti, které jsou společné typově stejným částem publikace (vstupní formát, přípona souboru, vstupní kódování, atd, viz komentář v souboru). Dále jsou nastaveny jednotlivé části publikace, pro každou je uvedeno jméno, typ a pro typ dynamic i adresář, ve kterém je skript ke spuštění. Následuje nastavení práv na vytvořené soubory, nastavení adresářů a podpůrných programů.
Typy částí
onlinestandardní položka studijních plánů, vstup je CML, kontrolují se předměty
staticstatický text, vstup v TeXu, nekontroluje se nic
dynamicsoubory jsou generovány uživatelským skriptem, neprovádí se kontrola předmětů, zpracovává se TeX výstup skriptu
whiteseznam předmětů, zvláštní položka, vstupují data prog. Tajemník
compiledspojení ostatních částí publikace dohromady, vstupy jsou finální TeX soubory z ostatních součástí
...další typy publikace lze na základě objednávky doplnit
Vstupní kódování uvedené v definici typů má v této verzi pouze informativní charakter a neovlivňuje průběh zpracování.
Části publikací
Pořadí, v jakém jsou části definovány v souboru setup.inc určuje pořadí, v jakém jsou části prezentovány ve webovém rozhraní.
Nastavení práv
Práva jsou aplikována na soubory v jednotlivých adresářích a měla by sytému umožňovat manipulaci se soubory. Zadávat lze jakékoli vhodné číslo dle syntaxe PHP.
Adresáře
Jak je uvedeno i na jiných místech dokumentace, každá část publikace má určeno písmeno, které ji reprezentuje, nejen v uživatelském rozhraní, ale i v konfiguraci. V souladu s tím je v každém z adresářů WORK_DIR, BACKUP_DIR, RELEASE_DIR a LOG_DIR zvláštní adresář pro soubory dané části publikace.
WORK_DIRzde se zpracovávají soubory, navíc přímo do adresáře (nikoli do konkrétní části karolínky) se ukládá soubor s předměty z tajemníka, takže do adresáře musí být možno zapisovat
BACKUP_DIRsem se ukládají zálohy datových souborů (protokoly o běhu se nezálohují), každý soubor je profiltrován gzipem a uložen s datem a časem odzálohování, stačí práva na čtení
RELEASE_DIRzde jsou umístěny výsledky zpracování a odtud jsou také předávány soubory ke stažení a ke sloučení do jedné publikace, stačí práva na čtení
LOG_DIRzde jsou záznamy o jednotlivých akcích, typicky log TeXu, resp. pdfTeXu, stačí práva na čtení
LOCK_DIRzde se přechodně vytvářejí zámky, které informují systém o tom, který překlad právě probíhá, do adresáře musí být možnost zapisovat, žádné adresáře se nevytvářejí
Podpůrné programy
Definice podpůrných programů uzavírá nastavení, která lze provést v souboru setup.inc. Parametry programů by neměl být důvod měnit, cesty jsou závislé na lokální instalaci. Při nastavování je třeba mít na zřeteli defaultní environment, který má uživatel, na kterého pouští web-server procesy.
Nastavení položky AKADEMICKY_ROK nehraje žádnou roli, protože se automaticky nahrává z programu Parametry.
KONTROLA NASTAVENÍ SYSTÉMU
Úvodní informace
Základní nástroj pro kontrolu celého systému je stránka Diagnostika/Společné, která přehledně zobrazuje aktuální stav a zároveň upozorňuje na případné chyby. Stránka má dvě základní části: Konfigurační proměnné a Části publikace.
Konfigurační proměnné
Přehledný výpis především informuje o proměnných, které jsou používány při běhu systému:
Veškeré zde popsané kontroly přístupu, zápisu, čtení, spouštění a pod. jsou prováděny relativně k uživateli/skupině, kterou má proces www serveru, resp. ve které běží jím spouštěné procesy.
Části publikace
Výpis přehledně zobrazuje práva pro jednotlivé adresáře svázané s částmi publikace. Pro bezproblémový běh je třeba, aby procesy měly práva pro zápis, čtení a procházení těchto adresářů. V záhlaví tabulky jsou "kořenové" adresáře, dle nastavení v cml/setup.inc