Käyttöohje Mooan Helsinki 04.09.2006 Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos
Kurssi 581260 Ohjelmistotuotantoprojekti (9+1op/6ov) Projektiryhmä Heikki Aitakangas Mika Holmström Kirsi Jokisalo Anni Kotilainen (keskeyttänyt) Esko Lehtonen Paula Urpilainen Ohjaaja Asiakas Ilari Moilanen Sami Palhomaa Johtoryhmä Juha Taina Kotisivu http://www.cs.helsinki.fi/group/mooan/
Sisällysluettelo 1.Johdanto...1 2.Sanasto...1 3.Käynnistysohje...1 4.Järjestelmän toiminnot...1 4.1.Kommentoinnin kytky päälle ja pois päältä...1 4.2.Sivun näyttäminen kommentteineen...2 4.3.Kommenttien lukeminen...2 4.4.Kommenttityypin valinta...3 4.5.Kommentin lisäys...3 4.6.Kommenttiin vastaaminen...4 4.7.Kommentin tai viestin poistaminen...5 5.Virheilmoitukset...6 6.Järjestelmän asennus...6
1. Johdanto Mooan-yksikkö on Moodle-oppimisalustan lisäosa. Se on annotointityökalu, jota käytetään wikiin tehtyjen dokumenttien yhteydessä. Kommentit voidaan lisätä suoraan asiayhteyteen ilman että varsinaista dokumenttia muokataan. Kommentit ovat ikään kuin omana kerroksenaan varsinaisen dokumentin päällä. Kommenttien paikat esitetään visuaalisesti eri väreillä kommentin tyypin ja sen mukaan, onko dokumentin avannut henkilö jo lukenut ne. Mooan-yksikkö on suunniteltu toimimaan ainakin Firefox 1.5 selaimissa. 2. Sanasto Moodle Annotointi Dokumentti Kommentti Järjestelmä Kommenttikategoria Keskustelu Muokkausnäkymä Kommenttinäkymä Opasteikkuna Viesti Oppimisalusta, jolla on gnu-lisenssi Dokumentin kommentointi. HTML-, XML, teksti- tai Wiki-sivu Moodle-oppimisalustalla Dokumenttiin tehty huomautus tai lisämerkintä. Ellei kontekstista muuta ilmene: projektin puitteissa toteutettava kommentointityökalu kokonaisuutena. Tähän ei lueta Moodlea. Kommentin luokka, esim. oikeinkirjoitus- tai sisältökommentti Kommenttiin liittyvät vastusviestit. Näkymä, josta voi lukea ja kirjoittaa kommentteja sekä viestejä. Näkymä, jossa voi lukea kommentteja ja keskusteluja Pieni ikkuna dokumentin ylälaidassa, joka kertoo annotointiominaisuudesta ja mahdollistaa sen päälle- ja poiskytkemisen. Kommenttiin tai viestiin kirjoitettu vastaus. Viestit muodostavat hierarkkisen puurakenteen kommentin ympärille. 3. Käynnistysohje Mooan-annotointityökalu on Moodle-oppimisalustan lisäosa, joka kytketään Moodle-dokumenttiin. Dokumentin omistajalla (siis kirjoittajalla), kurssin opettajalla ja sivuston ylläpidolla on oikeus kytkeä annotointiominaisuus dokumenttikohtaisesti päälle. 4. Järjestelmän toiminnot 4.1. Kommentoinnin kytky päälle ja pois päältä Dokumentin kirjoittaja, opettaja tai sivuston ylläpitäjä voi dokumenttikohtaisesti kytkeä annotointityökalun päälle tai pois päältä. Toimintoa varten sivun yläreunassa on ohjepalkki, jossa toiminnon radiopainikkeet sijaitsevat (Kuva1). Radiopainiketta klikkaamalla kommentoinnin tilaa voi vaihtaa: Kommentoinnin kytkeminen päälle: 1. Alkutilanne: Kommentointi on pois päältä. Kommentointi ei käytössä lihavoitu punaisella. 2. Toiminto: Klikataan radiopainiketta Kommentointi käytössä 1
3. Lopputila: Kommentointi käytössä lihavoitu vihreällä. Jos dokumenttiin on jo tehty kommentteja, ne ilmestyvät tekstiin korostettuina. Kommentoinnin kytkeminen pois päältä: 1. Alkutilanne: Kommentointi on päällä. Kommentointi käytössä lihavoitu vihreällä. Jos dokumenttiin on tehty kommentteja, ne näkyvät tekstissä korostettuina. 2. Toiminto: Klikataan radiopainiketta Kommentointi ei käytössä 3. Lopputila: Kommentointi ei käytössä lihavoitu punaisella. Kommenttien korostus poistuu tekstistä. Kuva1: Kommentoinnin kytkeminen ja sivun näyttäminen kommentteineen 4.2. Sivun näyttäminen kommentteineen Dokumenttia avattaessa sivulle jo tehdyt kommentit näkyvät eri väreillä visualisoituina. Uusi, lukematon sisältökommentti on vihreä, ja luettu sisältökommentti hieman vaaleamman vihreä. Lukematon oikeinkirjoituskommentti on korostettu violetilla, ja luettu oikeinkirjoituskommentti vaaleammalla violetilla. Kommentin tai viestin lisäämisen ja muokkaamisen jälkeen uusi kommentti näkyy visualisoituna uudeksi kommentiksi (Kuva1). 4.3. Kommenttien lukeminen Kommentteja voidaan lukea viemällä hiiren osoitin kommentoidun kohdan (värillisen tekstialueen) päälle. Kommentti näytetään vierityspalkilla varustettuna pikkuikkunassa. (Kuva2) Kommenttitekstin lisäksi kommentista esitetään se kirjoittaja ja kirjoitusajankohta. Rekisteröityneille käyttäjille näytetään myös linkki Vastaa. Linkit Muokkaa ja Poista näytetään kommentin kirjoittajalle, opettajalle sekä ylläpitäjälle. Muokkaa ja Poista -linkit eivät kuitenkaan näy kirjoittajalle, mikäli kommenttiin on jo tehty vastauksia. 2
Kuva2: Vastaa Poista linkit ja Suurenna 4.4. Kommenttityypin valinta Uuden kommentin lisäys aloitetaan maalaamalla hiirellä kommentoitava alue, jolloin esiin ponnahtaa valintaikkuna (Kuva3), josta voidaan valita tehdäänkö Sisältökommentti vai Oikeinkirjoituskommentti. Kommentoitava alue muuttuu keltaiseksi käsittelyn ajaksi. Kommenttityypin valintanappulan (Sisältö/Oikeinkirjoitus) klikkaaminen avaa kirjoitusikkunan sivun alalaidassa (Kuva4) Kuva3: Kommenttityypin valinta 4.5. Kommentin lisäys Kommentin lisäys aloitetaan kommenttityypin valinnalla (Luku 4.3). Valinta avaa kirjoitusikkunan sivun alalaidassa. Kommentin teksti kirjoitetaan tekstikenttään, ja valmis kommentti voidaan julkaista klikkaamalla julkaise -painiketta (Kuva4). 3
Kuva4: Uuden kommentin kirjoittaminen 4.6. Kommenttiin vastaaminen Rekisteröitynyt käyttäjä voi vastata kommenttiin eli kirjoittaa viestin. Vastaaminen aloitetaan näpäyttämällä kommentti-ikkunan linkkiä Vastaa, jolloin sivun alalaitaan avautuu muokkausikkuna. (Kuva5). Vastattava viesti vasemmalla on korostettu pohjavärillä. Kuva5 Kommenttiin vastaaminen 4
4.7. Kommentin tai viestin poistaminen Poista -linkistä kommentti viesteineen avautuu muokkausikkunaan. Poistettava kommentti tai viesti on reunustettu sinisellä ja sen tekstin väri on harmaa. Kommentin tai viestin poistoon kirjoittajalla on oikeus niin kauan kuin siihen ei ole vastattu. Opettajalla ja ylläpitäjällä on kuitenkin aina oikeus poistaa kommentteja ja niiden viestejä. Jos poistetaan kommentti, johon on vastattu, poistuu koko jäljessä oleva kommenttiketju: siis sekä kommentti, että sitä seuraavat viestit. Kommentin poistoon pyydetään aina varmistus. (Kuva6) Kuva 6: Kommentin poistaminen 5. Virheilmoitukset Virhetilanteissa virheilmoitus nähdään tavanomaisessa popup-ikkunassa. 6. Järjestelmän asennus 5