Ylläpitodokumentti Mooan

Transkriptio

1 Ylläpitodokumentti 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 Asiakas Ilari Moilanen Sami Palhomaa Johtoryhmä Juha Taina Kotisivu

3 Sisällysluettelo 1. Johdanto Asennusohje Käynnistysohje Suunnitelman ylläpito Koodin ylläpito Testaus Tietokanta Ohjelmassa havaitut virheet ja puutteet...2

4

5 1.Johdanto Tämä dokumentti on tarkoitettu järjestelmän ylläpitäjälle ja jatkokehittäjälle. Dokumentti on tarkoitettu luettavaksi yhdessä suunnitteludokumentin ja ohjelmakoodin kanssa, siksi viittauksia on paljon. 2.Asennusohje Mooan ei ole itsenäisesti toimiva ohjelma vaan se on lisäosa, joka on tarkoitettu liitettäväksi johonkin HTML-sivuun tai -sivustoon, projektin puitteissa Moodle-oppimisalustaan. Järjestelmä on rakennettu toimimaan Moodlen version 1.6 kanssa ( alkaen laitoksella 1.5.4) eikä sillä ole järjestelmän suhteen lisävaatimuksia. (Vaatimusdokumentti.pdf luku 9) Asennus- integrointi- ja käyttöohje toimitetaan myös koodin myötä. Lisäksi käyttöohjeet ovat sekä ohjelmakoodissa että omana dokumenttinaan.(käyttöohje.pdf) Käyttöohje help.html Asennusohje install.txt 3.Käynnistysohje Järjestelmää ei tarvitse erikseen käynnistää, mooan-ominaisuus vain kytketään päälle tai pois päältä radiopainikkeesta. Dokumentin kirjoittaja/omistaja sekä ryhmän opettaja tai järjestelmän ylläpitäjä voi kytkeä ominaisuuden päälle tai pois dokumenttikohtaisesti. Kyseinen toimisto näkyy vain niille käyttäjille, joilla on oikeus käyttää sitä. 4.Suunnitelman ylläpito Päällekkäistä kommenteista pitää pysytä valitsemaan juuri oikea luettavaksi tai muokattavaksi. Kommentti olisi parempi merkitä luetuksi pienellä viiveellä, nyt se tapahtuu heti. Kommenttinäkymän sijoittelussa tulisi ottaa huomioon näytön reunat, nyt kommenttinäkymä saattaa sijoittua pahasti näytön reunan ulkopuolelle. Tulostusnäkymän ja kaikkien kommenttien näyttämisen toteutus. Kommenttikategorioita saattaa olla tarpeen luoda lisää. Nyt kategorioita on vain kaksi, oikeinkirjoitukselle ja sisällölle. Kommenttien suodatus saattaa olla tarpeen toteuttaa myöhempiin versioihin. Suodattaminen tarkoittaa, että kommenteista voidaan valita, mitkä tulevat näkyviin. Valinta voidaan suorittaa esimerkiksi kommentin ja viestin kirjoittajan tai kirjoitusajan mukaisesti. Samoin kommenttikategoria voi olla suodatusehtona. Olisi hyvä saada tuki muillekin kuin Gecko-pohjaisille selaimille. Jos MS todella pakkopäivittää kaikki IE:t IE7:ksi, saattaa olla selvittämisen arvoista, voiko sitäkään saada toimimaan kunnolla. Muokkaus ei onnistu bakunin:n Annotea-palvelimessa olevan virheen vuoksi. Muokatun kommentin replies -tiedostoa ei luoda uudestaan muokkauksen yhteydessä, jolloin kyseiseen viestin suoria lapsia viestipuussa ei voida poistaa. Tämän takia muokkaaminen on estetty 1

6 MOOAN_ANNOTEA_MODIFY_IS_BUGGED -vakion kautta. Ratkaisuna joko vaihtaa Annotea-palvelinta (ehkä toteuttaa oma?) tai korjata bugi. Vaatimusdokumentti dokumentin muokkaamattomien ja muokattujen kohtien kommenttien siirtäminen dokumentin uuteen versioon toimii joissakin tapauksessa. Edelleen kehittämistä(syy xpointer) Yleisen Xpointer-kirjaston toteuttaminen. Mieluiten C tai C++ tehokkuuden vuoksi ja rajapinnat selainten pluginina toimimiseen. 5.Koodin ylläpito Ohjelmakoodi on pyritty pitämään Moodlen koodausohjeiden mukaisena. Ohje löytyy sivulta Järjestelmän funktioiden nimet alkavat mooan_ -etuliitteellä samoin globaalien muuttujien nimet. 6.Testaus Testauksen rakenne ja testitapaukset on kuvattu dokumentissa Testaussuunnitelma. Testaussuunnitelman liiteosa sisältä myös testauksen tulokset. 7.Tietokanta Mooan tietokantafunktiot käyttävät Moodlen $db -globaalia suoraan. Ne pitäisi siirtää käyttämään Moodlen tietokantafunktioita sen sijaan, jotta Mooan toimisi aina kaikkien niiden tietokantojen kanssa, joiden kanssa Moodle toimii. 8.Ohjelmassa havaitut virheet ja puutteet Puutteita on jo lueteltu runsaasti ylläpito kohdassa. Päällekkäisten kommenttien tekeminen ei onnistu. Sen sijaan kommenttinäkymä avautuu kyseiseen kohtaan. 2