DOKUMENT SPECIFIKACE POŽADAVKŮ. digitalizovaných dokumentů

Transkript

1 DOKUMENT SPECIFIKACE POŽADAVKŮ Inovace modulu pro prohĺıžení snímků digitalizovaných dokumentů 10. dubna 2014 Tým: Členové: Michal Kacerovský David Hrbáček Ondřej Kupilík Marek Naggy null

2 Obsah 1 Úvod Předmět specifikace Cílové publikum, návod ke čtení Rozsah projektu Odkazy Obecný popis Kontext systému Funkce produktu Třídy uživatelů Provozní prostředí Omezení návrhu a implementace Uživatelská dokumentace Předpoklady a závislosti Funkce systému Zobrazení digitalizovaných snímků Popis a priorita Události a odpovědi Požadavky na vnější rozhraní Uživatelská rozhraní Hardwarová rozhraní Softwarová rozhraní Komunikační rozhraní Další parametrické požadavky Výkonnostní požadavky Bezpečnostní požadavky Kvalitativní parametry Ostatní požadavky 8 Revize dokumentu Datum verze Poznámka Autor 10. dubna výchozí verze Ondřej Kupilík

3 1 Úvod 1.1 Předmět specifikace Tato specifikace se zabývá požadavky na softwarový produkt, kterým je inovace modulu pro prohlížení snímků digitalizovaných dokumentů. Cílem je nahrazení stávajícího prohlížeče IIPZoom založeným na technologii Flash za jiný prohlížeč založený na technologii HTML 5. Výsledný inovovaný modul bude sloužit pro zobrazování archivních dokumentů na webovém portálu který společně s dalšími partnery provozuje Státní oblastní archiv v Plzni (dále jen SOA). 1.2 Cílové publikum, návod ke čtení Dokument specifikace požadavků je určen následujícím čtenářům: Bc. Michal Kacerovský, vedoucí týmu Bc. David Hrbáček, člen týmu Bc. Marek Naggy, člen týmu Bc. Ondřej Kupilík, člen týmu Bc. Petr Kocourek, zadavatel projektu za SOA Ing. Lukáš Holý, cvičící předmětu ASWI Doc. Ing. Přemysl Brada, MSc. PhD., přednášející předmětu ASWI 1.3 Rozsah projektu Rozsah a účel projektu jsou podrobně popsány v dokumentu Vize projektu, který je k dispozici v kapitole Odkazy 1.4 Odkazy Bc. Michal Kacerovský, Dokument vize projektu, wiki/uploads/aswi2014null/vize.pdf Webový portál přeshraniční spolupráce Porta Fontium 3

4 2 Obecný popis 2.1 Kontext systému Cílem tohoto projektu je nahrazení prohlížeče snímků zpracovaných IIP Image Serverem. Na webovém portálu momentálně zobrazuje digitalizované snímky prohlížeč IIP Zoom založený na Flash, který je pro zadvatele projektu nevyhovující především kvůli špatnému zobrazování na mobilních zařízeních. Flash objekty totiž nejsou např. na tabletech podporovány. Nový prohlížeč, který bude vybrán členy realizačního týmu, by měl být založený na technologii HTML 5, která je na mobilních zařízeních podporována. Webový portál je přeshraničním projektem, na kterém se za českou stranu podílí SOA Plzeň a za německou stranu Generální ředitelství státních bavorských archivů v Mnichově. Cílem projektu je znovu spojit archivní fondy, které byly v minulosti násilně roztržené, do jednoho virtuálního celku. 2.2 Funkce produktu Hlavní funkcí produktu je zobrazení skenů archivních dokumentů uživateli na webovém portálu. Vylepšením oproti stávající verzi prohlížeče by mělo být lepší zobrazení na mobilních zařízeních (tablety, mobilní telefony). Uživatel by měl mít možnost jednotlivé skeny přibližovat a přiblížený výběr posouvat. Správci by měl produkt umožnit nahrát nové skeny na IIP Server a měnit nastavení modulu. 2.3 Třídy uživatelů Uživatelé produktu mohou mít následující role: nepřihlášený uživatel přihlášený uživatel správce 2.4 Provozní prostředí V následujícím seznamu budou krátce představeny všechna prostředí, která jsou s realizací projektu spojená: IIP Zoom - prohlížeč obrázků používaný doposud, založený na technologii Flash jeden z prohlížečů pro zobrazování obrázků z IIPI Serveru založený na HTML 5 - IIP Moo Viewer, Diva.js, OpenSeadragon, OpenLayers Zoomify - javascriptové pluginy sloužící k načítání velkoformátových obrázkových souborů IIP Image Server - server, který převádí zdrojová data uložená v pyramidové struktuře na dlaždice ve formátu JPEG 4

5 CMS Drupal 7 - volně dostupný softwarový balík, který lze v administračním rozhraní volně instalovat a následně používat v šablonách stránek Memcache a Varnish - cache používané na IIPI Serveru webový portál Porta Fontium - web, na kterém budou výsledným modulem naskenované dokumenty zobrazovány 2.5 Omezení návrhu a implementace Omezení návrhu a implementace jsou popsány v dokumentu Vize projektu, kapitola 6 Rizika projektu. 2.6 Uživatelská dokumentace K projektu bude vypracována uživatelská dokumentace zahrnující programátorský manuál, uživatelskou příručku a záverečnou zprávu o průběhu projektu a jeho výsledcích. 2.7 Předpoklady a závislosti Předpokladem k úspěšnému splnění projektu je získání drupalovského modulu, který doposud dokumenty zobrazuje s využitím prohlížeče IIP Zoom. Dalším předpokladem je nalezení nového prohlížece, který bude splňovat požadavky zadavatele, a bude pro něj moci být upraven drupalovský modul. Délka realizace projektu bude závislá na komunikaci se zadavatelem a také na vytíženosti členů týmu ostatními projekty. Všichni členové týmu totiž pracují bud společně, nebo indiviuálně, na několika dalších, převážně školních projektech. 5

6 3 Funkce systému 3.1 Zobrazení digitalizovaných snímků Popis a priorita Produkt umožňuje zobrazit naskenované archivní dokumenty ve webovém prohlížeči, a to i na mobilních zařízeních. Právě úprava stávajícího systému pro lepší zobrazování naskenovaných archivních dokumentů na mobilních zařízeních, jako jsou tablety a mobilní telefony, je cílem projektu. Vzhledem k tomu, že další funkce požadovány nejsou, má zobrazení digitalizovaných snímků primární prioritu Události a odpovědi Uživatel si může skeny dokumentů prohlížet a zobrazit je. Rovněž po stisknutí příslušného tlačítka může obrázek zvětšit a následně zvětšený dokument myší posouvat. 6

7 4 Požadavky na vnější rozhraní 4.1 Uživatelská rozhraní Uživatelské rozhraní bude mít stávající formát, jaký je momentálně využíváno na stránkách Cílem tohoto projektu je pouze změnit prohlížeč, který naskenované archivní dokumenty zobrazuje. 4.2 Hardwarová rozhraní Při realizaci tohoto projektu není nutné zacházet s žádným hardwarovým zařízením. Členové týmu pracují s již naskenovanými dokumenty, které mají k dispozici. 4.3 Softwarová rozhraní Výsledný modul bude zobrazovat obrázky z IIP Image Serveru ve formátu JPEG. 4.4 Komunikační rozhraní Produkt bude používán k zobrazování naskenovaných archivních dokumentů na webovém portálu 7

8 5 Ostatní požadavky Dodatek A: Slovníček Seznam zkratek použitých v dokumentu: ASWI - Pokročilé softwarové inženýrství - předmět, v jehož rámci je projekt realizován SOA - Státní oblastní archiv - zadavatel projektu IIP - Internet Imaging Protocol - protokol pro zobrazování obrázků přes internet 8