Timantti-sovellusprojektin vaatimusmäärittely

Hyväksyjä	Päivämäärä	Nimenselvennys	Allekirjoitus \|
Projektipäällikkö		Miika Kujala
Tilaaja		Vesa Lappalainen
Ohjaaja		Jukka-Pekka Santanen

Tietoa dokumentista

Tekijät:

Miika Kujala (MK), miika.m.kujala@student.jyu.fi
Topi Latva-Salo (TL), topi.h.latva-salo@student.jyu.fi
Tuomas Porvali (TP), thetupo26@gmail.com
Marja Similä (MS), marja.j.k.simila@student.jyu.fi

Dokumentin nimi: Timantti-sovellusprojektin vaatimusmäärittely

Tiedosto: https://tim.jyu.fi/view/kurssit/tie/proj/2017/timantti/dokumentit/vaatimusmaarittely

Tiivistelmä: Timantti-projekti kehitti kevään ja kesän 2017 aikana TIM-järjestelmään dokumenttien tulostustoiminnon. Vaatimusmäärittelyssä kuvataan kehitetyn sovelluksen vaatimuksia, niiden toteutumista, prioriteetteja ja tiloja.

Muutoshistoria

Versio	Päivämäärä	Muutokset	Tekijät
0.5.0	27.8.2017	Dokumentti luotiin.	MK
0.5.1	29.8.2017	Vaatimuksia lisättiin.	MK
1.0.0	23.9.2017	Kirjoitusasua muokattiin.	MK

Tietoa projektista

Timantti-projekti kehittää Jyväskylän yliopiston informaatioteknologian tiedekunnassa kehitettyyn TIM-järjestelmään tulostustoiminnon, joka mahdollistaa yksittäisten dokumenttien tulostamisen sekä koostamisen luentomonisteeksi.

Kehitetyssä sovelluksessa on kaksi osaa, jotka ovat suunnattu erilaisiin tulostustarpeisiin. Kehitetty CSS-tulostus mahdollistaa helpon ja nopean sekä suhteellisen hyvälaatuisen tulosteen saamisen TIM-dokumentista hyödyntäen internet-selaimen omaa tulostustoimintoa. TeX-tulostus puolestaan tähtää painokelpoisen materiaalin tuottamiseen suoraan TIM-järjestelmästä hyödyntäen LaTeX-ladontajärjestelmää.

Tekijät

Kujala Miika (MK), miika.m.kujala@student.jyu.fi
Latva-Salo Topi (TL), topi.h.latva-salo@student.jyu.fi
Porvali Tuomas (TP), thetupo26@gmail.com
Similä Marja (MS), marja.j.k.simila@student.jyu.fi

Tilaajan edustaja

Lappalainen Vesa, vesa.t.lappalainen@jyu.fi

Ohjaajat

Lehtinen Mika, mika.k.lehtinen@student.jyu.fi
Santanen Jukka-Pekka, santanen@mit.jyu.fi

1. Vaatimusten prioriteetit, tilat ja toteutuminen

Dokumentissa vaatimukset on kategorisoitu toimintokokonaisuuksien mukaan. Vaatimusten tilat on kategorisoitu seuraavasti:

Testattu (toteutettu ja testattu),
Toteutettu (ei testattu) ja
Toteuttamatta.

Vaatimusten prioriteetit tärkeimmästä vähiten tärkeään ovat seuraavat:

Välttämätön,
Tärkeä,
Mahdollinen,
Idea ja
Ei toteuteta.

Timantti-projektissa kirjattiin yhteensä 47 vaatimusta tai ideaa. Kaikki Välttämätön, tärkeä ja mahdollinen -prioriteeteilla olleet vaatimukset saatiin toteutettua. Ideaksi jatkokehitykseen kirjattiin yhteensä 15 vaatimusta.

Vaatimuskokonaisuudet Liittännäiset TeX-tulostuksessa ja Käyttöliittymä toteutuivat kokonaan. Vaatimuskokonaisuudet TeX-tulostus, CSS-tulostus ja Tulostusasetukset TeX-tulostuksessa toteutuivat osittain. Vaatimuskokonaisuudet Yleiset ja Advanced CSS eivät toteutuneet lainkaan.

2. Vaatimukset ja niiden toteutuminen

2.1 TeX-tulostus

Vaatimus	Prioriteetti	Tila
PDF:ksi käännetty dokumentti tulee avautua selaimessa uuteen välilehteen.	Välttämätön	Testattu
Tulostettavan dokumentin markdown tulee muuntaa palvelimella LaTeX-muotoon.	Välttämätön	Testattu
Tulostettavaan dokumenttiin tulee halutessaan saada kansilehti ja sisällysluettelo.	Välttämätön	Testattu
Dokumentista luotu PDF tallennetaan TIMiin.	Välttämätön	Testattu
Tulostettavaan dokumenttiin voi luoda omia lohkokohtaisia tyylejä.	Tärkeä	Testattu
TIM-dokumenttiin tulee voida lisätä sisältöä, joka näkyy vain TIMissä, mutta ei tulostettavassa dokumentissa.	Mahdollinen	Testattu
TIM-dokumenttiin tulee voida lisätä sisältöä, joka näkyy vain tulostettavassa dokumentissa.	Mahdollinen	Toteutettu
TIM-dokumenttiin tulee voida lisätä tyylejä, jotka vaikuttavat ainoastaan TeX-muotoiseen tulostukseen.	Mahdollinen	Toteutettu
Taulukolle tulee piirtyä viivat tulostuksessa.	Idea	Toteutettu
Lainattuja kappaleita sisältävän dokumentin muutosten tunnistaminen.	Idea	Toteutettu
Tulostamiselle tulee olla olemassa "whitelist", johon voi kirjata URLeja, joista tulostettava dokumentti saa käydä lataamassa kuvat tulosteeseen liitettäviksi.	Idea	Toteutettu
Parametrilla voi vaatia tulostustoimintoa tuhoamaan dokumentin kuvacachen (tulostustoiminnon lataamien kuvien cache).	Idea	Toteutettu
Käyttäjällä tulee olla mahdollisuus muuttaa templatessa asetusten arvoja omaa tulostustaan varten.	Idea	Toteuttamatta
Visible-print-tyyli tulee voida "mitätöidä" edit-tilassa.	Idea	Toteuttamatta
Plugineilla tulee olla reitti, josta tulostustoiminto voisi käydä kysymässä, mitä makroja plugin haluaa templateen ladattavan.	Idea	Toteuttamatta
Tulostustoiminnon tulee tukea täyttä unicodea.	Idea	Toteuttamatta
Tulostustoiminnon tulee antaa kerralla kaikki dokumentin käännöksessä syntyneet virheet. Käännöksen ei siis tule pysähtyä heti ensimmäiseen virheeseen.	Idea	Toteuttamatta
Tim huolehtii dokumenttien poistamisesta (tarkennettava).	Idea	Toteuttamatta
CSS-tulostusta varten luodun page break -elementin tulisi vaikuttaa myös TeX-tulostukseen (tarvitaanko).	Idea	Toteuttamatta

2.2 Liitännäiset TeX-tulostuksessa

Vaatimus	Prioriteetti	Tila
Pluginin tulee antaa itsestään oletustulostusmuoto markdown-muodossa.	Välttämätön	Testattu
Plugin-kappaleeseen tulee voida määritellä, miten pluginin halutaan tulostuvan.	Tärkeä	Testattu
Plugineista voidaan tulostaa joko pluginin oletustuloste, tai uusin käyttäjän pluginissa ajama koodi.	Mahdollinen	Testattu
Pluginin tilalle tulee voida lisätä tulostettava kuva.	Idea	Testattu

2.3 CSS-tulostus

Vaatimus	Prioriteetti	Tila
Tulostuksen tulee käyttää selaimen omaa tulostustoimintoa.	Välttämätön	Testattu
Linkin URL:in tulee tulostua vain kerran.	Tärkeä	Testattu
Käyttäjän tulee voida halutessaan tulostaa dokumenttiin kirjoitetut kommentit.	Tärkeä	Testattu
Tulostettavaan dokumenttiin tulee voida lisätä manuaalinen sivunvaihto.	Mahdollinen	Testattu
Tulostuksen tulee pakottaa sivunvaihto ennen sivun loppuun sijouttuvaa lukuotsikkoa.	Mahdollinen	Testattu
Tulostuksessa tulee voida vaihtaa tekstien värejä.	Idea	Toteuttamatta
Arean sivunvaihdon esto (tarkennettava).	Idea	Toteuttamatta

2.4 Käyttöliittymä

Vaatimus	Prioriteetti	Tila
TIMin käyttöliittymään tulee lisätä painike, josta tulostustoiminnon voi käynnistää.	Välttämätön	Testattu
Käyttöohjeen tulee olla TIMissä saatavilla.	Välttämätön	Testattu
Käyttöliittymään tulee lisätä tulostusasetusikkuna.	Välttämätön	Testattu
Virheilmoitusten tulee näkyä käyttäjälle.	Tärkeä	Testattu
Tulostusdialogi muistaa käyttäjän aiemmin valitseman templaten ja se on valittuna seuraavan kerran, kun dialogi avataan uudelleen.	Idea	Testattu
Käyttöliittymässä tulee voida valita tulostuksen kohdetiedostomuoto.	Idea	Testattu
Pandoc tulee voida pakottaa tekemään uuden version kohdetiedostosta.	Idea	Toteutettu

2.5 Yleiset

Vaatimus	Prioriteetti	Tila
Kohdetiedoston lainatussa kappaleessa tulee näkyä merkintä tekijästä ja lähteestä.	Idea	Toteuttamatta
Toiselle kielelle käännetyn dokumentin tulostaminen (tarkennettava).	Idea	Toteuttamatta

2.6 Tulostustusasetukset TeX-tulostuksessa

Vaatimus	Prioriteetti	Tila
LaTeX-tulostusasetukset määritellään TIM-dokumentissa.	Välttämätön	Testattu
Dokumentin ulkoasua tulee voida muokata makroilla.	Mahdollinen	Testattu
Tulostusasetukset tulee voida hakea erillisestä TIM-dokumentista.	Mahdollinen	Testattu
Dokumenttikohtaiset tulostusasetukset tulee voida tallentaa TIMiin.	Idea	Toteutettu
Henkilökohtaiset tulostusasetukset tulee voida tallentaa TIMiin.	Idea	Toteuttamatta
Tulostuksessa tulee voida käyttää eri fontteja.	Idea	Toteuttamatta

2.7 Advanced CSS

Vaatimus	Prioriteetti	Tila
Automaattinen kuvien muodostaminen dokumenttikohtaisesti (tarkennettava).	Idea	Toteuttamatta
Käyttäjän tulee voida pyytää pluginien automaattisen ajon (tarkennettava).	Idea	Toteuttamatta