TinWeb. příručka správce systému k verzi 10

Transkript

1 TinWeb příručka správce systému k verzi 10 Březen 2003

2 Obsah 1. ÚVOD HLAVNÍ KONFIGURAČNÍ SOUBOR TINWEBU - TW.RUN NASTAVENÍ DATABÁZE T SERIES, CESTY K SOUBORŮM, ZÁKLADNÍ NASTAVENÍ DATA_PATH BLOCK_SIZE CONFIG_FILES_PATH PICS_PATH SESSION_PATH NASTAVENÍ VSTUPNÍHO FORMULÁŘE TINWEBU, VZHLED ÚVODNÍ STRÁNKY A HLAVIČKY LANG_XX TITLE_XX ADMIN_MAIL SID_TIMER LIST_XX SEARCH_WHAT_XX SEARCH_WHERE_XX SEARCH_LIMIT_XX PARALEL VÝPŮJČKA PRODLUŽOVÁNÍ A REZERVACE DOKUMENTŮ REZXXX REZ_IF_ON_RACK REZ_IF_PENALTY REZ_IF_INVALID_CARD REZ_TRANSPORT_DOCUMENT REZ_ACCESS_NO REZ_EXPORT_PATH REZ_IMPORT_SCRIPT LOAN_VIEW LOAN_EXTENSION LOAN_EXPORT_PATH LOAN_IMPORT_SCRIPT TINEHOST_LOCK ZÁKLADNÍ RYSY A FUNKCE TINWEBU DOC_BASE L SID_TIMEOUT MAX_SESSION DEF_SORT TIMEOUT_CONNECT TIMEOUT_READ VIEW_DISABLED_RECS DEFAULT_PASSWORD PROPOJENÍ TINWEBU SE SYSTÉMY METALIB A SFX SFX_PREFFIX, SFX_DNAME, SFX_SUFFIX ML_QUERY_ID, ML_QUERY_ID_VAL, ML_OUTPUT_MIME_TYPE NASTAVENÍ ZOBRAZOVÁNÍ PODROBNOSTÍ U SEZNAMU ZÁZNAMŮ POPIS SOUBORU LISTING.EXT ( LISTING.WAP ) POVOLENÉ DATOVÉ SOUBORY PRO LISTOVÁNÍ SOUBOR FIXITS.TWB NASTAVENÍ ZOBRAZOVÁNÍ PODROBNOSTÍ V ZOBRAZENÉM ZÁZNAMU POPIS SOUBORŮ LABELS.* POPIS SOUBORU RECORD.EXT DEFINICE PODMÍNEK PRO VYHLEDÁVÁNÍ POPIS SOUBORU TITLE-TAG.TWB Strana i

3 6. ŘAZENÍ VYHLEDANÝCH ZÁZNAMŮ POPIS SOUBORU SORT-TAG.TWB TEXTOVÉ ZPRÁVY, POPISY TLAČÍTEK, MENU POPIS SOUBORU TEXTS.TWB DEFINICE PROHLEDÁVANÝCH DATABÁZÍ POPIS SOUBORU LIBS.TWB EXTERNÍ INFORMACE O LOKACÍCH DOKUMENTŮ SOUBOR LOCATION.TWB PŘIDÁVÁNÍ VLASTNÍCH ODKAZŮ NA LIŠTĚ NÁSTROJŮ SOUBOR EXTRNFN.TWB INTERAKTIVNÍ SLUŽBY TINWEBU - PRODLUŽOVÁNÍ VÝPŮJČKY A REZERVACE DOKUMENTŮ Strana ii

4 1. Úvod Program TinWeb je spouštěn WWW serverem jako CGI skript. Pouští se souborem tw (na unixových systémech) nebo tw.exe (na systémech Microsoft). TinWeb svou činnost řídí konfiguračními soubory, jejichž popis je hlavní náplní tohoto dokumentu. Editací těchto souborů se nastavují všechny parametrizovatelné rysy TinWebu. Nejdůležitějším konfiguračním souborem je tw.run. Tento soubor musí být umístěn ve stejném adresáři jako hlavní spouštěcí soubor (tw, nebo tw.exe). TinWeb pracuje s datovými soubory T Series. Tyto soubory se podle okolností mohou jmenovat fixit050.*, ufixit050.*, ubfixit050.* atp. (viz dokumentace k T Series). Znak '*' (hvězdička) je třímístné dekadické číslo. V dalším textu je na tyto soubory odkazováno jako fixit č. nnn. 2. Hlavní konfigurační soubor TinWebu - tw.run Soubor tw.run obsahuje parametry TinWebu ve formátu <parametr>=<hodnota>. Znak # uvozuje komentář. Komentářem je jakýkoliv text, nacházející se mezi znakem # a koncem řádku. Komentáře v souboru tw.run nemají na činnost TinWebu žádný vliv. Následující oddíly popisují význam jednotlivých parametrů Nastavení databáze T Series, cesty k souborům, základní nastavení DATA_PATH Cesta k databázi T Series. Musí být uvedena absolutní cesta, začínající v kořenovém adresáři, a musí být ukončena znakem. (tečka). Za tečku TinWeb připojuje čísla jednotlivých datových souborů. V případě systémů fy Microsoft musí cesta začínat písmenem příslušného disku a dvojtečkou. (unix) (Windows) DATA_PATH=/usr/tinman/tinlib/ufixit050. DATA_PATH=d:\tinlib\data\fixit BLOCK_SIZE Velikost datových bloků, na jakou je nastavena databáze T Series. Přípustné hodnoty jsou 4k, 8k, 16k, 32k (podrobnější informace viz manuál správce T Series) BLOCK_SIZE=8k CONFIG_FILES_PATH Cesta k dalším konfiguračním souborům TinWebu, které jsou popsány v dalších kapitolách. Cesta musí začínat v kořenovém adresáři a musí být ukončena znakem / (pro unixové systémy), nebo \ (pro systémy Microsoft) PICS_PATH URL adresáře, ve kterém má TinWeb uloženy obrázky (ikony, tlačítka, atp.) Jedná se o URL, nikoliv fyzickou cestu ve file systému serveru. Jestliže máme obrázky (ikony a tlačítka) TinWebu uloženy v adresáři /usr/lib/httpd/icons a v konfiguraci WWW serveru (např. httpd.conf pro server Apache) máme řádek Alias tinpics "/usr/lib/httpd/icons", pak v tw.run píšeme: PICS_PATH=/tinpics/. Strana 1

5 SESSION_PATH Cesta k adresáři, ve kterém si TinWeb vytváří pracovní soubory s informacemi pro jednotlivá uživatelská sezení. Pomocí těchto souborů TinWeb vytváří stavové prostředí nad bezestavovým protokolem HTTP. Cesta musí začínat v kořenovém adresáři a musí být ukončena znakem / (pro unixové systémy), nebo \ (pro systémy Microsoft) Nastavení vstupního formuláře TinWebu, vzhled úvodní stránky a hlavičky LANG_XX Tímto parametrem určíme pořadí, v jakém se zobrazí vlaječky (tlačítka) pro přepínání jednotlivých použitých jazyků. XX v názvu parametru určuje pořadí a hodnotou parametru je číslo jazyka (viz parametr L). Chceme-li nabízet volbu mezi jazyky německy, španělsky, dánsky, anglicky (v uvedeném pořadí), pak soubor tw.run bude obsahovat řádky: LANG_01=03 LANG_02=05 LANG_03=07 LANG_04= TITLE_XX Název (titulek) knihovny pro každý použitý jazyk. XX je číslo jazyka (viz parametr L). Mezery v textu názvu v tomto parametru musí být zapsány jako znak _ (podtržítko). Pokud text obsahuje nějaké znaky s ASCII hodnotou vetší než 127, musí být takové znaky zapsány ve stejném kódování jako data v T Series. Chceme li nabízet jazyky český, slovenský, německý a anglický a knihovna se jmenuje Knihovna ABC, pak soubor tw.run bude obsahovat řádky: TITLE_00=Knihovna_ABC TITLE_01=Knižnica_ABC TITLE_03=Bibliothek_ABC TITLE_02=Library_ABC ADMIN_MAIL Hodnotou tohoto parametru je adresa pracovníka, na kterého mají být směrovány dotazy a připomínky uživatelů TinWebu SID_TIMER Tento parametr může nabývat pouze dvou hodnot 1 nebo 0. TinWeb podle něj zobrazuje (SID_TIMER=1) nebo nezobrazuje (SID_TIMER=0) hodiny, které v okně WWW prohlížeče ukazují čas zbývající do vypršení (ukončení) jednoho uživatelského sezení. Tento čas se nastavuje vždy znovu na maximální hodnotu s každou uživatelskou akcí v rámci jednoho sezení. Hodnota, na kterou se časovač s každou akcí nastaví, je dána parametrem SID_TIMEOUT (viz níže) LIST_XX Tyto parametry definují pole, která jsou v TinWebu nabízena k listování. Dvoumístné dekadické číslo XX určuje pořadí, v jakém budou jednotlivé volby v TinWebu zobrazeny. Položka s nejmenší hodnotou XX je implicitní volba (bude v nabídce zobrazena jako první). Hodnoty tohoto parametru mají tvar: YYY ZZZZ, kde YYY je třímístné dekadické číslo fixitu (souboru *fixit*.xxx z databáze T Series), jehož klíčovými poli se bude listovat, a ZZZZ je čtyřmístné dekadické číslo textu v souboru texts.twb (viz popis souboru texts.twb), který bude zobrazen v příslušné nabídce. Pro tyto texty jsou vyhrazena čísla v intervalu Strana 2

6 Dejme tomu, že chceme nabízet listování v názvech knih, ve jménech autorů a v číslech ISBN (v uvedeném pořadí). Názvy knih leží v klíčových polích fixitu č. 016, jména autorů ve fixitu č. 019 a ISBN ve fixitu č V souboru texts.twb (viz popis souboru texts.twb) budeme mít například pod čísly 2201, 2204, 2210 pro češtinu texty Názvy knih, Jména autorů a ISBN. Pak v tw.run musí být následující tři řádky: LIST_00= LIST_01= LIST_02= SEARCH_WHAT_XX Těmito parametry nastavujeme typy dokumentů, jejichž vyhledávání chceme nabízet. Dvoumístné dekadické číslo XX určuje pořadí, v jakém budou jednotlivé volby v TinWebu zobrazeny. Položka s nejmenší hodnotou XX je implicitní volba (bude v nabídce zobrazena jako první). Hodnoty tohoto parametru mají tvar: YYY ZZZZ kde YYY je třímístné dekadické číslo fixitu, který obsahuje záznamy o dokumentech daného typu a ZZZZ je čtyřmístné dekadické číslo textu v souboru texts.twb (viz popis souboru texts.twb), který bude zobrazen v příslušné nabídce. Pro tyto texty jsou vyhrazena čísla v intervalu Chceme nabízet vyhledávání knih (fixit č. 016), audiovizuálních dokumentů (fixit č.147) a jakýchkoliv (všech) typů dokumentů (fixit č. 051) v uvedeném pořadí. V souboru texts.twb (viz popis souboru texts.twb) budeme mít například pod čísly 2301, 2304, 2310 pro češtinu texty knihy, AV dokumenty a všechny typy dokumentů. Pak v tw.run musí být následující tři řádky: SEARCH_WHAT_00= SEARCH_WHAT_01= SEARCH_WHAT_02= SEARCH_WHERE_XX Těmito parametry nastavujeme nabídku polí, která se mají nabízet pro konstrukci dotazu na dokumenty popsané parametry SEARCH_WHAT_XX. Dvoumístné dekadické číslo XX určuje pořadí, v jakém budou jednotlivé volby v TinWebu zobrazeny. Položka s nejmenší hodnotou XX je implicitní volba (bude v nabídce zobrazena jako první). Hodnoty tohoto parametru mají tvar: YYY ZZZZ, kde YYY je třímístné dekadické číslo fixitu, který obsahuje záznamy o entitách, podle kterých mají být vyhledávány dokumenty definované v parametru SEARCH_WHAT_XX, a ZZZZ je čtyřmístné dekadické číslo textu v souboru texts.twb (viz popis souboru texts.twb), který bude zobrazen v příslušné nabídce. Pro tyto texty jsou vyhrazena čísla v intervalu Chceme nabízet vyhledávání podle autorů (fixit č. 019), předmětových skupin (fixit č. 022) a klíčových slov z názvů (fixit č. 024) v uvedeném pořadí. V souboru texts.twb (viz popis souboru texts.twb) budeme mít například pod čísly 2401, 2405, 2411 pro češtinu texty Jméno autora, Předmětová skupina a Klíčové slovo z názvu. Pak v tw.run musí být následující tři řádky: SEARCH_WHERE_00= SEARCH_WHERE_01= SEARCH_WHERE_02= SEARCH_LIMIT_XX Tyto parametry, stejně jako parametry SEARCH_WHERE_XX, nastavují nabídku polí, která se mají nabízet pro konstrukci dotazu na dokumenty popsané parametry SEARCH_WHAT_XX. Hodnoty tohoto parametru mají tvar: YYY ZZZZ stejně jako u parametru SEARCH_WHERE_XX. Rozdíl je v tom, že hodnota YYY zde nevyjadřuje číslo fixitu, jako u parametru SEARCH_WHERE_XX, ale jednu z deseti předdefinovaných hodnot z následujícího seznamu: Strana 3

7 001 Typ dokumentu 002 Médium 003 Jazyk dokumentu 004 Lokace dokumentu 005 Země vydání dokumentu 006 Rok vydání dokumentu 007 Místo vydání dokumentu 008 Nástrojové obsazení 009 Žánr 010 Obecné označení druhu dokumentu ZZZZ je čtyřmístné dekadické číslo textu v souboru texts.twb (viz popis souboru texts.twb), který bude zobrazen v příslušné nabídce. Pro tyto texty jsou vyhrazena čísla v intervalu Poznámka: Rozdílnost přístupu k polím popsaným parametry SEARCH_WHERE a SEARCH_LIMIT spočívá v tom, že v prvním případě se jedná o vazbová pole, jejichž vyhledávání je poměrně rychlé, a ve druhém případě o tzv. nevazbová pole. Za použití terminologie relačních databází můžeme říct, že pole popsaná parametry SEARCH_LIMIT netvoří žádný klíč, proto hledání podle těchto polí v podstatě znamená listování seřazenou tabulkou s maskováním definovaným právě těmito poli. Chceme nabízet vyhledávání podle jazyka, roku vydání a nástrojového obsazení v uvedeném pořadí. V souboru texts.twb (viz popis souboru texts.twb) budeme mít například pod čísly 2507, 2512, 2515 pro češtinu texty Jazyk dokumentu, Rok vydání a Obsazení. Pak v tw.run musí být následující tři řádky: SEARCH_LIMIT_00= SEARCH_LIMIT_01= SEARCH_LIMIT_02= PARALEL Tento parametr má pouze dvě možné hodnoty a říká, zda TinWeb má (=1) nebo nemá (=0) nabízet paralelní prohledávání dalších knihoven. Parametry knihoven, které bude TinWeb nabízet, jsou popsány v souboru libs.twb 2.3. Výpůjčka prodlužování a rezervace dokumentů REZXXX Parametr povoluje (=1) nebo zakazuje (=0) zobrazení tlačítka, kterým se vyvolává žádanka o rezervaci dokumentu, jehož záznam je zobrazen. Řetězec XXX je třímístné dekadické číslo fixitu, který obsahuje záznamy příslušného typu dokumentů. Chceme-li tedy například umožnit rezervace knih a článků a zakázat rezervace časopisů a audiovizuálních dokumentů, budou v souboru tw.run následující řádky: REZ016=1 REZ037=1 REZ043=0 REZ147=0 #knihy #články #časopisy #audiovizuálních dokumenty REZ_IF_ON_RACK Parametr říká, zda se má (=1) nebo nemá (=0) povolit rezervace dokumentů, které nejsou kompletně půjčeny (mají nějaký výtisk na místě). Strana 4

8 REZ_IF_PENALTY Parametr říká, zda se má (=1) nebo nemá (=0) povolit rezervace dokumentů, pokud rezervující uživatel má nějakou neuhrazenou pokutu REZ_IF_INVALID_CARD Parametr říká, zda se má (=1) nebo nemá (=0) povolit rezervace dokumentů, pokud rezervující uživatel má neplatný (prošlý) čtenářský průkaz REZ_TRANSPORT_DOCUMENT Parametr říká, zda se má (=1) nebo nemá (=0) povolit přeprava rezervovaného dokumentu mezi pobočkami (viz popis soborů r-branch.twb a r-locs.twb, které obsahují seznamy povolených poboček a lokací) REZ_ACCESS_NO Parametr říká, zda se má (=1) nebo nemá (=0) povolit rezervace konkrétního přírůstkového čísla dokumentu REZ_EXPORT_PATH Cesta k souboru, do kterého TinWeb exportuje žádost o rezervaci. Po provedení exportu TinWeb spouští skript (viz parametr REZ_IMPORT_SCRIPT), který provede import exportovaných dat do databáze T Series. Posledním příkazem skriptu musí být příkaz pro smazání vyexportovaného souboru. Nepřítomnost (přítomnost) tohoto souboru slouží současně pro TinWeb jako semafor, indikující, že může (nemůže) být exportován případný další požadavek na rezervaci REZ_IMPORT_SCRIPT Cesta ke skriptu, který do databáze T Series importuje data ze souboru vytvořeného TinWebem v případě žádosti o rezervaci dokumentu (viz parametr REZ_EXPORT_PATH). Posledním příkazem skriptu po provedeném importu musí být smazání importovaného souboru LOAN_VIEW Parametr nastavuje zda TinWeb má(=1), nebo nemá(=0) nabízet prohlížení vlastních výpůjček LOAN_EXTENSION Parametr nastavuje zda TinWeb má(=1) nebo nemá(=0) nabízet prodlužování vlastních výpůjček LOAN_EXPORT_PATH Cesta k souboru, do kterého TinWeb exportuje identifikační údaje vypůjčeného dokumentu, u kterého je požadováno prodloužení výpůjčky. Po provedení exportu TinWeb spouští skript (viz parametr LOAN_IMPORT_SCRIPT), který provede import exportovaných dat do databáze T Series. Posledním příkazem skriptu musí být příkaz pro smazání vyexportovaného souboru. Nepřítomnost (přítomnost) tohoto souboru slouží současně pro TinWeb jako semafor, indikující, že může (nemůže) být exportován případný další požadavek na prodloužení LOAN_IMPORT_SCRIPT Cesta ke skriptu, který do databáze T Series importuje data ze souboru vytvořeného TinWebem v případě žádosti o prodloužení výpůjčky (viz parametr LOAN_EXPORT_PATH). Posledním příkazem skriptu po provedeném importu musí být smazání importovaného souboru TINEHOST_LOCK Cesta k souboru, jehož přítomnost indikuje, zda má TinWeb umožnit provádění rezervací a prodlužování výpůjček. Ve chvíli, kdy probíhají údržbové akce na databázi T Series není vhodné, aby byly prováděny importy dat. Skript, kterým se údržba databáze spouští, by měl ze všeho nejdřív vytvořit soubor popsaný parametrem TINEHOST_LOCK, čímž TinWebu řekne, že nemá umožnit provádění rezervací nebo prodlužování výpůjček. Po skončení údržby musí být soubor smazán, má-li TinWeb opět umožnit prodlužování a rezervace. Pozn.: Soubor popsaný parametrem TINEHOST_LOCK může obsahovat cokoliv nebo může být prázdný. Pro TinWeb je důležitý pouze jeho název a přístupová práva nastavená tak, aby TinWeb mohl soubor číst. Strana 5

9 2.4. Základní rysy a funkce TinWebu DOC_BASE Hodnotu tohoto parametru TinWeb dosazuje do HTML hlaviček svých výstupů jako hodnotu atributu BASE ve značce <HEAD> Hodnota tohoto parametru má tvar: serveru>[:<číslo TCP portu>] Parametr nesmí být ukončen lomítkem L Číslo použitého jazyka. Hodnota je dekadické číslo, zleva doplněné nulami na dvě místa. Přípustné hodnoty jsou: 00 (česky) 01 (slovensky) 02 (anglicky) 03 (německy) 04 (francouzsky) 05 (španělsky) 06 (maďarsky) 07 (dánsky) 08 (nizozemsky) SID_TIMEOUT Doba expirace jednoho uživatelského sezení v minutách. Hodnota se zapisuje jako dekadické číslo, zleva doplněné nulami na čtyři místa (např.: SID_TIMEOUT=0010 ). Čas je měřen vždy od poslední uživatelské akce v daném sezení MAX_SESSION Maximální možný počet současně existujících uživatelských sezení. Hodnotou je dekadické číslo, zleva doplněné nulami na čtyři místa DEF_SORT Tento parametr určuje, jak budou řazeny vyhledané záznamy. Hodnota parametru má tvar XXH, kde XX je dvoumístné dekadické číslo pole, podle kterého se má výsledek seřadit, a H říká, jestli má být výsledek řazen podle abecedy vzestupně (=U), nebo sestupně (=D). Význam čísel polí (XX) se definuje v souboru sort-tag.twb (viz popis souboru sort-tag.twb ). Chceme-li, aby TinWeb vždy seřadil vyhledané záznamy vzestupně podle jména autora, a pole autor má v souboru sort-tag.twb přidělenou hodnotu např. 4, pak v tw.run bude: DEF_SORT=04U Poznámka: Vyhledané záznamy seřazené podle implicitního nastavení (parametr DEF_SORT) si může uživatel vždy seřadit jinak, a to podle jednoho z až 10 nabízených polí, definovaných v souboru sort-tag.twb TIMEOUT_CONNECT Doba v sekundách, po jejímž uplynutí se TinWeb přestane pokoušet navázat spojení s knihovnou, která byla vybrána z nabídky prohledávaných knihoven. Hodnotou je dekadické číslo, zleva doplněné nulami na 4 místa TIMEOUT_READ Doba v sekundách, po jejímž uplynutí TinWeb přestane čekat na data od knihovny, která byla vybrána z nabídky prohledávaných knihoven. Hodnotou je dekadické číslo, zleva doplněné nulami na 4 místa. Strana 6

10 VIEW_DISABLED_RECS Tento parametr nastavuje, jak má TinWeb pracovat se záznamy, které mají vyplněné pole 0x9977 nebo 0x9988 (skryté záznamy dále jen SZ). Parametr má čtyři možné hodnoty: 0 bude potlačeno zobrazení jakéhokoliv odkazu na SZ, 1 budou se zobrazovat všechny odkazy na SZ, při navigaci na tyto záznamy se zobrazí pouze jejich hlavička (klíčové pole), místo podrobností se zobrazí text uvedený v souboru texts.twb (viz popis souboru texts.twb) pod číslem 1140, 2 budou se zobrazovat všechny odkazy na SZ, při navigaci na tyto záznamy se zobrazí pouze ty podrobnosti (pole), které mají v příslušném souboru labels.* (viz popis souborů labels.*) čtvrtý přepínač nastavený na 0, 3 budou se zobrazovat všechny odkazy na SZ a všechny podrobnosti těchto záznamů podle definic v souborech labels.* (viz popis souborů labels.*) stejně jako u ostatních neskrytých záznamů DEFAULT_PASSWORD Hodnotou tohoto parametru je implicitní heslo, na které TinWeb nedovolí prohlížení vlastních výpůjček, jejich prodlužování a rezervace dokumentů. Pokud tento parametr chybí nebo je nevyplněn, je povoleno jakékoliv heslo Propojení TinWebu se systémy Metalib a SFX SFX_PREFFIX, SFX_DNAME, SFX_SUFFIX Pomocí těchto tří parametrů TinWeb generuje u nalezených záznamů odkazy ve formátu OpenURL do systému SFX. Odkazy jsou konstruovány tak, že TinWeb provede zřetězení prvních dvou parametrů, za ně připojí hodnoty některých polí z nalezeného záznamu (pole jsou definována v souboru sfx_tags.twb viz popis souboru) a nakonec připojí třetí parametr. Jsou-li v tw.run následující tři řádky SFX_PREFFIX= SFX_DNAME=UPOL SFX_SUFFIX=pid=lp=octopus.ruk.cuni.cz,Port=9909,ServiceClass=ALL a v souboru sfx_tag.twb jsou definována pole se jménem autora a ISBN, pak u záznamu knihy A farewell to arms od E. Hemingwaye s ISBN TinWeb vygeneruje tlačítko s následujícím URL: title=a+farewell+to+arms&isbn= &aulast=hemingway& aufirst=ernest& charset=cp12050&pid=serviceclass=all Pozn.: Pokud v tw.run chybí parametr SFX_PREFFIX nebo SFX_SUFFIX, nebude TinWeb tlačítko SFX nabízet ML_QUERY_ID, ML_QUERY_ID_VAL, ML_OUTPUT_MIME_TYPE Tyto parametry slouží pro propojení TinWebu se systémem MetaLib firmy ExLibris. První dva parametry říkají TinWebu, jaký parametr a jaká jeho hodnota se objeví v dotazech od MetaLibu (podle nich TinWeb jednoznačně detekuje, zda se jedná o dotaz vygenerovaný systémem MetaLib). Třetí parametr TinWebu říká, jaký Mime-Type má dosadit do HTTP hlavičky odpovědi, kterou posílá zpět systému MetaLib. Strana 7

11 3. Nastavení zobrazování podrobností u seznamu záznamů 3.1. Popis souboru listing.ext ( listing.wap ) Soubor listing.ext řídí způsob, jakým TinWeb zobrazuje seznamy nalezených záznamů. Přidáváním (mazáním) a editací parametrů v soboru listing.ext můžeme určovat, jaké podrobnosti bude TinWeb zobrazovat v seznamech záznamů. Soubor listing.ext musí být umístěn v adresáři popsaném parametrem CONFIG_FILES_PATH v souboru tw.run. Znak # uvozuje komentář. Komentářem je jakýkoliv text nacházející se mezi znakem # a koncem řádku. Komentáře nemají na činnost TinWebu žádný vliv. Konfigurační parametry v souboru listing.ext se zadávají po řádcích ve formátu: 1a 1b 2a 2b c d c1 d1 x y z Význam jednotlivých parametrů je následující: 1a: Číslo zdrojového fixitu, z jehož klíčových polí je tvořen aktuální seznam. Hodnotou je dvoumístné hexadecimální číslo. 1b: Číslo pole ve zdrojovém fixitu, jehož obsah se má zobrazovat nebo ze kterého se má navigovat do dalšího (cílového) fixitu. Hodnotou je čtyřmístné hexadecimální číslo. 2a: Číslo cílového fixitu. Hodnotou je dvoumístné hexadecimální číslo. Pokud je rovno 0, bude se zobrazovat pouze obsah pole 1b z fixitu 1a. 2b: Číslo pole v cílovém fixitu, jehož obsah se má zobrazovat, pokud hodnota 2a není rovna 0. Hodnotou je čtyřmístné hexadecimální číslo. c: Počet znaků, které se mají zobrazit z daného pole (1b, 2b). Hodnotou je třímístné dekadické číslo. Pokud c se rovná 0, zobrazuje se celý obsah daného pole. d: Binární přepínač (přípustné hodnoty jsou 0 nebo 1), který v případě, že parametr 2a se nerovná 0, TinWebu říká, zda se mají zobrazovat obě pole 1b a 2b (=1) nebo pouze pole 2b (=0). c1: Ukončení zkráceného řetězce. Hodnotou je řetězec, který se připojuje za pole 1b nebo 2b v případě, že hodnota parametru c je různá od 0 a současně je menší než skutečná délka dat v poli 1b nebo 2b (data jsou zkrácena). d1: Oddělovač mezi poli 1b a 2b. Hodnotou je řetězec, který se má zobrazit mezi poli 1b a 2b v případě, že se obě pole mají zobrazit (d==1). x: Oddělovač (řetězec) před prvním výskytem pole 1b nebo 2b. y: Oddělovač (řetězec) mezi výskyty pole 1b nebo 2b. z: Oddělovač (řetězec) za posledním výskytem pole 1b nebo 2b. Strana 8

12 Chceme-li, aby seznam záznamů s podrobnostmi vypadal takto: pak v souboru listing.ext musíme mít následující řádky: 10 0A <I> /.</I> <I> -.</I> <I> - </I> <I> : </I> <I>,.</I> <I> - </I> <I> ISBN </I> <FONT COLOR="GREEN"><< >></FONT> # odpovednost # vydani # misto vydani # nakladatel # rok vydani # fyzicky popis # ISBN # vlastnik dokumentu Pozn.: Pro soubor listing.wap platí naprosto stejná syntaktická pravidla jako pro popisovaný soubor listing.ext. Soubor listing.wap slouží pro definici zobrazovaných podrobností v seznamech pro službu WAP (přístup k TinWebu přes mobilní telefon) Povolené datové soubory pro listování soubor fixits.twb Když listujeme seznamem záznamů, resp. seznamem klíčových polí z určitého datového souboru, lze ve WWW prohlížeči TinWebu podsunout jiný datový soubor (změnou hodnoty parametru KDE v URL), a tím si nechat vylistovat data, jejichž zveřejnění je nežádoucí. Z toho důvodu TinWeb vždy porovnává parametr KDE v URL se seznamem povolených datových souborů a listování těmi, které v seznamu nejsou, neumožní. Tento seznam je v souboru fixits.twb. Soubor je umístěn v adresáři definovaném parametrem CONFIG_FILES_PATH v souboru tw.run. Obsahuje čísla všech datových souborů, které chceme povolit k listování. Čísla jsou zapsána samostatně na jednotlivých řádcích. Strana 9

13 4. Nastavení zobrazování podrobností v zobrazeném záznamu 4.1 Popis souborů labels.* Soubory labels.* řídí způsob, jakým TinWeb zobrazuje jednotlivá pole v záznamech. Editací těchto souborů se nastavuje, jaká pole se mají v jednotlivých záznamech zobrazovat. Soubory labels.* musí být umístěny v adresáři popsaném parametrem CONFIG_FILES_PATH v souboru tw.run. Ke každému datovému souboru T Series, ze kterého má TinWeb zobrazovat záznamy, musí existovat příslušný soubor labels.* (hvězdička v názvu soboru labels.* je nahrazena číslem shodným s číslem v názvu příslušného datového souboru - fixitu). Znak # uvozuje komentář. Komentářem je jakýkoliv text nacházející se mezi znakem # a koncem řádku. Komentáře nemají na činnost TinWebu žádný vliv. Konfigurační parametry v souborech labels.* se zadávají po řádcích v následujícím formátu: XXXX YY abcdef string... kde XXXX: YY: abcdef: čtyřmístné hexadecimální číslo pole, jehož obsah má TinWeb zobrazovat dvoumístné dekadické číslo jazyka, ve kterém je zapsán string... Pokud aktuálním jazykem TinWebu je například angličtina, pak z příslušného souboru labels.* se čtou pouze řádky, kde YY má hodnotu 02 (viz parametr L v souboru tw.run) šest binárních přepínačů (hodnota 0 nebo 1 ), které mají zleva následující význam: a Tento přepínač je funkční pouze pro záznamy, do kterých jsme se dostali přes slovník z vyhledávacího formuláře. Nastavuje, zda má TinWeb pro dané pole (XXXX) nabízet validační tlačítko tlačítko, kterým se obsah daného pole dosazuje zpět do vyhledávacího formuláře. Tato tlačítka se zobrazují pouze v případě, že jsme se do aktuálního záznamu dostali přes slovník výrazů pro vyhledávání: b Přepínač nastavuje, zda se má u daného pole nabízet skok na listování množinou polí stejného typu jako dané pole. Jeho nastavení na jedničku např. pro pole, ve kterém je jméno autora, způsobí, že u jména autora se objeví ikona (modrá šipka doleva), jejímž stiskem se dostaneme na seznam všech autorů: c Třetí přepínač povoluje (zakazuje) navigaci z daného pole na záznam o tomto poli (např. navigace ze jména autora na záznam o tomto autorovi). Pozn.: nastavení tohoto přepínače na 1 ještě nemusí nutně znamenat, že dané pole v TinWebu opravdu umožní navigaci. Umožní ji pouze v případě, že je pole navigovatelné i v T Series. d V případě, že parametr VIEW_DISABLED_RECS v souboru tw.run má hodnotu 2, pak tento přepínač nastavuje, zda se má nebo nemá potlačovat zobrazení daného pole. e,f Tyto dva poslední přepínače nejsou v současné verzi použity. string... Textový řetězec, který má TinWeb zobrazovat jako název pole. Tyto řetězce musí být zapsány ve stejném kódování jako texty v databázi T Series (např. Strana 10

14 pro střední a východní Evropu je to CP852, pro západní a severní Evropu CP850 atp.). Chceme, aby v záznamech o knihách (fixit č. 16) byla zobrazována pole podle tohoto obrázku: Dále má TinWeb nabízet české a anglické prostředí (viz parametry LANG_XX v souboru tw.run). Pak v adresáři popsaném parametrem CONFIG_FILES_PATH v souboru tw.run musí být soubor labels.016 s následujícími řádky: Nazev Title Autor Author Nakladatel Publisher Poznamky Notes Predmetova skupina Subject heading Klicove slovo Title keyword 4.2 Popis souboru record.ext Soubor record.ext upřesňuje a rozvíjí definice polí v záznamech popsané v souborech labels.*. Při zobrazování záznamu z jednoho konkrétního datového souboru můžeme pomocí souboru record.ext definovat další pole z dalších datových souborů, která se mají zobrazit. Můžeme tak například v záznamu o knize, který standardně leží ve fixitu č. 016, zobrazit současně podrobnosti o přírůstkovém čísle (lokace, vlastník, atp.), které leží ve fixitu č V jednotlivých záznamech tak můžeme zobrazovat tzv. podzáznamy, které se v souboru record.ext definují po řádcích takto: kde 1a 1b mnop 2a,2b,2c,...: 1a dvoumístné hexadecimální číslo fixitu, ve kterém se nachází právě aktuální záznam, 1b čtyřmístné hexadecimální číslo pole ve fixitu 1a, ke kterému chceme zobrazit podzáznam z jiného (cílového) fixitu (z toho, na který bychom v TinWebu jinak normálně navigovali), m binární přepínač, který nastavuje, zda má TinWeb před polem 1b zobrazit textové návěští přečtené v příslušném souboru labels.*, n binární přepínač, který nastavuje, zda má TinWeb zobrazit obsah pole 1b, o binární přepínač, který nastavuje, zda má TinWeb zobrazit před poli 2a, 2b, 2c,... textová návěští přečtená v příslušném souboru labels.*, Strana 11

15 p binární přepínač, který nastavuje, zda má být zobrazený podzáznam zarámovaný v tabulce, 2a,2b,2c,... seznam čtyřmístných hexadecimálních čísel polí, která mají být zobrazena z cílového fixitu. Seznam je oddělen čárkami a posledním znakem je dvojtečka. Z tohoto seznamu budou zobrazena pouze ta pole, která jsou definována současně v příslušném souboru labels.* Chceme-li v záznamu o knize (fixit č. 016) zobrazit podrobnosti o výtiscích (přírůstkových číslech - fixit č. 029) daného titulu, pak v souboru record.ext bude následující řádek: ,1D04,1D05,1D90: Odpovídající část záznamu o knize pak TinWeb zobrazí takto: 5. Definice podmínek pro vyhledávání popis souboru title-tag.twb Když uživatel spustí v TinWebu vyhledávání dokumentů podle nabídek a voleb definovaných v souboru tw.run v parametrech SEARCH_WHERE a SEARCH_WHAT, TinWeb v souboru title-tag.twb zjišťuje, jaká pole v jakých datových souborech mají být prohledána. Soubor titletag.twb musí existovat v adresáři definovaném v souboru tw.run v parametru CONFIG_FILES_PATH. Řádky v souboru title-tag.twb mají následující strukturu: kde X1 X2 f1,f2, fn X1 dvoumístné hexadecimální číslo fixitu, jehož klíčová pole obsahují názvy hledaných dokumentů, X2 f1,f2,,fn dvoumístné hexadecimální číslo fixitu, jehož klíčová pole obsahují názvy objektů, podle kterých se má v daném dotazu vyhledávat, čísla polí, která ve fixitu číslo X2 obsahují názvy hledaných dokumentů. V souboru tw.run jsme pomocí parametrů SEARCH_WHERE a SEARCH_WHAT definovali, že má TinWeb nabízet (mimo jiné) vyhledávání knih podle jmen autorů (viz popis souboru tw.run). Pak v souboru title-tag.twb musí být řádek: ,0344,0909,0910,CC12,CC13,CC14,CC15,CC16 Strana 12

16 TinWeb pak při spuštění dotazu, který má hledat názvy knih podle jmen autorů, ví podle definic v parametrech SEARCH_WHERE a SEARCH_WHAT v souboru tw.run, že má hledat dokumenty, jejichž názvy leží v klíčových polích datového souboru č. 16 (0x10), a že je bude hledat v některých polích datového souboru č. 19 (0x13). Najde tedy v souboru title-tag.twb řádek začínající a na zbytku řádku si přečte čísla polí, ve kterých má v datovém souboru č. 19 (0x13) hledat odpovídající názvy. 6. Řazení vyhledaných záznamů popis souboru sort-tag.twb TinWeb může vyhledané dokumenty řadit vzestupně nebo sestupně podle názvů nebo podle některého z až deseti definovaných polí. Implicitní řazení je dáno parametrem DEF_SORT v souboru tw.run. Po ukončení vyhledávání a zobrazení výsledku si může uživatel způsob řazení přepnout na jiné než implicitní. Parametr DEF_SORT v souboru tw.run, stejně jako uživatelské přepínače řazení, své chování odvozují z definic v souboru sort-tag.twb. Řádky v tomto souboru mají následující strukturu: kde N X1:F1:X2:F2 N dvoumístné dekadické pořadové číslo přepínače řazení (01-10). Text, který se u daného přepínače zobrazuje, se čte ze souboru texts.twb (viz popis souboru) pod číslem *N. Například u přepínače číslo 03 bude text číslo 2030; X1 dvoumístné hexadecimální číslo fixitu, ve kterém se hledá pole F1; F1 čtyřmístné hexadecimální číslo pole z X1, které bude použito pro řazení v případě, že X2 se rovná 0, nebo ze kterého se naviguje do X2 v případě, že X2 se nerovná 0; X2 dvoumístné hexadecimální číslo fixitu, ve kterém se hledá pole F2; F2 čtyřmístné hexadecimální číslo pole z X2, které bude použito pro řazení v případě, že X2!=0. Chceme, aby TinWeb nabízel vyhledávání knih a článků a umožňoval řazení výsledku podle autora, roku vydání a země původu. Pak v sort-tag.twb budou řádky: 01 10:0303:00:0000 #autor knihy 01 10:0344:00: :0909:00: :0910:00: :9201:92:0333 #autor clanku 01 25:9201:00: :2513:00: :0403:00:0000 #rok vydani knihy 02 25:1204:00:0000 #rok vydani clanku 03 10:CA03:00:0000 #zeme vydani knihy 03 25:252B:2B:1206 #zeme vydani clanku 03 25:1025:10:CA :DF10:10:CA03 TinWeb pak u seznamu vyhledaných záznamů bude zobrazovat následující přepínače řazení: Poznámka: - Odpovídající si řadicí pole pro různé typy dokumentů (např. rok vydání u knihy a rok vydání u článku) musí mít stejné pořadové číslo N. Strana 13

17 - Pokud se pro daný typ dokumentu opakuje několik řádků se stejným N, pak TinWeb prochází tyto řádky, dokud nenajde vyplněné pole (např. řádky z příkladu začínající 02 25: ). - Kromě polí popsaných v soboru sort-tag.twb bude TinWeb vždy nabízet řazení podle názvů. 7. Textové zprávy, popisy tlačítek, menu popis souboru texts.twb Všechny textové výstupy TinWebu jako položky menu, popisy ikon a tlačítek, chybové zprávy atp. jsou uloženy v souboru texts.twb po řádcích v následujícím formátu: kde No L string... No čtyřmístné číslo textového řetězce, pod kterým ho TinWeb identifikuje. Většina textů používaných systémem má své pevné číslo. U textů, které může správce modifikovat jsou přiděleny intervaly čísel, které jsou popsány v tomto dokumentu tam, kde je to relevantní k probírané problematice; L číslo jazyka (viz parametry LANG_XX v souboru tw.run); string.. textový řetězec v příslušném jazyce. Text musí být zapsán ve stejné znakové sadě jako texty v databázi T Series (např. pro střední a východní Evropu je to CP852, pro západní a severní Evropu CP 850 atp.). Pokud má TinWeb nabízet české, anglické a německé prostředí, pak pro text definovaný parametrem SEARCH_WHERE v souboru tw.run pod číslem 2205 pro vyhledávání ve jménech autorů musí soubor texts.twb řádky: ve jmenech autoru in author names in Autornamen 8. Definice prohledávaných databází popis souboru libs.twb TinWeb umožňuje rozesílat dotazy paralelně několika knihovnám, které mají rovněž nainstalovaný TinWeb. Nabídka knihoven, ze které si uživatel vybírá ty, jejichž databáze chce prohledávat, se definuje v souboru libs.twb. Každá definovaná knihovna zde má čtyři řádky: [ZKR]NAME=<nazev knihovny> [ZKR]HOST=<IP adresa, nebo jmeno serveru s TinWebem> [ZKR]PORT=<cislo TCP portu, na kterem bezi httpd s TinWebem> [ZKR]PATH=<relativni URL TinWebu>, kde ZKR je zkratka názvu knihovny, kterou TinWeb používá pro identifikaci. Název knihovny musí být zapsán ve stejné znakové sadě, jaká je použita v databázi T Series a znaky (mezera) musí být zapsány jako _ (podtržítko). Číslo portu je zapsáno jako dekadické číslo, doplněné zleva nulami na pět míst. Pro knihovnu s názvem Knihovna ABC, jejíž httpd běží na serveru pokusny.server.cz na portu 80 a relativní URL TinWebu na tomto serveru je /cgi-bin/tw, budou v souboru libs.twb následující řádky: [ABC]NAME=Knihovna_ABC [ABC]HOST=pokusny.server.cz [ABC]PORT=00080 [ABC]PATH=/cgi-bin/tw 9. Externí informace o lokacích dokumentů soubor location.twb Strana 14

18 Při zobrazování podrobností o konkrétním výtisku (přírůstkovém čísle) může TinWeb generovat HTML odkaz na externí objekt, například stránky pracoviště, na kterém je dokument umístěn. Tyto odkazy jsou vázány na pole, ve kterém je zapsána lokace výtisku, a definují se v souboru location.twb. Soubor musí být umístěn v adresáři popsaném parametrem CONFIG_FILES_PATH v souboru tw.run. Jednotlivé lokace a příslušné odkazy jsou po řádcích popsány takto: <nazev lokace> <HTML link>. Když TinWeb zobrazuje záznam, jehož lokační údaje jsou popsány v location.twb, tak u příslušné lokace bude ikona : Příslušná část záznamu pak vypadá například takto: Poznámka: Názvy lokací musí být v location.twb zapsány přesně tak, jak jsou uvedeny v databázi T Series ve stejné znakové sadě, se všemi bílými znaky atp. Nejspolehlivější způsob, jak získat správný seznam lokací je export přímo z T Series (viz manuály T Series). HTML odkaz musí být uveden jako úplné URL (<protocol>://<server_name>[:port]/<path>). 10. Přidávání vlastních odkazů na liště nástrojů soubor extrnfn.twb Na liště nástrojů: můžeme definovat další tlačítka s HTML odkazy. Definují se v souboru extrnfn.twb. Každé definované tlačítko má v tomto souboru tři řádky: XXIMG=<URL_obrazku_tlacitka> XXURL=<URL_odkazu> XXALT=<ALT_text_k_obrazku>, kde XX je libovolné dvoumístné dekadické číslo (pro dvě různé trojice popsaných řádků se nesmí opakovat). Alternativní text k ikoně (XXXALT) musí být zapsán ve stejném kódování jako data v T Series. Chceme, aby se na liště nástrojů objevovalo tlačítko: jehož URL je s odkazem a aby se při najetí myší nad tlačítko objevoval alternativní text vyhledávač Google. Pak v souboru extrfn.twb musíme mít tři řádky: 00IMG= 00URL= 00ALT=VYHLEDAVAC GOOGLE. Strana 15

19 Nástrojová lišta TinWebu potom bude vypadat takto: 11. Interaktivní služby TinWebu - prodlužování výpůjčky a rezervace dokumentů TinWeb z bezpečnostních důvodů neumožňuje přímý zápis do databáze T Series, takže v případě že je potřeba nějaká data do databáze zapsat postupuje tak, že příslušná data vyexportuje do textového souboru a zavolá příslušnou službu T Series, která tato data vlastními prostředky do databáze naimportuje. Tak je tomu i v případech, kdy si uživatel chce přes TinWeb rezervovat nějaký dokument, nebo prodloužit své výpůjčky. Parametry, které přesně určují, jak se tyto dvě služby v TinWebu mají chovat jsou nastaveny v souboru tw.run a jsou přesně popsány v kapitole 2.3 této příručky. Aby obě popisované služby začaly fungovat, je nutné učinit následující kroky: Nastavení jména souboru pro export/import V příručce administrátora k T Series zjistíme název a cestu k souborům, ve kterých daná verze systému T Series očekává vyexportované požadavky na prodloužení nebo rezervaci. Tyto názvy použijeme jako hodnoty parametrů REZ_EXPORT_PATH a LOAN_EXPORT_PATH v souboru tw.run (viz kap a ). Zjištění "LOGNAME" T Series Pro spuštění požadované akce, kterou je v tomto případě import požadavku na prodloužení výpůjčky, nebo rezervace dokumentu, jsou v systému T Series vyhrazená jména (UID). Při přihlášení pod těmito jmény systém T Series automaticky provádí danou akci. Jména se mohou v různých verzích T Series lišit, proto je potřeba je zjistit z příručky administrátora T Series. Vytvoření importovacího skriptu Po vyvolání požadavku na prodloužení, nebo rezervaci na straně WWW prohlížeče, TinWeb spustí skript, z něhož se spustí klientský proces T Series. Tento proces provede v neinteraktivním režimu import požadavku na prodloužení, nebo rezervaci a ukončí se. Skript pak musí jako poslední krok smazat soubor, vyexportovaný TinWebem, protože existence tohoto souboru slouží současně jako semafor, který TinWebu říká, že nemůže provádět další akci (prodloužení, rezervace). Pokud se tedy dva uživatelé pokusí prodloužit svou výpůjčku současně, nebo těsně za sebou, pak ten který je systémem obsloužen jako první, zablokuje druhého a ten pak čeká, až je ukončena akce prvního. V okamžiku, kdy je dokončena, je smazán vyexportovaný soubor, což dá TinWebu signál, že může vytvořit další export a spustit importovací skript. Celá akce probíhá "mžikově" (řádově milisekundy), takže uživatelé čekající ve frontě subjektivně nezaregistrují žádné zpoždění. Skript musí mít nastavena přístupová práva tak, aby ho byl TinWeb schopen spustit. Jinak řečeno - UID vlastnící běžící procesy TinWebu musí mít na importovací script právo alespon "r-x" (read, execute). Stejná práva musí mít tato UID na programy a konfigurační soubory systému T Series. Příklad rezervace: Máme povolenou rezervaci monografií (viz parametry popsané v kapitole 2.3), a v souboru tw.run máme nastavené parametry: REZ_EXPORT_PATH=/usr/tinman/run/rez_exp REZ_IMPORT_SCRIPT=/usr/tinman/run/rez_imp Z dokumentace k T Series zjistíme, že "Logname" pro import rezervace je například imp_rez. Potom importovací skript (/usr/tinman/run/rez_imp) může vypadat takto: #!/bin/bash export LOGNAME=imp_rez export TERM=vt100 Strana 16

20 export HOME=/usr/tinman /bin/chmod 777 /usr/tinman/run/r cd /usr/tinman/run /usr/tinman/fixit/fixit /usr/tinman/run/runfile.twb > /usr/tinman/run/log.imp 2>&1 tput sgr0 tput cnorm /bin/rm /usr/tinman/run/rez_exp Pozn.: K příslušnému "Logname" (v tomto případě "imp_rez") musí mezi konfiguračními soubory T Series existovat příslušný "runfile" se jménem imp_rez.run (více viz příručka administrátora T Series) Strana 17