Suunnitteludokumentti Mooan

Transkriptio

1 Suunnitteludokumentti Mooan Helsinki Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos

2 Kurssi Ohjelmistotuotantoprojekti (9+1op/6ov) Projektiryhmä Heikki Aitakangas Mika Holmström Kirsi Jokisalo Anni Kotilainen (keskeyttänyt) Esko Lehtonen Paula Urpilainen Ohjaaja Ilari Moilanen Asiakas Sami Palhomaa Johtoryhmä Juha Taina Kotisivu

3 Sisällysluettelo 1. Johdanto Sanasto Aikataulu Arkkitehtuurisuunnittelu Rajapintasuunnittelu Käyttöliittymän tarjoamat palvelut käyttäjälle Käsittelyosan tarjoamat palvelut käyttöliittymälle MooanDB:n tarjoamat palvelut käsittelyosalle Annotean tarjoamat palvelut käsittelyosalle Moodlen tarjoamat palvelut käsittelyosalle Komponenttisuunnittelu Käyttöliittymä Käsittelyosa mooan_db Käyttöliittymäsuunnittelu Lukeminen ja selaus Kommentin ja viestin lisääminen Kommentin muokkaus ja poisto Virhetilanteet Kommentoinnin kytkeminen päälle ja pois Tulostaminen Ohjeikkuna Jatkokehitysmahdollisuudet Verifiointi ja validointi...51

4

5 1. Johdanto Kesän 2006 yksi ohjelmistotuotantoprojekteista on Mooan, annotointityökalu Moodleoppimisalustalle. Pohjana projektilla on Annoprojekti, joka valmistui joulukuussa 2005, mutta jota täytyisi nyt jatkokehittää isoin askelin eteenpäin. Kartoitamme yhdessä asiakkaan kanssa mikä Annossa oli hyvää ja mikä huonoa, ja tämän pohjalta alamme työstämään uuttaa ratkaisua. Avain sanoja tulevat olemaan tietoturva, käyttöliittymä ja testaus. Tässä suunnitteludokumentissa on projektin kuvaus eri abstraktiotasoilla. Suunnittelun vaiheet aikajärjestyksessä ovat arkkitehtuurisuunnittelu, abstrakti määrittely, rajapintasuunnittelu ja komponenttisuunnittelu Sanasto Dokumentissa on käytetty projektin edetessä muodostunutta sanastoa. Osa sanoista poikkeaa vaatimusdokumentin sanastosta. Moodle Oppimisalusta, jota käytetään mm. Tietojenkäsittelytieteen laitoksen kursseilla. Moodle tallentaa kurssikohtaisesti dokumentteja. Mooan Moodlen lisäosa, toteuttaa annotointiominaisuuden Moodleen. Kommenttinäkymä Tooltiptyyppinen ikkuna jossa kommentteja ja viestejä voi selailla (vaatimusdokumentissa nimellä näkymäikkuna). Kommenttivalikko Kommenttikategorian valitsemiseen tarkoitettu valikko. Muokkausnäkymä Sivun alalaitaan avautuva kommenttien ja viestien selaamiseen ja kirjoittamiseen varattu tila (vaatimusdokumentissa nimellä muokkausikkuna). Annotea Annoteapalvelin tallentaa kommentit ja viestit sekä niihin liittyvät tiedot Annotoida Kommentoida Annotointi Kommentointi Annotaatio Kommentti HtmlMooansivu Moodlesta saatu htmlsivu, jota Mooan on muokannut. Kommentti Dokumentin tiettyyn kohtaan tehty itsenäinen kommentti. Viesti Kommenttiin tai viestiin vastauksena tehty kommentti. 1

6 2. Aikataulu Projektin suunnitteluvaihe alkaa 5.6. ja suunnitteludokumentti tavoitteellinen valmistumisaika on vko tiistai torstai Suunnittelu alkaa Arkkitehtuurisuunnittelu alkaa Arkkitehtuurisuunnittelu Käyttöliittymäsuunnittelu alkaa Arkkitehtuurisuunnittelu valmis Käyttöliittymäsuunnittelu Rajapintasuunnittelu alkaa Käyttöliittymädemo asiakkaalle Rajapintasuunnittelu Käyttöliittymäsuunnittelu Rajapintasuunnittelu Komponenttisuunnittelu alkaa Komponenttisuunnittelu Käyttöliittymäsuunnittelu Suunnitteludokumentin alustava versio valmis Käyttöliittymäsuunnittelu valmis Rajapintasuunnittelu valmis Komponenttisuunnittelu Komponenttisuunnittelu valmis Tarkastus: suunnitteludokumentti Dokumentin korjailu Suunnitteludokumentti valmis 2

7 3. Arkkitehtuurisuunnittelu Järjestelmäarkkitehtuuri Mooan on annotointityökalu, joka toimii Moodleoppimisalustan lisäosana. Se kommunikoi käyttäjän, Moodlen, Annoteapalvelimen sekä Moodlen välityksellä oman tietokannan, MooanDB:n, kanssa. Mooan koostuu kahdesta osajärjestelmästä, joista toinen toimii selaimessa ja toinen palvelimella. Selaimessa toimiva käyttöliittymä toimii käyttäjän rajapintana. Se on toteutettu JavaScriptillä. Se käsittelee käyttäjän pyynnöt ja välittää ne edelleen logiikkakerrokselle. Se myös muotoilee käsittelyosan muodostamaan HTMLsivua ja huolehtii kommenttien ja kontrollien lisäämisestä sivulle. Moodlessa toimiva osajärjestelmä, käsittelyosa, on toteutettu PHP:lla. Se käsittelee käyttöliittymän HTTPpyynnöt, tarkistaa käyttäjän oikeudet, muodostaa vastaukset ja kommunikoi ulkoisten palvelujen sekä Moodlen kanssa. Käsittelyosa käyttää kolmea ulkoista palvelua tietojen tallentamiseen. Moodlesta käsittelyosa hakee dokumentin ja tarkistaa käyttäjän oikeudet. Annoteasta käsittelyosa hakee dokumenttiin liittyvät kommentit ja niihin vastauksena saadut viestit. MooanDB:sta käsittelyosa hakee kommentteihin ja viesteihin liittyviä lisätietoja. 3

8 4. Rajapintasuunnittelu 4.1. Käyttöliittymän tarjoamat palvelut käyttäjälle Käyttäjän ja käyttöliittymän rajapinta Käyttöliittymä toteutetaan selaimen näyttämänä htmlsivuna, jossa on JavaScriptillä toteutettuja palveluja. Näitä on kahdenlaisia: osa toimii paikallisesti selaimessa, osa lähettää HTTPpyynnön käsittelykerrokselle. na käyttäjälle voidaan pitää sivun näkymän muuttumista tai esim. muokkausnäkymän sulkeutumista. Tällöin virheilmoituksen puute kertoo käyttäjälle toiminnon onnistumisesta. Tämä rajapinta siis kuvaa mitä tapahtuu kun käyttäjä klikkaa jotakin nappulaa tai linkkiä sivulla: tapahtumat eli muutokset sivulla ovat käyttöliittymän käyttäjälle tarjoamia palveluita. Kaikille palveluille yhteinen poikkeustilanne: käyttäjä 1 kytkee annotointiominaisuuden pois päältä samaan aikaan kun käyttäjä 2 käyttää toista annotointipalvelua. Tällöin käyttäjälle 2 näytetään virheilmoitus. Esimerkkitoiminto Mitä palvelu tekee. Miten käyttäjä kutsuu palvelua Mitä parametreja käyttäjä antaa. Miten käyttäjä näkee toiminnon onnistumisen Muut vaikutukset Esim. sivun lataaminen uudestaan Mitä poikkeustilanteita voi sattua ja miten niihin reagoidaan Kommenttivalikon avaaminen Palvelu avaa kommentointivalikon, jossa on kommenttikategorian valintapainikkeet. Palvelun laukaisee tekstialueen maalaaminen. Kommentointivalikko aukeaa Muut vaikutukset 4

9 Kommenttikategorian valitseminen Palvelu määrittää lisättävän uuden kommentin kategorian. Käyttäjä valitsee kategorian painamalla kommentointivalikon painiketta. Muut vaikutukset Muokkausnäkymä aukeaa. Tekstikentän yläpuolella lukee Kirjoita uusi sisältö/kielioppikommentti sen mukaan, minkä kategorian käyttäjä valitsi. Tekstikentän alapuolella on Julkaise painike. Kommentointivalikko sulkeutuu. Valittu tekstialue korostetaan keltaisella Kommenttinäkymän avaaminen Käyttäjä avaa kommenttinäkymän viemällä hiiren kommentoidun tekstialueen päälle. Kommenttinäkymän koko riippuu fonttikoosta, se on n. 15 riviä korkea. Kommentoidun tekstialueen viereen avautuu kommenttinäkymä, joka sisältää kommentin ja viestit. Muut vaikutukset Pääl lekkäisistä kommenteista valitseminen Palvelu määrittää, mikä päällekkäisistä kommenteista avataan kommenttinäkymään. Käyttäjä vie hiiren kommentoituun kohtaan. Aukeaa dialogi, jossa on alku kaikista päällekkäistä kommenteista. Käyttäjä valitsee haluamansa kommentin viemällä hiiren kyseisen kommentin alun päälle. Kommentoidun tekstialueen viereen avautuu kommenttinäkymä, joka sisältää kommentin ja viestit. Muut vaikutukset Kaikki kommentit sisältävän ikkunan avaaminen Käyttäjä avaa kaikki kommentit sisältävän ikkunan klikkaamalla sivun ylälaidan painiketta. Kaikki kommentit sisältävä ikkuna avataan. Muut vaikutukset Kaikki kommentit visualisoidaan luetuiksi, kun ikkuna avataan Tulostusikkunan avaaminen Käyttäjä avaa tulostusikkunan klikkaamalla sivun ylälaidan painiketta. Kommentit tulostetaan numeroituna dokumentin loppuun Tulostusikkuna avataan. Muut vaikutukset 5

10 Muokkausnäkymän avaaminen Sivun alalaitaan avataan muokkausnäkymä, jossa on vain kommentit viesteineen, jos käyttäjä avasi muokkausnäkymän kommenttinäkymän suurenna painikkeesta. Lisäksi siinä voi olla: kommenttiin vastaamiseen varattu tekstikenttä, jos palvelua kutsutaan kommenttinäkymän kommentin vastaa linkistä kommentin muokkaamiseen varattu tekstikenttä, jossa muokattava kommentti on valmiina, jos palvelua kutsutaan kommenttinäkymän kommentin muokkaa linkistä Muokkausnäkymässä on vain uuden kommentin kirjoittamiseen varattu tekstikenttä, jos palvelua kutsutaan kommenttikategorian valintapainikkeella. kommenttikategoria : string, jos lisätään uusi kommentti kommentti id tai viesti id : string, jos vastataan tai muokataan kommenttia kommentin tai viestin sisältö : string, jos muokataan kommenttia Sivun alalaitaan aukeaa muokkausnäkymä kommentteineen ja tekstikenttineen Muut vaikutukset Kommenttinäkymä ja kommentointilaatikko sulkeutuvat Tekstikentän avaaminen muokkausnäkymään Muokkausnäkymän oikeaan laitaan aukeaa kommenttiin vastaamiseen tai muokkaamiseen tarkoitettu tekstikenttä. Käyttäjä kutsuu palvelua klikkaamalla muokkausnäkymässä auki olevan kommentin vastaa tai muokkaa linkkiä. kommentti id tai viesti id : string kommentin tai viestin sisältö : string, jos muokataan kommenttia Muokkausnäkymään aukeaa tekstikenttä. Muut vaikutukset Muokkausnäkymässä oleva kommenttinäkymä kapenee vasempaan laitaan Sivun näyttämi nen kommentteineen (Sivun avaus) Palvelu näyttää dokumentin, jossa kommentit on visualisoitu tekstiin väreillä. Dokumentin avaus laukaisee palvelun, samoin kommentin tai viestin lisääminen, muokkaus ja poistaminen. HtmlMooansivu, dokumenttiin tehdyt kommentit visualisoituna Muut vaikutukset Annotoinnin kytky pääl le/pois Palvelu kytkee annotointitoiminnon kyseiseen dokumenttiin tai poistaa ominaisuuden dokumentista. Käyttäjä, jolla on oikeudet toimintoon, voi kutsua palvelua sivun ylälaidan painiketta klikkaamalla. 6

11 Käyttäjälle, jolla ei ole oikeutta säätää annotointia, sivun yläreunassa lukee Kommentointi: käytössä, mikäli annotointi on päällä. Jos annotointi ei ole käytössä, siitä ei ilmoiteta mitään. Käyttäjälle, joka voi kytkeä annotoinnin päälle/pois, sivun yläreunassa näkyy kaksi radiopainiketta, joista toinen on aina valittu sen mukaan onko annointi tällä hetkellä päällä vai ei. Teksti on maalattu vihreällä jos annotointi on käytössä, muuten punaisella. Sivu ladataan uudestaan Uuden kommentin tallentaminen Lisätään käyttäjän tekemä kommentti dokumenttiin. Palvelua kutsutaan muokkausnäkymän painikkeella Julkaise. kommenttikategoria : string kommentin sisältö : string kommentin paikka : Xpointer Muokkausnäkymä sulkeutuu. Onnistunut lisäys näkyy dokumentissa luettuna kommenttina kategorian mukaisella värityksellä. Sivu ladataan uudestaan. Kommentti näkyy muille käyttäjille uutena kommenttina. Dokumenttia on muokattu dokumentin avaamisen ja kommentin lisäämisen välillä, annetaan virheilmoitus Kommentin tai viestin muokkauksen tallentaminen Tallennetaan käyttäjän tekemä muokkaus viestiin tai kommenttiin. Käyttäjä kutsuu palvelua muokkausnäkymän hyväksy muokkaus painikkeella. kommentin tai viestin sisältö : string Tekstikenttä sulkeutuu, muokkausnäkymään avautuu kommenttinäkymä, jossa myös muokattu kommentti näkyy. Kommentti visualisoidaan muille käyttäjille uutena kommenttina. Sivu ladataan uudestaan. Kommentti tai viesti on poistettu dokumentin avaamisen jälkeen tai kommenttiin on vastattu, sitä ei voi enää muokata Kommentin poisto Tavallinen käyttäjä ei voi poistaa kommenttia, mikäli siihen on vastattu. Ylläpitäjä voi sen tehdä, tällöin kysytään varmistus. Kaikki kommenttiin liittyvät viestit poistetetaan samalla. Dokumentista poistetaan kommentti. Käyttäjä kutsuu palvelua klikkaamalla poista linkkiä kommenttinäkymässä tai muokkausnäkymässä. kommentin id : string Muokkausnäkymä/kommenttinäkymä sulkeutuu. Kommentin visualisointi dokumentista poistuu. Sivu ladataan uudestaan. Kommenttiin liittyvä keskustelu poistuu. Jos kommenttiin on vastattu, kysytään käyttäjältä varmistus popupilla Viestin poisto Tavallinen käyttäjä ei voi poista viestiä, mikäli siihen on vastattu. Ylläpitäjä voi sen tehdä, tällöin kysytään varmistus. Kaikki viestiin liittyvät vastausviestit poistetetaan samalla. Dokumentista poistetaan viesti. Käyttäjä kutsuu palvelua klikkaamalla poista linkkiä kommenttinäkymässä tai muokkausnäkymässä. kommentti id : string viesti id : string 7

12 Muokkausnäkymässä/kommenttinäkymässä näytetään keskustelu ilman poistettua viestiä. Sivu ladataan uudestaan. Viestiin liittyvä keskustelu poistuu. Jos viestiin on vastattu, kysytään käyttäjältä varmistus popupilla Kommenttiin tai viestiin tehdyn vastauksen tallentaminen Kommenttiin tai viestiin kirjoitettu vastaus tallennetaan. Käyttäjä kutsuu palvelua klikkaamalla lähetä vastaus painiketta muokkausnäkymässä. kommentti id : string tai viesti id : string vastauksen sisältö : string, jos vastataan viestiin Tekstikenttä sulkeutuu. Muokkausnäkymään avautuu kommenttinäkymä, jossa myös uusi viesti näkyy. Sivu ladataan uudestaan. Kommentin visualisointi muuttuu uudeksi kommentiksi muille käyttäjille kommentti tai viesti on poistettu dokumentin avaamisen jälkeen tai kommenttiin on vastattu, sitä ei voi enää muokata Kommenttinäkymän sulkeminen Käyttäjä sulkee kommenttinäkymän viemällä hiiren pois sen päältä. kommentti id: string Kommentin visualisointi muuttuu luetuksi, mikäli kommenttinäkymä oli auki yli sekunnin. Visualisointia ei voi muuttaa, jos kommentti on sivun lataamisen ja muokkausnäkymän avaamisen välillä poistettu Muokkausnäkymän sulkeminen Käyttäjä sulkee muokkausnäkymän klikkaamalla sulje linkkiä, painamalla lisää uusi kommentti painiketta tai klikkaamalla poista painiketta. Jos kommenttiin ei liity vastauksia, ja kommentti poistetaan, niin muokkausnäkymä suljetaan. (Viestin poistamisen yhteydessä muokkausnäkymää ei suljeta.) Muokkausnäkymä suljetaan myös, jos käyttäjä navigoi kokonaan pois sivulta. kommentti id : string Kommentti visualisoidaan luetuksi Käyttäjä on sulkemassa muokkausnäkymää ennen kuin on tallentanut kommenttinsa/viestinsä. Tällöin käyttäjältä kysytään, haluaako tallentaa. Käsittelyosan tarjoamat palvelut käyttöliittymälle Käsittelyosa tarjoaa käyttöliittymälle palveluita tiedon tallentamiseen. Käyttöliittymän palvelut, jotka vaativat tallentamista, kuten esimerkiksi viestin poisto tai kommentin muokkaus, kutsuvat käsittelyosan palveluita. Käsittelyosassa tiedot viedään tietokantoihin ja saadun vastauksen mukaan muodostetaan paluuviesti. Paluuviesti lähetetään käyttöliittymälle HTMLsivuna. Yhteinen poikkeustilanne: annotointiominaisuus kytketään pois päältä samaan aikaan kun toinen käyttäjä käyttää toista annotointipalvelua. Tällöin käyttöliittymälle palautetaan virheilmoitus. 8

13 Käyttöliittymän ja käsittelyosan rajapinta Esimerkkipalvelu Palvelun kutsuminen, mitä palvelu tekee, (minkä ulkoisen rajapinnan kanssa palvelu kommunikoi) Mitä parametreja palvelu saa käyttöliittymältä Mitä palvelu palauttaa käyttöliittymälle (esim. htmlsivun) Muut vaikutukset Mitä muuta tapahtuu Mitä poikkeustilanteita voi sattua ja miten niihin reagoidaan Sivun näyttämi nen kommentteineen (Sivun avaus) Käyttöliittymä kutsuu palvelua sivun avaamisen ja uudelleenlataamisen yhteydessä. Palvelu muodostaa tietokannoista haettujen tietojen perusteella htmlsivun, jossa kommentit on visualisoitu käyttäjähistorian ja käyttäjän oikeuksien mukaisesti. (Palvelu hakee dokumentin Moodlesta, kommentit Annoteasta ja käyttäjähistorian MooanDB:sta.) HtmlMooansivu. Dokumenttiin tehdyt kommentit visualisoituna, jos annotointi päällä. Muut vaikutukset Annotoinnin kytky pääl le/pois Palvelu kytkee annotointitoiminnon kyseiseen dokumenttiin tai poistaa ominaisuuden dokumentista. (Tieto kirjataan MooanDB:en.) HtmlMooansivu (dokumenttiin tehdyt kommentit visualisoituna, jos annotointi päällä). 9

14 Kommentin lisäys Lisää kommentin dokumenttiin. (Kommentti tallennetaan Annoteapalvelimelle ja merkitään luetuksi MooanDB:en. ) kommenttikategoria : string kommentin sisältö : string luontiaika (aika ja päiväys) : date, time kommentin paikka : Xpointer Käyttöliittymälle palautetaan htmlsivu, johon kommentti on lisätty Dokumenttia on muokattu dokumentin avaamisen ja kommentin lisäämisen välillä, annetaan virheilmoitus Kommentin tai viestin muokkaus Muokattu kommentti tai viesti tallennetaan. (Kommentti tai viesti tallennetaan Annoteapalvelimelle ja merkitään luetuksi MooanDB:en.) kommentti id : string viesti id : string, (jos muokataan viestiä) viestin sisältö : string muokkausaika : date, time Käyttöliittymälle palautetaan htmlsivu, jossa muokattu kommentti on. Kommentti tai viesti on poistettu dokumentin avaamisen jälkeen tai kommenttiin on vastattu, sitä ei voi enää muokata. Annetaan virheilmoitus Kommentin poisto Palvelu poistaa kommentin ja siihen liittyvät viestit (Annoteapalvelimelta, sekä kommenttiin liittyvän käyttäjähistorian MooanDB:sta.) dokumentti id, kommentti id ja/tai viesti id Käyttöliittymälle palautetaan päivitetty htmlsivu, josta kommentin visualisointi on poistettu Kommenttiin tai viestiin vastaaminen Viesti tallennetaan (Annoteapalvelimelle ja lisätään kommenttipuuhun. Viesti merkitään luetuksi MooanDB:en.) kommentti id : string viesti id : string, (jos vastataan viestiin) vastauksen sisältö: string vastausaika (aika ja päiväys) : date, time Käyttöliittymälle palautetaan päivitetty htmlsivu, johon viesti on lisätty. Kommentti tai viesti on poistettu dokumentin avaamisen jälkeen tai kommenttiin on vastattu, sitä ei voi enää muokata. Annetaan virheilmoitus. 10

15 Merkitseminen luetuksi Merkitsee kommentin tai viestin luetuksi. kommenttinäkymän, muokkausnäkymän tai kaikki kommentit sisältävän näkymän sulkeminen kutsuu palvelua. (Lukuhetki tallennetaan MooanDB:en. ) kommentti id: string avausaika: (aika ja päiväys) : date, time (=luettu) Lukuhetkeä ei voi lisätä tietokantaan, jos kommentti on välillä poistettu. Annetaan virheilmoitus MooanDB:n tarjoamat palvelut käsittelyosalle Käsittelyosan ja MooanDB:n rajapinta Mooanmoduuli käyttää MooanDB:ta tallentamaan tietoja, joita ei voida tallentaa Annotearajapinnan kautta. Tällaisia tietoja ovat käyttäjien lukuhistoria sekä dokumenttien annotointioikeudet. Käyttäjän avatessa kommentin näkymäikkunaan kommentti merkitään luetuksi pienen viiveen kuluttua (1 sekunti). Samoin menetellään kuitenkin ilman viivettä, jos kommentti avataan muokkausnäkymässä. Käyttöliittymäkerros välittää tiedon luetuista kommenteista käsittelyosalle, joka tallentaa tietokantaan tiedon siitä, että käyttäjä on lukenut kommentin. Käyttäjän ladatessa dokumentin selaimeensa ladataan samalla Annotearajapinnan kautta kaikki dokumentin kommentit. Käsittelyosa vertaa kommenttien ja viestien luonti ja muokkausaikoja käyttäjän lukuhistoriaan. Näin voidaan päätellä, mitkä kommentit ovat käyttäjälle uusia ja mihin kommenttiin on tullut sellaisia viestejä, joita käyttäjä ei ole vielä voinut lukea. Kommentteja poistettaessa poistetaan myös kommenttia koskeva käyttäjähistoria. 11

16 Esimerkkipalvelu Mitä palvelu tekee Mitä parametreja palvelu saa käsittelyosalta Mitä palvelu palauttaa käsittelyosalle Mitä tietokannassa tapahtuu. Mitä poikkeustilanteita voi sattua Merkitse luetuksi Merkitsee kommentin ensimmäistä kertaa luetuksi tietylle käyttäjälle tiettyyn aikaan. käyttäjä id : string kommentti id : string lukuhetki : date, time Tietokantaan tallennetaan uusi tietue, jossa kommentti merkitään luetuksi. 1) Ei yhteyttä tietokantaan. 2) Koetetaan tallentaa samalle (kommentti id, käyttäjä id) parille kahta tietuetta Päivitä lukuhetki Päivittää jo luetun kommentin lukuhetken. käyttäjä id : string kommentti id : string lukuhetki : date, time Tietokannan tietueen lukuhetki attribuuttipäivitetään. 1) Ei yhteyttä tietokantaan. 2) Koetetaan päivittää tietuetta, jota ei vielä ole Anna käyttäjäh istoria Tietokanta palauttaa tiedon siitä, milloin käyttäjä on viimeksi lukenut (avannut) dokumentin minkäkin kommentin. käyttäjä id : string dokumentti id : string kommentti id, kommentin lukuhetki pareja. Lukuhetki on NULL, jos kommenttia ei ole luettu. 12

17 Poista käyttäjäh istoria Poistaa kommentin käyttäjähistorian. kommentti id : string Poistaa kommentin käyttäjähistorian tietokannasta. Annotointiominaisuuden kytkemiseksi päälle lisätään dokumentin tunniste tietokantaan annotoitavien dokumenttien joukkoon. Kytkettäessä annotointiominaisuus pois päältä poistetaan dokumentin tunniste. Rajapinnan toteutus tapahtuu Moodlen abstraktin tietokantarajapinnan kautta SQLkyselyinä Onko annotoitavissa Tarkistaa onko dokumentin annotointiominaisuus päällä. dokumentti id : string Palauttaa dokumentin tunnisteen, jos päällä. Palauttaa tyhjän tulosjoukon, jos ei päällä Kytke annotointiominaisuus pääl le Dokumentille kytketään annotointiominaisuus päälle. dokumentti id : string Lisää tietokantaan tietueen dokumentin tunnisteelle. Dokumentti on jo tietokannassa: Ei tehdä mitään Kytke annotointiominaisuus pois pääl tä Dokumentilta poistetaan annotointiominaisuus. dokumentti id : string Dokumenttia koskeva tunniste poistetaan tietokannasta. Dokumentin tunniste on jo poistettu tietokannasta: Ei tehdä mitään. 13

18 4.4. Annotean tarjoamat palvelut käsittelyosalle Käsittelyosan ja Annotean rajapinta Mooanjärjestelmä käyttää W3C:n Annoteapalvelinta kommenttien ja viestien tallentamiseen. Käsittelyosan ja Annoteapalvelimen rajapinta noudattaa W3C:n Annoteaprotokollaa ( Annoteaprotokolla toimii lyhyesti sanottuna seuraavasti: Mooanjärjestelmä toimii Annoteapalvelimen asiakkaana, tehden palvelupyyntöjä HTTPprotokollan ylitse. Osa protokollan pyynnöistä on toteutettu pelkästään HTTPprotokollaan käyttäen. Esimerkiksi PUT ja DELETEpyynnöillä on erilainen semantiikka, samoin palvelimen HTTPvastauskoodeilla on protokollassa määritetty semantiikkansa. Esimerkiksi kommentin poisto tapahtuu tekemällä DELETEkysely kommenttia vastaavalle URLosoitteelle. Kommentin poiston onnistumisesta tai epäonnistumisesta ilmoitetaan statuskoodilla. Kaikkia pyyntöjä ei voi kuitenkaan kuvata HTTPprotokollan sisäänrakennetuilla koodeilla, vaan niiden ohella käytetään myös XMLmuotoisia viestejä. Näitä XMLmuotoisia viestejä käytetään mm. kertomaan mikä kommenttissa lukee ja mihin dokumenttiin se liittyy. Annoteaprotokollassa käytettävien XMLviestien rakenne sekä rakenteiden tulkinta on määritelty RDFskeemojen avulla. RDFskeema on siis yksinkertaistetusti ilmaistuna sopimus siitä, että skeeman mukainen XMLviesti sisältää tietyt elementit ja että näitä elementtejä käytetään kuvaamaan tietynlaisia tietoja. RDFskeema on siis eräänlainen standardi : jokainen XMLviesti joka ilmoittaa noudattavansa skeemaa sitoutuu tähän standardiin. XMLviesti voi toteuttaa useampia skeemoja samaan aikaan. Mooanjärjestelmän yhteydessä käytetään kolmea RDFskeemaa. Kaksi skeemoista on W3C:n julkaisemia. Toinen näistä ilmaisee, että XMLmuotoisessa viestissä on kyse annotaatiosta eli Mooanjärjestelmän yhteydessä kommentista. Toinen ilmaisee puolestaan, että XMLmuotoisessa viestissä on kyse keskusteluviestiketjun viestistä, eli Mooanjärjestelmän yhteydessä viestistä. Kolmas RDFskeema määritellään itse, ja sillä ilmaistaan kommenttikategoria. Rajapinnan kuvaukset noudattavat seuraavaa kaavaa. Kaikki protokollan yksityiskohtia ei ole otettu mukaan, jos ne on suoraan saatavilla Annoteaprotokollan kuvauksesta. Nimi Lyhyt, kuvaava nimi Mitä tapahtuu. Esimerkkejä XMLviesteistä sekä HTTPtransaktioista. 14

19 Nimi Lyhyt, kuvaava nimi Parametri Mitä Mooanjärjestelmän kannalta olennaista dataa annetaan parametreina. Kuvaukset muodossa Parametrin nimi : Tietomuoto, viite XML:n tagiin Mitä Mooanjärjestelmän kannalta olennaista dataa tulee palautusarvona. Kuvaukset muodossa Parametrin nimi : Tietomuoto, viite XML:n tagiin Uusi kommentti Annoteapalvelimelle välitetään tiedot uudesta kommentista kommentin tallentamista varten. HTTPpyyntö on seuraavan muotoinen: POST /Annotation HTTP/1.1 Host: annotea.example.org ContentType: application/xml ContentLength: 1258 Viestin sisältö osassa välitetään uusi kommentti XMLmuotoisena. Käytetään RDFskeemaa ilmaisemaan, että tallennettava XMLdatassa on kyse annotaatiosta: <r:type r:resource= " Samoin käytetään omaa RDFskeemaa ilmaisemaan, että tallennettava kommentti edustaa tiettyä kommenttikategoriaa: <r:type r:resource=" /mooanns#oikeinkirjoitus"/> Dokumentin id : URI, a:annotates Kommentin paikka : XPointer, a:context Luontiaika : date, time, a:created Kirjoittaja : string, d:creator Kommenttiteksti : XML, a:body Kommenttikategoria : Mooan RDFskeema, r:type Kommentin id : URI, r:description Dokumenttin id : URI, a:annotates Viite kommenttitekstiin : URI, a:body Kommentin lisäämisen epäonnistuessa HTTP 4xx statuskoodi. Palvelimelle välitettävä pyyntö näyttää kokonaisuudessaan seuraavalta. Esimerkissä on lihavoitu kohdat, jotka ovat konfiguraatio tai kommenttikohtaisia. POST /Annotation HTTP/1.1 Host: annotea.example.org ContentType: application/xml ContentLength:

20 <?xml version="1.0"?> <r:rdf xmlns:r=" xmlns:a=" xmlns:d=" xmlns:h=" xmlns:a=" <r:description> <r:type r:resource=" <r:type r:resource=" <a:annotates r:resource=" <a:context> p[2]) </a:context> <d:title></d:title> <d:creator>käyttäjä id</d:creator> <a:created>luontiaika</a:created> <d:date>luontiaika</d:date> <a:body> <r:description> <h:contenttype>text/html</h:contenttype> <h:contentlength>123</h:contentlength> <h:body r:parsetype="literal"> Kommenttiteksti </h:body> </r:description> </a:body> </r:description> </r:rdf> Kommentin tallentamiseen Annoteapalvelin vastaa antamalla HTTPprotokollan mukaisen paluuviestin, jossa kerrotaan mm. palautusarvokohdassa mainitut parametrit. Palautusviesti on kokonaisuudessaan seuraavan kaltainen: HTTP/ Created Location: ContentType: application/xml ContentLength: 445 <?xml version="1.0"?> <r:rdf xmlns:r=" xmlns:a=" xmlns:d=" xmlns:a=" <r:description r:about=" <a:annotates r:resource=" <a:body r:resource=" </r:description> </r:rdf> 16

21 On hyvä pistää merkille kuinka Annotearajapinta toteuttaa kommentin id:n eli tunnisteen. Tunniste voi olla URImuodossa, esimerkiksi Välillä käytetään myös lyhyempää muotoa /Annotation/3ACF6D754. Olennaista on kuitenkin huomata, että merkkijono 3ACF6D754 on Annoteapalvelinkohtaisesti uniikki jokaiselle tallennetulle kommentille Kommenttien kysely Kysyy Annoteapalvelimelta dokumenttiin liittyviä kommentteja HTTPkyselyllä: mooan_get_ /Annotation?w3c_annotates=dokumentin_id HTTP/1.1 Host: annotea.example.org Accept: application/xml Annotea vastaa HTTP 200/1.1 OK sekä XML muotoisella kommentteja kuvaavalla datalla, josta alla on esimerkki. Dokumentin id : URI Kommentit, jokaisesta erikseen: Kommentin paikka : XPointer, a:context Luontiaika : date, time, a:created URI kommenttitekstiin : URI, a:body Kommentteja ei ole: Palautetaan tyhjä XML. Kommenttien kysely palauttaa siis XMLmuotoista dataa, jossa jokaista sivua kohti tallennettua kommenttia vastaa yksi r:description tagi. <?xml version="1.0"?> <r:rdf xmlns:r=" xmlns:a=" xmlns:d=" xmlns:a=" <r:description r:about=" <r:type r:resource=" <r:type r:resource=" <a:annotates r:resource=" <d:title></d:title> <a:context> </a:context> <d:creator>käyttäjä id</d:creator> <a:created>luontiaika</a:created> <d:date>luontiaika</d:date> <a:body r:resource=" </r:description> </r:rdf> 17

22 Kommentin tekstin lataus Dokumentin kommenttien kyselyn jälkeen on jokaisen kommentin sisältö ladattava erikseen. Tämä tapahtuu HTTPpyynnöllä: mooan_get_ /Annotation/body/kommentti_id HTTP/1.1 Host: annotea.example.org Accept: application/xml Kommentti id : URI Kommenttiteksti : Palvelimelle tallennetun kommentin bodytagin sisältö, kts. Uuden kommentin lisääminen Kommentin muokkaus Olemassa olevaa kommentin sisältöä muokataan. Tämä tapahtuu PUTmetodilla URI:in, jossa muokattava kommentti on. PUT /Annotation/kommentti_id HTTP/1.1 Host: annotea.example.org ContentType: application/xml ContentLength: 123 Sisältönä annetaan muokattu kommentti, kuten uuden kommentin lisäämisen yhteydessä. Kommentin id ( PUTmetodin yhteydessä. Dokumentin id : URI, a:annotates Kommentin paikka : XPointer, a:context Luontiaika : päiväys ja aika, a:created Kirjoittaja : integer, d:creator Kommenttiteksti : XML, a:body Kommenttikategoria : Mooan RDFskeema, r:type Kommentin id : URI, r:description Dokumenttin id : URI, a:annotates Viite kommenttitekstiin : URI, a:body Kommentin poisto Poistetaan kommentti Annoteapalvelimelta: DELETE /Annotation/kommentti_id HTTP/1.1 Host: annotea.example.org Palvelin vastaa: HTTP/ OK Kommentti id : URI Palvelin ei palauta HTTPvastauksen lisäksi mitään. 18

23 Poistetaan kommentti Annoteapalvelimelta: DELETE /Annotation/kommentti_id HTTP/1.1 Host: annotea.example.org Palvelin vastaa: HTTP/ OK Kommenttia ei voi poistaa: HTTP 4xx koodi Uusi viesti Annoteapalvelimelle välitetään tiedot uudesta viestistä tallennusta varten. Kts. viestirunko alta: Uuden viestin kohdalla käytetään keskustelujen kuvaamiseen käytettävää RDFskeemaa <r:type r:resource=" erotuksena uudesta kommentista. Palvelin vastaa HTTP/ Created sekä alla olevilla parametreilla. Luontiaika : date, time, a:created Kirjoittaja : string, d:creator Kommenttiteksti : string, a:body Kommenttityyppi : Mooan RDFmäärittely, r:type Vastattavan kommentin/viestin id : URI, tr:inreplyto Keskustelun kommentin id : URI, tr:root Lisätyn viestin id : URI, r:description Vanhemman id : URI, tr:replyto Keskustelun kommentin id : URI, tr:root Osoite viestin tekstiin : URI, a:body Viestiä ei voitu luoda: HTTP 4xx koodi. Annoteapalvelimelle välitettävä uusi viesti näyttää XMLmuotoisena seuraavalta. Kannattaa huomata, että uusi viesti eroaa uudesta kommentista ainoastaan muutamien tagien osalta. Uutta ovat keskustelun RDFskeemaan liittyvät määrittelyt. Pois on jätetty annotaatioiden RDFskeemaan liittyvät määrittelyt sekä kommentin paikan ilmaiseva tagi. Vastaavaa yhtäläisyyttä on myös esimerkiksi viestin tiedustelun yhteydessä. <?xml version="1.0"?> <r:rdf xmlns:r=" xmlns:a=" xmlns:d=" xmlns:h=" xmlns:tr=" xmlns:rt=" <r:description> <r:type r:resource=" <r:type r:resource=" 19

24 <tr:root r:resource=" <tr:inreplyto r:resource=" <d:title></d:title> <d:creator>käyttäjä id</d:creator> <a:created>luontiaika</a:created> <d:date>luontiaika</d:date> <a:body> <r:description> <h:contenttype>text/html</h:contenttype> <h:contentlength>123</h:contentlength> <h:body r:parsetype="literal"> Viestiteksti </h:body> </r:description> </a:body> </r:description> </r:rdf> Viestin tiedustelu Kysytään onko kommenttiin tai viestiin vastauksia. mooan_get_ /Annotation?w3c_reply_tree= HTTP/1.1 Host: annotea.example.org Accept: application/xml Palvelin vastaa samalla tavalla kuin kommenttien tiedustelun yhteydessä. Kommentin tai viestin id : URI Jokaista vastausviestiä kohden alla olevat parametrit: Viestin id : URI, r:description Vanhemman id : URI, tr:replyto Keskustelun kommentin id : URI, tr:root Osoite viestin tekstiin : URI, a:body Ei viestejä: Palautetaan tyhjä XMLtiedosto Viestin tekstin lataaminen Kuten kommentin tekstin lataaminen Viestin id : URI Viestin a:body tagin sisältö 20

25 Viestin muokkaus Olemassa olevaa viestin sisältöä muokataan. Tämä tapahtuu PUTmetodilla URI:in, jossa muokattava viesti on. PUT /Annotation/viestin_id HTTP/1.1 Host: annotea.example.org ContentType: application/xml ContentLength: 123 Sisältönä annetaan muokattu viesti, kuten uuden viestin lisäämisen yhteydessä. Viestin id : URI Viesti: Kuten uuden viestin kirjoittamisen yhteydessä. Kuten uuden viestin kirjoittamisen yhteydessä Viestin poisto Viesti poistetaan DELETEmetodilla. DELETE /Annotation/viesti_id HTTP/1.1 Host: annotea.example.org Palvelin vastaa HTTP/ OK Viestin id : URI Viestiä ei voitu poistaa, esimerkiksi koska siihen on vastauksia: HTTP 4xx koodi Moodlen tarjoamat palvelut käsittelyosalle Käsittelyosan ja Moodlen rajapinta 21

26 Moodle tuottaa Mooanmoduulin käsittelemät dokumentit. Tämä rajapinta määrittelee palvelut, joiden kautta Mooan ottaa dokumentin vastaan ja julkaisee sen käsittelyn jälkeen takaisin Moodleen. Rajapinta määrittelee myöskin palveluita, joiden kautta Mooan hakee Moodlelta muuta dokumentin käsittelyssä tarvittavaa tietoa. Esimerkkipalvelu Lyhyt kuvaus palvelun toiminnasta Mitä parametreja palvelu saa käsittelyosalta Mitä palvelu palauttaa käsittelyosalle Mitä muuta tapahtuu. Mitä poikkeustilanteita voi sattua Hae käyttäjän tunnus Lukee käyttäjän tunnuksen Moodlesta. Käyttäjä id : string Hae käsiteltävän ä olevan dokumentin tunniste Lukee Moodlesta käsiteltävänä olevan dokumentin tunnisteen. Dokumentti id : URI Hae käyttäjän käyttöoikeudet käsiteltävän ä olevaan dokumenttiin Lukee Moodlesta käyttäjän oikeudet tällä hetkellä käsiteltävänä olevan dokumentin suhteen. Käyttäjä id : string Ylläpitäjä / opettaja / tavallinen käyttäjä / vierailija: enumeration 22

27 Hae yleiset asetukset Lukee yleiset asetukset Moodlesta. Sisältää esim. käytettävän tietokannan tietokannan tiedot tyyppi, osoite, tunnukset, etc. Moodlen CFGtietorakenne. CFGtietorakennetta ei ole määritelty. Tällöin ei voida jatkaa Mooanin toimintaa. Jos dokumentti on tässä tilanteessa siepattu käsiteltäväksi, se tulee julkaista takaisin Dokumentin poistaminen Ensisijaisesti: Luetaan Moodlesta, onko annettu dokumentti vielä olemassa. Dokumentin tunniste : URI Onko poistettu : boolean Mutta mikäli on mahdollista, niin vaihtoehtoisesti: Moodle ilmoittaa Mooanille dokumentin poiston yhteydessä tapahtumasta. Dokumentin tunniste : URI Dokumenttiin liittyvät kommentit ja niiden viestit poistetaan Annoteasta Hae Moodlen tuottama dokumentti käsiteltäväk si Luetaan Moodlen tuottama htmlsivu muuttujaan Mooanin käsiteltäväksi. Dokumentin sisältö : text/html Jokin Moodlen toiminto käyttää PHP:n output bufferingtoimintoa niin, että Mooanin lukiessa puskurin muuttujaan, se ei sisälläkään (vain) haluttua dokumenttia Julkaise käsitelty dokumentti takaisin Moodleen Julkaistaan dokumentti takaisin niin, että Moodlen toiminta voi jatkua normaalisti. Dokumentin sisältö : text/html 23

28 Julkaistaan dokumentti takaisin niin, että Moodlen toiminta voi jatkua normaalisti. 24

29 5. Komponenttisuunnittelu 5.1. Käyttöliittymä Käyttöliittymän komponentit Käyttöliittymä on Mooanin osajärjestelmä, joka toimii selaimessa. Sen toiminnallinen osa on toteutettu Javascriptilla. HTMLelementteihin liitetään tapahtumankäsittelijöitä, jotka kutsuvat toimintoja toteuttavia funktioita mooan_globals Tämä tiedosto luo ja alustaa joukon globaaleja muuttujia. Muuttuja mooan_user_type: int Tarkoitus Käyttäjän oikeudet suhteessa auki olevaan dokumenttiin. 25

30 Muuttuja Tarkoitus 0 = vain luku (vierailija) 1 = luku ja kirjoitus (tavallinen käyttäjä) 2 = luku,kirjoitus ja kommentoitavuuden kytkeminen (tavallinen käyttäjä, joka on sivun omistaja) 3 = luku, kirjoitus, kommentoitavuuden kytkeminen, muokkausja poistooikeudet myös muihin kuin omiin kommentteihin (admin tai opettaja) mooan_user_id: string Käyttäjän tunnus. mooan_server_uri: string Palvelimen URI. Tätä XMLHttpRequest:in parametrina. mooan_commenting_mode: int Kirjoitettavan kommentin semantiikka. 0 = Uusi kommentti 1 = Vastaus 2 = Olemassa olevan kommentin muokkaus mooan_current_reply_target_id Vastauksen kohteena olevan viestin ID. : string mooan_modification_target_id: Muokattavan viestin ID. string mooan_window_type: int 0 = Normaali 1 = Tulostusikkuna 2 = Kaikki kommentit mooan_current_comment_type Kirjoitettavan kommentin tyyppi. : string Mooan_event_handlers Tämä tiedosto sisältää tapahtumakäsittelijöiden toteutuksen. Listattujen parametrien lisäksi jokainen funktio saa parametrikseen tapahtumaolion, joka liittyy käsiteltävänä olevaan tapahtumaan. Funktio t Kutsutut funktiot mooan_on_mouse_ov Hiiren vienti er_comment kommentin päälle. Jos hiiren kohdalla on monta päällekkäistä kommenttia, näyttää valintapalkin sen sijaan että avaisi suoraan kommenttinäkymän. cause: DOMElement: Elementti, joka laukaisi tapahtuman. mooan_spawn_comment_view() mooan_spawn_overlying_comm ent_selection_pop_up() mooan_on_mouse_ov clicked_selecton_c mooan_spawn_comment_view() Valinta päällekkäisistä 26

31 Funktio t Kutsutut funktiot er_overlying_commen kommenteista. t_selection hain_id: string: Valinnan kohteena olevan kommentin ID. mooan_on_click_pop up_close cause: DOMElement: Elementti, joka laukaisi tapahtuman. mooan_close_pop_up() mooan_on_click_com Kommenttityyppiment_add_selection valintanappulan painaminen uutta kommenttia lisättäessä. comment_type: string: Kommettityyppi. mooan_set_visible() mooan_set_edit_view_visible() mooan_close_pop_up() mooan_on_click_resp Käsittelee Vastaa ond linkin valitsemisen. response_target_id : string: Vastauksen kohteena olevan viestin ID. mooan_set_visible() mooan_set_comment_view_visi ble() mooan_set_edit_view_visible() mooan_set_reply_target() mooan_on_click_edit comment to_edit_id: string: Muokkauksen kohteena olevan viestin ID. mooan_set_visible() mooan_set_comment_view_visi ble() mooan_set_edit_view_visible() mooan_set_edit_view_text() mooan_set_modify_target() Yleinen sulkemiselementin käsittelijä. Käsittelee Muokkaa linkin valitsemisen. mooan_on_click_dele Käsittelee Poista te_comment linkin valitsemisen. to_delete_id: string: Poistettavan viestin ID. mooan_delete_comment() mooan_on_click_pub lish mooan_add_comment() mooan_modify_comment() mooan_set_visible() mooan_on_click_prin Käsittelee table_view Tulostusnäkymä linki n valitsemisen. mooan_open_print_window() mooan_on_select_an notability_on Käsittelee Kommentointi käytössä valinnan. mooan_toggle_is_annotable() mooan_on_select_an notability_off Käsittelee Kommentointi ei käytössä valinnan. mooan_toggle_is_annotable() mooan_on_click_sho Käsittelee Näytä w_all_comments kommenttipuu linkin valitsemisen. mooan_open_all_comments_win dow() mooan_on_click_help Käsittelee Ohje linkin valitsemisen. Avaa uuden ikkunan. mooan_open_document() Käsittelee Julkaise nappulan painamisen. 27

32 Funktio t Kutsutut funktiot mooan_on_click_sho Käsittelee Suurenna w_view_pane nappulan painamisen. chain_id: string: Kommenttinäkymän, jonka Suurenna nappulaa painettiin, ID mooan_set_visible() mooan_set_comment_view_visi ble() mooan_on_mouse_do Käsittelee hiiren wn_document vasemman napin painamisen pohjaan. mooan_on_mouse_up Käsittelee hiiren _document vasemman napin päästämisen nousemaan takaisin ylös. Jos nyt on olemassa valinta (korostus), niin avataan kommentinlisäysvalikko. mooan_spawn_comment_add_po p_up() Mooan_lib Tämä tiedosto sisältää yleisiä funktioita. Funktio t Kutsutut funktiot mooan_open_document Avaa annetun URI:n joko samassa tai uudessa selainikkunassa. uri: string: Avattavan sivun URI. new_window: boolean: Avataanko sivu uudessa ikkunassa. mooan_reload_document Lataa uudestaan dokumentin ikkunassa, jossa kutsuvaa koodia suoritetaan. delay: int: Viive ennen uudelleenlataamista (voi olla 0). mooan_close_window Sulkee ikkunan, jossa kutsuvaa koodia suoritetaan. delay: int: Viive ennen sulkemista (voi olla 0). openprintwindow Avaa tulostusnäkymäikkuna n. mooan_opendocument() mooan_open_all_commen Avaa ikkunan, jossa ts_window näytetään kaikki dokumenttiin liittyvät kommentit. mooan_open_document() mooan_highlight_comme nt comment_id: string: Korostettavan viestin ID. Muuttaa annetun viestin htmlelementin tyyliä korostetuksi. 28

33 Funktio t Kutsutut funktiot mooan_set_reply_target Asettaa vastauksen kohteena olevan viestin ID:n. target_id: string:viestin ID. mooan_set_modify_target Asettaa moukkauksen kohteena olevan viestin ID:n. comment_id:string:vi estin ID. new_value: boolean: Kommentoitavuuden uusi tila. mooan_send_request() mooan_spawn_error() mooan_mark_comment_r ead Lähettää palvelimelle comment_id: string: viestin, joka kertoo Luetuksi merkittävän että annettu kommentti kommentin ID. on luettu. mooan_send_request() mooan_add_comment Lähettää palvelimelle viestin, jossa on uusi kommentti lisättäväksi Annoteaan. Kommentin sisältö luetaan muokkausnäkymän tekstikentästä. mooan_send_request() mooan_spawn_error() mooan_reload_document() mooan_modify_comment Lähettää palvelimelle viestin, jossa on moukatun kommentin uusi sisältö. Muokatun kommentin ID luetaan globaalista muuttujasta ja sisältö muokkausnäkymän tekstikentästä. mooan_send_request() mooan_spawn_error() mooan_reload_document() mooan_delete_comment Lähettää palvelimelle viestin, jossa käsketään poistamaan annettu kommentti. comment_id: string: Poistettavan kommentin ID. mooan_send_request() mooan_spawn_error() mooan_reload_document() mooan_toggle_is_annotab Asettaa dokumentin le kommentoitavuuden päälle tai pois päältä Mooan_view_pane Tämä tiedosto sisältää funktioita, jotka käsittelevät muokkausnäkymää. Funktio mooan_set_visible Asettaa visible: boolean: muokkausnäkymän Näkyvyyden uusi joko näkyviin tai pois tila. näkyvistä moukkaamalla sen htmlelementtien tyylejä. t Kutsutut funktiot 29

34 Funktio mooan_set_comment _view_visible Asettaa muokkausnäkymän kommenttinäkymän joko pois näkyvistä tai asettaa annetun kommenttinäkymän näkyväksi muokkausnäkymässä. t Kutsutut funktiot visible: boolean: Ollaanko asetamassa kommenttinäkymää näkyväksi vai pois näkyvistä. comment_view_id: string: Näkyväksi asetettaessa näkyväksi asetettavan kommenttinäkymän ID. mooan_attach_comm ent_view_to_view_pa ne() mooan_set_edit_view Asettaa _visible kirjoituskentän joko näkyviin tai pois näkyvistä muokkaamalla sen htmlelementtien tyylejä. Asetettaessa sitä näkyväksi, kommenttikentän sisältö tyhjennetään. visible: boolean: Näkyvyyden uusi tila. mooan_set_edit_view Asettaa _text muokkauskentän sisällön. text: string: muokkauskentän sisällöksi asetettava teksti Mooan_pop_up Tämä tiedosto sisältää funktioita popupien käsittelemiseen. Mooanin käyttämät popupit ovat erilaisia kuin sanalla yleensä tarkoitetaan. Normaalisti popup avautuu uutena ikkunan nykyisen ikkunan päälle. Sen sijaan Mooanin käyttämät popupit ovat htmlelementtejä samassa sivussa kuin niitä luovaa koodia ajetaan. Ne asetetaan paikalleen sivun muiden elementtien päälle CSS:n avulla. Funktio t Kutsutut funktiot mooan_spawn_comm Avaa kommentinent_add_pop_up lisäys popupin. Se sisältää napit kommenttityypin valintaa varten. position: X ja Y koordinaatit, johon popup tulisi sijoittaa. mooan_spawn_comm Asettaa annetun ent_view kommenttinäkymän näkyväksi halutussa paikassa. position: X ja Y koordinaatit, johon popup tulisi sijoittaa. chain_root_id: string: Kommenttinäkymän ID. mooan_set_comment _view_visible_at_pos ition() mooan_spawn_error message: string: Virheilmoituksen teksti. Avaa virheilmoituspopupin annetulla tekstillä. Monta samanaikaista 30

35 Funktio t Kutsutut funktiot virheilmoitusta tuottaa popupin jossa kaikkien virheilmoitusten tekstit. mooan_spawn_query _pop_up Avaa kyselypopupin. query_text: string: Kysymyksen teksti. responses: array: Taulukko, joka sisältää vastausten tekstit. string: Vastauksen teksti. mooan_close_pop_up Sulkee annetun popupin. pop_up_id: string: Suljettavan popuin htmlelementin ID. mooan_spawn_overl Avaa popupin ying_comment_select päällekkäisistä ion_pop_up kommenteista katseltavaksi valintaa varten. chains_to_select_fro m: array: Vaihtoehtoisten kommenttinäkymien IDt Mooan_comment_view Tämä tiedosto määrittää funktioita kommenttinäkymien käsittelyä varten. Funktio t Kutsutut funktiot mooan_set_comment_view_visib Asettaa annetun le_at_position kommenttinäkymän näkyville annetussa kohdassa ruutua. comment_view_id: string: Näkyville asetettavan kommenttinäkymän ID. position: X ja Y koordinaatit, johon kommenttinäkymä tulisi sijoittaa. mooan_attach_comment_view_t o_view_pane Liittää annetun kommenttinäkymän muokkausnäkymään ja asettaa sen näkyväksi. comment_view_id: string: Liitettävän kommenttinäkymän ID. mooan_hide_comment_view Asettaa annetun kommenttinäkymän pois näkyvistä muokkaamalla sen tyyliä. Jos se on liitettynä muokkausnäkymään, se irrotetaan siitä. comment_view_id: string: Piilotettavan kommenttinäkymän ID. 31

36 Mooan_x_pointer_lib Tämä tiedosto sisältää Mooanin käyttämän XPointertoteutuksen javascriptversion. Sitä käytetään ainoastaan laskemaan XPointereita uusille kommenteille ja siten se sisältää ainoastaan toiminnallisuuden XPointerien luontiin. Funktio mooan_generate_x_p ointer Luo uuden XPointerin uuden kommentin sijainnin paikantamista varten. t target: DOMElement: x_pointer: Luotu Elementti, joka XPointer. luodun XPointerin tulee paikantaa. Kutsutut funktiot Mooan_connection Tämä tiedosto sisältää funktioita XMLHttpRequestin käyttämiseen. Palvelimen osoite luetaan globaalista muuttujasta mooan_globals.server_uri. Funktio mooan_send_request Lähettää palvelimelle pyynnön ja blokkaa odottaessa vastausta. mooan_send_request_ca Lähettää llback palvelimelle asynkronisen pyynnön ja palaa. Kun vastaus on saapunut, kutsuu annettua funktiota antaen palvelimelta saadun vastauksen parametriksi. t Kutsutut funktiot http_method: string: Lähetettävän pyynnön HTTPmetodi (GET, POST, PUT, etc) data: string: Pyynnön sisältö. string: Palvelimelta saatu vastaus. http_method: string: Lähetettävän pyynnön HTTPmetodi (GET, POST, PUT, etc) data: string: Pyynnön sisältö. function_to_call: string: Kutsuttavan funktion nimi. Tulee ottaa parametrina yksi string. mooan_function_to_c all() 32

37 5.2. Käsittelyosa Käsittelyosan komponentit Käsittelyosa on Mooanin osajärjestelmä, joka on toteutettu PHP:lla. Se käsittelee käyttöliittymän pyynnöt ja palauttaa vastauksena HTML:ää. käsittelyosa kommunikoi myös ulkoisten palvelujen kanssa. Moodlesta se hakee käsiteltävät dokumentit, Annoteasta dokumenttiin liittyvät kommentit ja omasta tietokannasta kommentteihin liittyvää muuta informaatiota mooan_handlerequest ModifyPage ja handleaction funktiot käyttävät apunaan useita muita alemman tason funktioita rakentaessaan käyttäjälle näytettävää htmlsivua. Kaikki mitä käyttäjä näkee, kulkee aina näiden funktioiden kautta. Funktio t mooan_modify_page Hakee sivun kommentteineen ja palauttaa sen wwwpalvelimelle URI Html sivu vastauksena käyttäjälle mooan_handle_action Käsittelee Httppyynnön (kommenttien lisäys, muokkaus, poisto tai Httppyynnön Html sivu parametrit vastauksena käyttäjälle Kutsutut funktiot mooan_get_user_rights() mooan_get_document_text() mooan_get_comments() mooan_comment_history() mooan_get_annotation() mooan_get_user_rights() mooan_add_comment() mooan_add_message() mooan_add_() 33

38 Funktio t kommentoinnin kytkeminen). Kutsutut funktiot mooan_modify_message() mooan_delete() mooan_delete_rec() mooan_set_annotation() mooan_read_comments ReadComments kirjaston funktio markasread() kirjaa MooanDB:hen tiedot käyttäjän lukuhistoriasta: milloin kommetti on luettu. Sivua ladattaessa funktiolta commenthistory() saadaan tieto, mitkä kommentit käyttäjä on lukenut ja mitkä ei. Kun kommentti poistetaan, kirjaston funktio remove() poistaa siihen liittyvän lukuhistorian tietokannasta. Funktioiden kuvauksissa on käytetty pseudophp:ta, ja ne käyttävät tietokantaoperaatioihin jotakin php:n valmista db2_exec()tyyppistä funktiota. Funktio mooan_mark_read t Kutsutut funktiot Päivittää user:string tietokantaan ajan, commentid:string jolloin käyttäjä time:date, time viimeksi luki kommentin. Jos luetaan ensimmäistä kertaa, luo tietueen. $comment=execute('select comment_id from mooan_comment_history where comment_id=$comment_id'); if($comment) // on luettu aikaisemmin, päivitetään tietuetta Execute('update mooan_comment_history set visited=$time where comment_id=$comment_id'); else //luetaan ensimmäistä kertaa, lisätään tietue Execute('insert into mooan_comment_history values ($comment_id,$document_id,$user,$time)'); mooan_comment_history Tutkii, mitkä kommentit ja viestit käyttäjä on lukenut User:string documentid:string comments[]:string $read = Execute('select comment_id from mooan_comment_history where user_id=$user && document_id=$document_id); manipuloi_taulukkoa{}; return $read; mooan_remove Poistaa kommentin ja kaikki siihen liittyvät merkinnät tietokannasta. commentid:string Execute('delete from mooan_comment_history where comment_id=$comment_id); 34

39 mooan_document_lib Tietokantakyselyt toteutetaan SQL:llä Moodlen käyttämän Adodbtietokantaabstraktion kautta. Funktio t Kutsutut funktiot +mooan_mooan_get annotation() Tarkistaa onko kommentointiominaisu us päällä dokumentissa. documentid : string status : boolean +mooan_set_annotation() documentid : string status : boolean Kytkee kommentointiominaisu uden päälle tai pois sivukohtaisesti mooan_moodle_interface Moodlerajapinnan toteuttavat funktiot lähinnä lukevat tietoa Moodlen globaaleista vakioista. Funktio t Kutsutut funktiot mooan_mooan_get_user_rights() Hakee tiedon käyttäjän oikeuksista. Integer, käyttäjän oikeudet ilmaiseva vakio. mooan_mooan_get_document_text() Hakee dokumentin tekstin. String, dokumentin sisältämä teksti. mooan_mooan_get_settings() Hakee yleiset asetukset. Taulukko joka sisältää yleiset asetukset mooan_annotea_lib Funktio +mooan_mooan_get_comm Hakee ents() dokumenttiin liittyvät kommentit vastauksineen. documentid : string t Kutsutut funktiot Talukko kommentti tietorakenteita. mooan_get_comment_ids( ) mooan_get_body() mooan_parse_annotation() mooan_get_repliesrec() $comments = []; $ids = mooan_get_commentids(); foreach ($ids as $id) { $body = mooan_get_body(id); $c = mooan_parse_comment($body); $c.replies = mooan_get_replies_rec($c.comment_id)); $comments[] = $c; } +mooan_add_comment() Lisää dokumenttiin documentid : kommentin. string text: string creatorid: int place: string commentid : string tai NULL, jos epäonnistui mooan_add() 35

40 Funktio t Kutsutut funktiot mooan_add($text, $creatorid, now(), $documentid, $place, NULL, NULL); +mooan_add message() Lisää rootid: string viestiid :tai kommenttiin/viestii text : string NULL, jos n vastauksen creatorid : int epäonnistui parentid : string mooan_annotea_request() mooan_add($text, $creatorid, now(), NULL, NULL, $rootid, $parentid); mooan_add_() Lisää kommentin/ viestin. Huolehtiin XMLtuottamisesta. text : string success : boolean creatorid : int createdts : string documentid : string place : string rootid : string parentid : string mooan_annotea_request() if ($documentid!= NULL && place!= NULL && $rootid == NULL && parentid == NULL} { // uusi kommentti } elseif {$rootid!= NULL && parentid!= NULL && $documentid == NULL && place == NULL}} { // uusi viesti } else { // kutsutaan ristiriitaisilla argumenteilla return false; }... mooan_annotea_request(... );... return $status; +mooan_ delete(id) Poistaa kommentin tai viestin Annoteasta, jos kommentti/viesti on lehtisolmu. messageid : string success : boolean + mooan_delete_rec() Poistaa kommentin tai viestin Annoteasta vastauksineen. (Hyödyllinen esimerkiksi dokumentteja poistettaessa.) messageid : string success : boolean mooan_annotea_request() deleterecimplementaatio pseudokoodina: $comments = mooan_get_reply_ids($messageid); foreach ($comments as $c) { $status = mooan_delete_rec($c.commentid); if (! $status) { return false; } $status = mooan_delete($c.commentid) if (! $status) { return false; } 36

41 Funktio t Kutsutut funktiot } return true; +mooan_modify_comment( Kirjoittaa ) kommentin päälle uudet tiedot. messageid : string documentid : string text : string creatorid : int place : string success : boolean mooan_annotea_request() +mooan_modify_essage() Kirjoittaa viestin päälle uudet tiedot. Ei anna muuttaa viestin paikkaa kekustelussa. messageid : string text: string creatorid: int success : boolean annotearequest() mooan_annnotea_request() Lähettää parametrina annetun HTTPpyynnön Annoteapalvelimella ja palauttaa vastauksen. headers : string content: string headers : string content : string mooan_get_mooan_comm ent_ids() Noutaa dokumentin kommmenttien tunnisteet. documentid:stri place : string ng creatorid : int created : string mooan_get body() Noutaa kommentin messageid : tai viestin string varsinaisen sisällön. text : string mooan_annotea_request() mooan_annotea_request() mooan_parse_annotation() Parseroi Annotean palauttamasta XMLstä tietorakenteen xml : string Kommentti/viestitietorakenne +mooan_get reply_ids() Noutaa kommentin/viestin välittömien vastausten ID:t. messageid : string string[] Taulukon pituus 0, jos ei vastauksia. mooan_annotea_request() +mooan_get replies_rec() Hakee kommenttiin liittyvät vastaukset rekursiivisesti. messageid : string TaulukkoMessage tietorakenteita, jotka saattavat viitata edelleen Message tietorak. mooan_get_reply_ids() mooan_get_body() mooan_parse_annotation() mooan_mooan_get_replies_recimplementaatio pseudokoodina: $replies = []; $ids = mooan_get_reply_ids(id); 37

42 Funktio t Kutsutut funktiot if ($ids!= NULL) { foreach ($ids as $id) { $body = mooan_get_body($id); $r = mooan_parse_message($body); r.replies = mooan_get_replies_rec(r.replyid); $replies[] = $r; } } return $replies; mooan_xpointer_lib Käsittelyosan XPointerLib:n tarkoituksena on merkitä kommentit oikeaan kohtaan selaimelle palautettavaa dokumenttia. Funktio +mooan_place() Sijoittaa kommentteja merkitsevät tagit HTMLdokumenttiin. t Kutsutut funktiot Htmldokumentti : string Muokattu htmldokumentti. kommenttitietorakenteet taulukkona mooan_placeimplementaati pseudokoodina: function mooan_place($domdoc_str, $comments) { foreach ($comments as $comment) { etsi kommentin tuleva kohta käyttäen XPointeria lisää kommenttitagin alku XPointerin mukaan lisää kommenttitagin loppu XPointerin mukaan } return $domdoc_str; } 38

43 5.3. mooan_db Tietokanta pitää kirjaa siitä, milloin käyttäjä on viimeksi lukenut eli avannut kommentin ja siihen liittyvät keskustelut. Lisäksi tietokanta tallentaa tiedon sivuista, joita voi annotoida mooan_comment_history Tietokantataulussa on tallennettuna, onko käyttäjä lukenut kommentin, sekä viimeisimmän lukukerran ajankohta. Parametri Tyyppi Määre comment_id STRING PRIMARY KEY document_id STRING INDEX user_id INTEGER PRIMARY KEY visited TIMESTAMP mooan_annotation_on Tietokantataulussa on rivi jokaista annotoitavissa olevaa dokumenttia kohden. Parametri document_id Tyyppi STRING Määre PRIMARY KEY 39

44 6. Käyttöliittymäsuunnittelu 6.1. Lukeminen ja selaus Yleisnäkymä Tekstiin tehdyt sisältökommentit näkyvät vihreällä taustavärillä korostettuna, oikeinkirjoituskommentit violetilla. Luetut ja uudet kommentit erottuvat toisistaan siten, että luetun kommentin taustaväri on himmeämpi. Mikäli annotointi on kytketty päälle, näkyy tavalliselle käyttäjälle sivun yläreunassa teksti Maalaa alue, jota haluat kommentoida sekä linkit kommenttipuu, tulostus ja ohjenäkymiin. Jos käyttäjällä on oikeus kytkeä annotointi päälle/pois, näkyy ilmoituksen tilalla kaksi radiopainiketta: kommentointi käytössä ja kommentointi ei käytössä. Jos kommentointiominaisuus on pois päältä, tavalliselle käyttäjälle ei tule ilmoitusta annotoinnista laisinkaan. Yleisnäkymä Kommenttinäkymä Käyttäjän viedessä hiiren tekstin korostetun kohdan päälle, avautuu kommenttinäkymä kommentin viereen. Jos kommentti on pitkä, tai siinä on paljon vastauksia, kommenttinäkymään ilmestyy vierityspalkki. Näin ikkunan koko pysyy pienenä. Puurakenne näkyy vasemmassa reunassa kapeina väripalkkeina. Näkymän koko määräytyy fonttikoon mukaan, 15 riviä. Vastaa, Muokkaa ja Poista toiminnot näkyvät vain niille käyttäjille, joilla on oikeus kyseiseen toimintoon. Jos käyttäjä valitsee Vastaa, Muokkaa, tai Suurenna toiminnon, avataan muokkausnäkymä ruudun alareunaan. Poista toiminto valittaessa käyttäjältä pyydetään vahvistus poistoon, jonka jälkeen viesti poistetaan ja sivu ladataan uudestaan. (Katso myös ) Kun kommenttiikkuna on avattu merkitään kyseinen kommentti luetuksi ja näytetään se vaaleammalla värillä. 40

45 Kommentti ja vastauksia Lyhyt kommentt 41

46 Kommentin valinta pääl lekkäisistä kommenteista Kun samaan kohtaan kohdistuu useampia kommentteja, kohta korostuu tummemmalla värillä. Kun hiiri viedään kohdan päälle, nähdään kaikista kommenteista alkuosa tekstistä. Hiirellä kohdistamalla valitaan kumpi kommentti halutaan kommenttinäkymään. Kommentin valinta päällekkäisistä Muokkausnäkymä Muokkausnäkymä näytetään dokumenttiikkunan alalaidassa niin, että dokumenttia on mahdollista käyttää normaalisti muokkausnäkymän ollessa auki. Näkymän koko määräytyy fonttikoon mukaan, 11 riviä. Muokkausnäkymä avautuu, kun käyttäjä klikkaa kommenttinäkymästä muokkaa, vastaa tai suurenna, sekä silloin kun käyttäjä valitsee uuden kommentin kirjoittamisen kommentointilaatikosta. Myös muokkausnäkymässä voi valita muokkaa, vastaa sekä poista toiminnot. Muokkausnäkymän ollessa auki käyttäjä voi valita alkuperäisestä dokumentista uuden kommentin ja avata sen vanhan muokkausnäkymän päälle. Jos käyttäjä sulkee muokkausnäkymän tallentamatta kirjoittamaansa viestiä, esiin ponnahtaa ikkuna jossa käyttäjältä varmistetaan haluaako hän todella olla tallentamatta viestiään. 42

47 Muokkausnäkymä ja varmistuskysely Kaikkien kommenttien selaus Tiettyyn dokumenttiin liittyviä kaikkia kommentteja ja viestejä on mahdollista tarkastella erillisellä sivulla omassa ikkunassa (uusi selainikkuna). Kommentit näytetään puumaisena rakenteena dokumentin mukaisessa järjestyksessä. Kommenttien väliin jää pieni rako helpottamaan kommenttikokonaisuuksien ts. yhteen kuuluvien viestien erottamista toisistaan. Kommenttipuun oksat erotetaan toisistaan väreillä niin, että saman tason oksat ovat keskenään saman värisiä. Tällöin nähdään helposti mihin viestiin mikin vastaus liittyy. Vastaa, muokkaa ja poista toiminnot toimivat muuten samaan tapaan kuin tavallisesti, mutta kommentteja ei näytetä alhaalla muokkausnäkymässä, vaan siellä on ainoastaan muokkaus tai vastaa kenttä. Muokkausnäkymä tulee esille vain silloin kun sitä tarvitaan. Näkymä suljetaan sulkemalla ikkuna selaimessa. 43

48 Kaikkien kommenttien katselu 6.2. Kommentin ja viestin lisääminen Kommentin lisäämi nen Käyttäjän maalattua kommentoitavan tekstikohdan hiirellä, aukeaa tekstikohdan viereen laatikko, jossa käyttäjältä kysytään minkä tyyppistä kommenttia ollaan luomassa. Kun käyttäjä valitsee kommentointityypin, sivun alareunaan aukeaa kommentointiikkuna. Uuden kommentin kirjoituksen aikana dokumenttiikkunassa näytetään korostettuna kohta, johon kommentti kohdistuu. Kommentin julkaisemisen jälkeen muokkausnäkymä sulkeutuu. Kirjoitetun kommentin näkee helposti viemällä hiiren kommentin kohdalle, jolloin kommenttinäkymä avautuu. Uusi kommentti visualisoidaan kirjoittajalle luettuna, muille käyttäjille uutena. Tekstikentän voi jättää myös tyhjäksi, jos kommentti koskee oikeinkirjoitusta. Tällöin kommentin sisällöksi asetetaan automaattisesti teksti oikeinkirjoitus. 44

49 Kommenttityypin valinta Kommentin kirjoittaminen muokkausnäkymässä 45

50 Kommenttiin vastaaminen Käyttäjä selaa kommenttinäkymässä tai muokkausnäkymässä kommentteja. Kommenttiin vastatessa avautuu kommentti ja siihen liittyvä keskustelu muokkausnäkymään. Lisäksi muokkausnäkymään avautuu tekstikenttä, johon vastaus kirjoitetaan. Jos käyttäjä selaa kommentteja muokkausnäkymässä, vastaa toiminnon klikkaaminen avaa kommenttien viereen vastaamiseen tarkoitetun tekstikentän. Näin selaamalla käyttäjä voi valita kommenttipuusta juuri tietyn yksittäisen viestin, johon haluaa vastata. Vastauksen kirjoittaminen kommenttiin 46

51 6.3. Kommentin muokkaus ja poisto Kommentin tai viestin muokkaaminen Käyttäjä selailee kommentteja kommenttinäkymässä ja voi muokata omaa kommenttiaan, mikäli siihen ei ole vastattu. Muokattava kommentti tulostuu muokkausnäkymän oikeassa laidassa olevaan tekstikenttään, missä sitä voidaan muokata. Jos käyttäjä selaa kommentteja muokkausnäkymässä, muokkaa toiminnon klikkaaminen avaa tekstikentän muokattavine kommentteineen kommenttien viereen. Kommentin muokkaaminen Kommentin/viestin poistaminen Kun kommentin kohdalla klikataan poista nappia, niin esiin ponnahtaa ikkuna, joka varmistaa käyttäjältä, että kommentti halutaan varmasti poistaa. Katso myös luku Kommentti on mahdollista poistaa kommentti, muokkaus sekä kaikkien kommenttien selaus näkymästä. Tavalliset käyttäjät voivat poistaa vain omia viestejään, sillä ehdolla että poistettava 47

52 viesti täytyy olla ketjunsa ainoa tai viimeinen viesti. Adminoikeuksilla on mahdollista poistaa kenen tahansa viestejä mistä kohtaa tahansa. Kun käyttäjä on vastannut ponnahdusikkunan kysymykseen, ladataan uudestaan se näkymä, jossa käyttäjä painoi poista painiketta, mikäli poistaminen tapahtui. Muussa tapauksessa suljetaan ponnahdusikkuna eikä mitään tarvitse ladata uudestaan. Varmistuksen kysely 6.4. Virhetilanteet Käyttäjälle voi olla tarpeen ilmoittaa virheestä kommenttia tai viestiä lisättäessä, muokattaessa tai poistettaessa. Se voi olla tarpeellista myös kommentointia pois/päälle kytkettäessä. Jos dokumentti on poistettu, käyttäjä siirretään sivulle jolla ilmoitetaan asiasta. Jos viesti, jota käyttäjä yrittää muokata tai johon hän yrittää vastata on poistettu, sivu ladataan uudestaan. Päivitetyllä sivulla näkyy dokumentti ja ilmoitus siitä, että käsiteltävänä oleva viesti oli poistettu. Virheilmoitus Sivun ylälaitaan punaisella tulostuvassa virheilmoituksessa on lyhyt ja selkeä kuvaus ongelmasta. Kommentin tai viestin tallentamisen yhteydessä voi tulla eteen tilanne, jossa dokumentin avaamisen jälkeen dokumenttia on muutettu juuri siitä paikasta, mihin kommentti halutaan lisätä. Silloin ladataan sivu uudestaan ja kerrotaan edellisen kaltaisella virheilmoituksella siitä, että dokumenttia on muutettu. Kommentointi on tietysti mahdollista tämän uudelleenlataamisen jälkeen. Virheilmoituksen teksti: Dokumenttia on muutettu käsittelemästäsi kohdasta ja se on nyt ladattu uudestaan. Voit lisätä kommenttisi nyt. Virhetilanne on mahdollinen kommentin tai viestin lisäämisen lisäämisen ja muokkaamisen ja poistamisen yhteydessä. 48

53 6.5. Kommentoinnin kytkeminen päälle ja pois Kun käyttäjä, jolla ei ole oikeuksia kommentoinnin päälle/pois laittamiseen, katselee sivua ja kommentointi on päällä, niin sivun ylälaidassa lukee Maalaa alue, jota haluat kommentoida, mutta muutoin ylälaidassa ei lue mitään. Kun käyttäjällä on oikeudet kytkeä kommentointi päälle tai pois päältä, niin sivun ylälaidassa on sitä varten kaksi radiopainiketta, joita klikkaamalla kommentointiominaisuuden saa päälle tai pois käytöstä. Mikäli kommentointi on käytössä, käytössä teksti on maalattu vihreällä ja lihavoitu. Jos taas kommentointi ei ole päällä, teksti ei käytössä on maalattu punaisella ja lihavoitu. Kommentoinnin kytkeminen 6.6. Tulostaminen Tulostusikkunassa alkuperäinen dokumentti näkyy ilman annotointiin liittyviä värikoodeja. Kohdat, joihin on lisätty kommentti/viestejä, on maalattu harmaalla taustavärillä ja jokaisen maalauksen perään on lisätty yläindeksiksi numero. Kommentin numero viittaa tulostesivun lopussa oleviin varsinaisiin kommentteihin. Tulostusikkuna avataan uuteen selainikkunaan Ohjeikkuna Ohjeikkuna avautuu sivun ylälaidassa olevasta ohje linkistä. Ohjeessa kerrotaan lyhyesti mikä Mooan on ja miten sitä voidaan käyttää. Perusteellisemmat käyttöohjeet ja tiedot Mooanohjelmistosta löytyvät varsinaisesta käyttöohjeesta. 49

54 Ohjeikkuna 50