ˇ ˚ DOKUMENT SPECIFIKACE POZADAVK U Inovace modulu pro prohl´ıˇzen´ı sn´ımk˚ u digitalizovan´ych dokument˚ u
10. dubna 2014
T´ ym:
null
ˇ Clenov´ e: Michal Kacerovsk´ y David Hrb´aˇcek Ondˇrej Kupil´ık Marek Naggy
[email protected] [email protected] [email protected] [email protected]
Obsah ´ 1 Uvod 1.1 Pˇredmˇet specifikace . . . . 1.2 C´ılov´e publikum, n´avod ke 1.3 Rozsah projektu . . . . . . 1.4 Odkazy . . . . . . . . . . .
. . . .
3 3 3 3 3
. . . . . . .
4 4 4 4 4 5 5 5
3 Funkce syst´ emu 3.1 Zobrazen´ı digitalizovan´ ych sn´ımk˚ u. . . . . . . . . . . . . . . . . . . . . . 3.1.1 Popis a priorita . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.2 Ud´alosti a odpovˇedi . . . . . . . . . . . . . . . . . . . . . . . . . .
6 6 6 6
4 Poˇ zadavky na vnˇ ejˇ s´ı rozhran´ı 4.1 Uˇzivatelsk´a rozhran´ı . . . . 4.2 Hardwarov´a rozhran´ı . . . . 4.3 Softwarov´a rozhran´ı . . . . . 4.4 Komunikaˇcn´ı rozhran´ı . . .
. . . .
7 7 7 7 7
5 Dalˇ s´ı parametrick´ e poˇ zadavky 5.1 V´ ykonnostn´ı poˇzadavky . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.2 Bezpeˇcnostn´ı poˇzadavky . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.3 Kvalitativn´ı parametry . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7 7 7 7
6 Ostatn´ı poˇ zadavky
8
. . . ˇcten´ı . . . . . .
. . . .
2 Obecn´ y popis 2.1 Kontext syst´emu . . . . . . . . . 2.2 Funkce produktu . . . . . . . . . 2.3 Tˇr´ıdy uˇzivatel˚ u . . . . . . . . . . 2.4 Provozn´ı prostˇred´ı . . . . . . . . 2.5 Omezen´ı n´avrhu a implementace . 2.6 Uˇzivatelsk´a dokumentace . . . . . 2.7 Pˇredpoklady a z´avislosti . . . . .
. . . .
. . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
. . . .
. . . . . . .
. . . .
Revize dokumentu Datum
verze
Pozn´ amka
Autor
10. dubna 2014
1.0
v´ ychoz´ı verze
Ondˇrej Kupil´ık
´ Uvod
1 1.1
Pˇ redmˇ et specifikace
Tato specifikace se zab´ yv´a poˇzadavky na softwarov´ y produkt, kter´ ym je inovace modulu pro prohl´ıˇzen´ı sn´ımk˚ u digitalizovan´ ych dokument˚ u. C´ılem je nahrazen´ı st´avaj´ıc´ıho prohl´ıˇzeˇce IIPZoom zaloˇzen´ ym na technologii Flash za jin´ y prohl´ıˇzeˇc zaloˇzen´ y na technologii HTML 5. V´ ysledn´ y inovovan´ y modul bude slouˇzit pro zobrazov´an´ı archivn´ıch dokument˚ u na webov´em port´alu www.portafontium.cz, kter´ y spoleˇcnˇe s dalˇs´ımi partnery provozuje St´atn´ı oblastn´ı archiv v Plzni (d´ale jen SOA).
1.2
C´ılov´ e publikum, n´ avod ke ˇ cten´ı
Dokument specifikace poˇzadavk˚ u je urˇcen n´asleduj´ıc´ım ˇcten´aˇr˚ um: • Bc. Michal Kacerovsk´ y, vedouc´ı t´ ymu • Bc. David Hrb´aˇcek, ˇclen t´ ymu • Bc. Marek Naggy, ˇclen t´ ymu • Bc. Ondˇrej Kupil´ık, ˇclen t´ ymu • Bc. Petr Kocourek, zadavatel projektu za SOA • Ing. Luk´aˇs Hol´ y, cviˇc´ıc´ı pˇredmˇetu ASWI • Doc. Ing. Pˇremysl Brada, MSc. PhD., pˇredn´aˇsej´ıc´ı pˇredmˇetu ASWI
1.3
Rozsah projektu
Rozsah a u ´ˇcel projektu jsou podrobnˇe pops´any v dokumentu Vize projektu, kter´ y je k dispozici v kapitole Odkazy
1.4
Odkazy
• Bc. Michal Kacerovsk´ y, Dokument vize projektu, http://students.kiv.zcu.cz/ wiki/uploads/Aswi2014Null/vize.pdf • Webov´ y port´al pˇreshraniˇcn´ı spolupr´ace Porta Fontium www.porta-fontium.cz
3
2
Obecn´ y popis
2.1
Kontext syst´ emu
C´ılem tohoto projektu je nahrazen´ı prohl´ıˇzeˇce sn´ımk˚ u zpracovan´ ych IIP Image Serverem. Na webov´em port´alu www.porta-fontium moment´alnˇe zobrazuje digitalizovan´e sn´ımky prohl´ıˇzeˇc IIP Zoom zaloˇzen´ y na Flash, kter´ y je pro zadvatele projektu nevyhovuj´ıc´ı pˇredevˇs´ım kv˚ uli ˇspatn´emu zobrazov´an´ı na mobiln´ıch zaˇr´ızen´ıch. Flash objekty totiˇz nejsou napˇr. na tabletech podporov´any. Nov´ y prohl´ıˇzeˇc, kter´ y bude vybr´an ˇcleny realizaˇcn´ıho t´ ymu, by mˇel b´ yt zaloˇzen´ y na technologii HTML 5, kter´a je na mobiln´ıch zaˇr´ızen´ıch podporov´ana. Webov´ y port´al www.porta-fontium.cz je pˇreshraniˇcn´ım projektem, na kter´em se za ˇceskou stranu pod´ıl´ı SOA Plzeˇ n a za nˇemeckou stranu Gener´aln´ı ˇreditelstv´ı st´atn´ıch bavorsk´ ych archiv˚ u v Mnichovˇe. C´ılem projektu je znovu spojit archivn´ı fondy, kter´e byly v minulosti n´asilnˇe roztrˇzen´e, do jednoho virtu´aln´ıho celku.
2.2
Funkce produktu
Hlavn´ı funkc´ı produktu je zobrazen´ı sken˚ u archivn´ıch dokument˚ u uˇzivateli na webov´em port´alu. Vylepˇsen´ım oproti st´avaj´ıc´ı verzi prohl´ıˇzeˇce by mˇelo b´ yt lepˇs´ı zobrazen´ı na mobiln´ıch zaˇr´ızen´ıch (tablety, mobiln´ı telefony). Uˇzivatel by mˇel m´ıt moˇznost jednotliv´e skeny pˇribliˇzovat a pˇribl´ıˇzen´ y v´ ybˇer posouvat. Spr´avci by mˇel produkt umoˇznit nahr´at nov´e skeny na IIP Server a mˇenit nastaven´ı modulu.
2.3
Tˇ r´ıdy uˇ zivatel˚ u
Uˇzivatel´e produktu mohou m´ıt n´asleduj´ıc´ı role: • nepˇrihl´aˇsen´ y uˇzivatel • pˇrihl´aˇsen´ y uˇzivatel • spr´avce
2.4
Provozn´ı prostˇ red´ı
V n´asleduj´ıc´ım seznamu budou kr´atce pˇredstaveny vˇsechna prostˇred´ı, kter´a jsou s realizac´ı projektu spojen´a: • IIP Zoom - prohl´ıˇzeˇc obr´azk˚ u pouˇz´ıvan´ y doposud, zaloˇzen´ y na technologii Flash • jeden z prohl´ıˇzeˇc˚ u pro zobrazov´an´ı obr´azk˚ u z IIPI Serveru zaloˇzen´ y na HTML 5 - IIP Moo Viewer, Diva.js, OpenSeadragon, OpenLayers Zoomify - javascriptov´e pluginy slouˇz´ıc´ı k naˇc´ıt´an´ı velkoform´atov´ ych obr´azkov´ ych soubor˚ u • IIP Image Server - server, kter´ y pˇrev´ad´ı zdrojov´a data uloˇzen´a v pyramidov´e struktuˇre na dlaˇzdice ve form´atu JPEG 4
• CMS Drupal 7 - volnˇe dostupn´ y softwarov´ y bal´ık, kter´ y lze v administraˇcn´ım rozhran´ı volnˇe instalovat a n´aslednˇe pouˇz´ıvat v ˇsablon´ach str´anek • Memcache a Varnish - cache pouˇz´ıvan´e na IIPI Serveru • webov´ y port´al Porta Fontium - web, na kter´em budou v´ ysledn´ ym modulem naskenovan´e dokumenty zobrazov´any
2.5
Omezen´ı n´ avrhu a implementace
Omezen´ı n´avrhu a implementace jsou pops´any v dokumentu Vize projektu, kapitola 6 Rizika projektu.
2.6
Uˇ zivatelsk´ a dokumentace
K projektu bude vypracov´ana uˇzivatelsk´a dokumentace zahrnuj´ıc´ı program´atorsk´ y manu´al, uˇzivatelskou pˇr´ıruˇcku a z´avereˇcnou zpr´avu o pr˚ ubˇehu projektu a jeho v´ ysledc´ıch.
2.7
Pˇ redpoklady a z´ avislosti
Pˇredpokladem k u ´spˇeˇsn´emu splnˇen´ı projektu je z´ısk´an´ı drupalovsk´eho modulu, kter´ y doposud dokumenty zobrazuje s vyuˇzit´ım prohl´ıˇzeˇce IIP Zoom. Dalˇs´ım pˇredpokladem je nalezen´ı nov´eho prohl´ıˇzece, kter´ y bude splˇ novat poˇzadavky zadavatele, a bude pro nˇej moci b´ yt upraven drupalovsk´ y modul. D´elka realizace projektu bude z´avisl´a na komunikaci se zadavatelem a tak´e na vyt´ıˇzenosti ˇclen˚ u t´ ymu ostatn´ımi projekty. Vˇsichni ˇclenov´e t´ ymu totiˇz pracuj´ı bud’ spoleˇcnˇe, nebo indiviu´alnˇe, na nˇekolika dalˇs´ıch, pˇrev´aˇznˇe ˇskoln´ıch projektech.
5
3 3.1 3.1.1
Funkce syst´ emu Zobrazen´ı digitalizovan´ ych sn´ımk˚ u Popis a priorita
Produkt umoˇzn ˇuje zobrazit naskenovan´e archivn´ı dokumenty ve webov´em prohl´ıˇzeˇci, a to i na mobiln´ıch zaˇr´ızen´ıch. Pr´avˇe u ´prava st´avaj´ıc´ıho syst´emu pro lepˇs´ı zobrazov´an´ı naskenovan´ ych archivn´ıch dokument˚ u na mobiln´ıch zaˇr´ızen´ıch, jako jsou tablety a mobiln´ı telefony, je c´ılem projektu. Vzhledem k tomu, ˇze dalˇs´ı funkce poˇzadov´any nejsou, m´a zobrazen´ı digitalizovan´ ych sn´ımk˚ u prim´arn´ı prioritu. 3.1.2
Ud´ alosti a odpovˇ edi
Uˇzivatel si m˚ uˇze skeny dokument˚ u prohl´ıˇzet a zobrazit je. Rovnˇeˇz po stisknut´ı pˇr´ısluˇsn´eho tlaˇc´ıtka m˚ uˇze obr´azek zvˇetˇsit a n´aslednˇe zvˇetˇsen´ y dokument myˇs´ı posouvat.
6
4 4.1
Poˇ zadavky na vnˇ ejˇ s´ı rozhran´ı Uˇ zivatelsk´ a rozhran´ı
Uˇzivatelsk´e rozhran´ı bude m´ıt st´avaj´ıc´ı form´at, jak´ y je moment´alnˇe vyuˇz´ıv´ano na str´ank´ach www.porta-fontium.cz. C´ılem tohoto projektu je pouze zmˇenit prohl´ıˇzeˇc, kter´ y naskenovan´e archivn´ı dokumenty zobrazuje.
4.2
Hardwarov´ a rozhran´ı
Pˇri realizaci tohoto projektu nen´ı nutn´e zach´azet s ˇza´dn´ ym hardwarov´ ym zaˇr´ızen´ım. ˇ Clenov´e t´ ymu pracuj´ı s jiˇz naskenovan´ ymi dokumenty, kter´e maj´ı k dispozici.
4.3
Softwarov´ a rozhran´ı
V´ ysledn´ y modul bude zobrazovat obr´azky z IIP Image Serveru ve form´atu JPEG.
4.4
Komunikaˇ cn´ı rozhran´ı
Produkt bude pouˇz´ıv´an k zobrazov´an´ı naskenovan´ ych archivn´ıch dokument˚ u na webov´em port´alu www.porta-fontium.cz.
7
5
Ostatn´ı poˇ zadavky
Dodatek A: Slovn´ıˇ cek Seznam zkratek pouˇzit´ ych v dokumentu: • ASWI - Pokroˇcil´e softwarov´e inˇzen´ yrstv´ı - pˇredmˇet, v jehoˇz r´amci je projekt realizov´an • SOA - St´atn´ı oblastn´ı archiv - zadavatel projektu • IIP - Internet Imaging Protocol - protokol pro zobrazov´an´ı obr´azk˚ u pˇres internet
8
