sfia - software for inspection automation versio 1.0

Käyttöohje

Vesa Tenhunen
Joensuun yliopisto
Tietojenkäsittelytieteen laitos

12.12.2001

Sisällys

1 Esittely
  1.1 Ohjelman käyttö
    1.1.1 Käynnistäminen
    1.1.2 Dokumentin avaaminen
    1.1.3 Dokumentissa liikkuminen
    1.1.4 Huomautuksen lisääminen
    1.1.5 Huomautuksen muokkaaminen/näyttäminen
    1.1.6 Huomautuksen poistaminen
    1.1.7 Huomautusten tallentaminen
    1.1.8 Huomautuslista
    1.1.9 Raportointi
    1.1.10 Ohjelman lopettaminen
  1.2 Esimerkki ohjelman käytöstä

2 Ohjelman toiminnot
  2.1 Tiedosto-valikko
    2.1.1 Avaa
    2.1.2 Tallenna
    2.1.3 Sulje
    2.1.4 Luo raportti
    2.1.5 Lopeta
  2.2 Muokkaa-valikko
    2.2.1 Kieli
    2.2.2 Huomautusmerkin koko
    2.2.3 Rajoitteet käytössä
    2.2.4 Merkitse kaikki huomautukset käsittelemättömiksi
  2.3 Näytä-valikko
    2.3.1 Valitse tarkastajat
    2.3.2. Huomautuslista
    2.3.3 Arvot ja selitteet
  2.4 Ohje-valikko
    2.4.1 Ohje
    2.4.2 Tietoja ohjelmasta
  2.5 Huomautuslista
  2.6 Muokkausikkuna
  2.7 Hiiritoiminnot

3 Tiedostojen käsittely
  3.1 Dokumenttitiedosto
  3.2 Huomautustiedosto
  3.3 GIF-tiedosto

4 Asentaminen

1 Esittely

sfia (software for inspection automation) on dokumenttien ja ohjelmakoodin tarkastamisen apuväline.

sfia:lla voidaan tarkastaa kaikissa ohjelmistotuotannon prosessin vaiheissa erilaisia dokumentteja ja ohjelmakoodeja, joiden sivut on muutettu gif-muotoisiksi kuvatiedostoiksi. Tarkastaja voi lisätä asiakirjoihin erilaisia huomautuksia ja asettaa niille erilaisia valmiita arvoja dokumentin tekijän mahdollisesti määrittelemistä luokituksista. Ohjelmisto ei aseta rajoituksia tarkastajien tai huomautusten määrälle.

sfia:n avulla tarkastajat voivat poistaa tai muokata tekemiään huomautuksia sekä katsoa muiden tekemiä huomautuksia. Dokumentin tekijä voi käydä läpi kaikkien tarkastajien tekemät huomautukset, muokata niitä, asettaa käsittelyn tila sekä tehdä niistä erilaisia raportteja.

sfia toimii Unix-, Linux-, Windows- ja Macintosh-käyttöjärjestelmissä. Macintoshissa sfia ei kuitenkaan tue hakemistonimiä, joissa on välilyöntejä.

1.1 Ohjelman käyttö

1.1.1 Käynnistäminen

Unix/Linux:

Käynnistä ohjelma kirjoittamalla komentoriville

  wish sfia.tcl &

Jos olet määritellyt wish-tulkin hakupolkuun, voit käynnistää ohjelman pelkällä komennolla

  sfia.tcl &

Windows:

Tcl/Tk rekisteröityy asennuksen yhteydessä siten, että voit lisätä ohjelman Käynnistä (Start) -valikkoon. Katso tarvittava menettely Windowsin ohjeesta. Voit myös käynnistää ohjelman kaksoisnapsauttamalla sfia.tcl-tiedostoa Resurssienhallinnan (Windows Explorer) tai Oman tietokoneen (My Computer) ikkunassa. Kolmantena vaihtoehtona voit käyttää Käynnistä-valikon komentoa Suorita (Run).

Ohjelmaikkuna käynnistyksen jälkeen.

1.1.2 Dokumentin avaaminen

Valitse Tiedosto/Avaa... ja etsi haluamasi .ddf-tiedosto (Document Definition File, dokumentin määrittelytiedosto). Napsauta Avaa-painiketta, jolloin ohjelma lukee tiedoston sisällön. Ohjelma etsii sen jälkeen automaattisesti dokumenttiin liittyvän .dcf-huomautustiedoston (Document Comment File, dokumentin huomautustiedosto) ja lukee myös sen tiedot. Jos tiedostoissa oli virhe, ohjelma näyttää virheilmoituksen; muussa tapauksessa se tuo näkyville dokumentin ensimmäisen sivun mahdollisine huomautuksineen.

Avaa-valintaikkuna.

Jos ohjelman työtilassa on jo avattu dokumentti ja sen huomautuksiin on tehty muutoksia, ohjelma kysyy luvan muutosten tallentamiseen ennen uuden tiedoston avausta.

1.1.3 Dokumentissa liikkuminen

Pääikkunan alareunassa on neljä navigointipainiketta, joilla voit liikkua sivulta toiselle. Painikkeet toimivat seuraavasti:

|<
ensimmäiselle sivulle

<
edelliselle sivulle

>
seuraavalle sivulle

>|
viimeiselle sivulle

Näiden lisäksi voit siirtyä suoraan haluamallesi sivulle kirjoittamalla sivun numeron painikkeiden vieressä olevaan kenttään ja painamalla Enter-näppäintä.

1.1.4 Huomautuksen lisääminen

Voit lisätä sivulle huomautuksen kaksoisnapsauttamalla hiiren vasemmanpuoleista painiketta. Ohjelma lisää napsautuskohtaan punaisen huomautusmerkin ja aukaisee näkyville muokkausikkunan. Ikkunassa ovat valmiina käyttäjätunnuksesi, päivämäärä ja kellonaika sekä sen sivun numero, jolla huomautus sijaitsee. Varsinaiselle huomautukselle on tekstikenttä, johon voit kirjoittaa haluamasi pituisen tekstin.

Jos dokumentin tekijä on määritellyt erilaisia luokituksia huomautuksille, ne näkyvät radionappiryhminä huomautuskentän alla. Voit valita niistä haluamasi arvot.

Muokkausikkuna.

1.1.5 Huomautuksen muokkaaminen/näyttäminen

Voit muokata vain itse tekemiäsi huomautuksia. Napsauta huomautusmerkkiä hiiren oikeanpuoleisella painikkeella ja valitse komento Muokkaa (jos huomautus on sinun tekemäsi) tai Näytä (jos huomautus on jonkun muun tekemä). Ohjelma avaa huomautuksen muokkausikkunan, jossa voit joko

muuttaa tekstiä ja luokituksia (jos huomautus on sinun tekemäsi),
katsella huomautuksen tietoja (jos huomautuksen tekijä on joku muu) tai
muokata tekstiä ja vaihtaa käsittelyn tilan (jos olet dokumentin tekijä)

Dokumentissa näkyvien huomautusmerkkien värit vaihtelevat käyttäjän aseman mukaan seuraavasti:

Et ole dokumentin tekijä:
	Sinun lisäämä huomautus (punainen)
	Jonkun muun lisäämä huomautus (violetti)
Olet dokumentin tekijä tai tarkastustilaisuuden kirjuri:
	Huomautus, jota et ole vielä käsitellyt (punainen)
	Huomautus, jonka olet huomioinut, mutta et käsitellyt (keltainen)
	Huomautus, jonka olet jo käsitellyt (vihreä)

Dokumentin tekijänä voit käsitellä eri tarkastajien tekemiä huomautuksia ja asettaa niiden tilan muokkausikkunassa (voit tehdä sen myös napsauttamalla huomautusmerkkiä hiiren oikeanpuoleisella painikkeella ja valitsemalla haluamasi vaihtoehdon esiin tulevasta valikosta).

Lopuksi voit sulkea ikkunan ja mahdollisesti hylätä tai hyväksyä muutokset.

1.1.6 Huomautuksen poistaminen

Samoin kuin muokkaamisessa, myös poistaminen onnistuu vain itse tekemiesi huomautusten osalta. Napsauta merkkiä hiiren oikeanpuoleisella painikkeella ja valitse komento Poista. Ohjelma kysyy varmistuksen ja poistaa merkin, jos annat siihen luvan.

Huomautusmerkin poiston varmistus.

1.1.7 Huomautusten tallentaminen

Valitse komento Tiedosto/Tallenna. Ohjelma tallentaa kaikki huomautustiedot tiedostoon, jonka nimi muodostuu dokumentin nimestä ja käyttäjätunnuksestasi. Jos huomautustiedosto oli jo olemassa (ja sen tiedot oli luettu dokumentin avauksen yhteydessä), ohjelma kirjoittaa uudet tiedot entisten päälle. Jos tiedostoa ei ollut, ohjelma luo sen.

1.1.8 Huomautuslista

Huomautuslista on erillinen ikkuna, jossa näkyvät kaikki dokumentin sivut numeroina ja niiden alla kyseisellä sivulla olevat huomautukset. Voit napsauttaa sivunumeroa siirtyäksesi dokumentissa valitsemallesi sivulle. Napsauttamalla huomautusta pääset muokkaamaan tai katselemaan sitä muokkausikkunassa.

Pelkkä kohdistimen vieminen huomautuksen päälle korostaa huomautustekstin listassa, huomautusmerkin dokumentti-ikkunassa sekä huomautustiedot muokkausikkunassa (jos se on avattuna).

Huomautuslistaikkuna.

1.1.9 Raportointi

Valitse Tiedosto/Raportti -kohdan alavalikosta joko Kaikki huomautukset tai Yhteenveto.

Ensimmäinen komento tekee raportin, jossa näkyvät kaikkien huomautusten tiedot: tarkastaja, päiväys, sivu jolla huomautus sijaitsee, huomautusteksti, mahdolliset luokitukset sekä käsittelyn tila. Jälkimmäinen komento tekee raportin, johon on taulukoitu huomautusten yhteismäärät laskettuna mahdollisten luokitusten ja käsittelyn tilojen mukaan.

Voit halutessasi tallentaa raportin tai tulostaa sen.

1.1.10 Ohjelman lopettaminen

Valitse komento Tiedosto/Lopeta. Jos tietoja on muutettu, ohjelma kysyy luvan niiden tallentamiseen.

1.2 Esimerkki ohjelman käytöstä

Seuraavssa on kuvattu eräs tavallinen ohjelman käyttötapaus eri tilanteissa ja eri käyttäjillä:

Dokumentin tekijä muuntaa haluamillaan välineillä asiakirjan sivut gif-muotoisiksi kuviksi ja kirjoittaa ddf-tiedoston, johon hän määrittelee dokumentin tietosisällön sekä luokitukset erilaisille huomautuksille. Tekijä lähettää kuvatiedostot sekä ddf-tiedoston yhdelle tai useammalle tarkastajalle.

Kukin tarkastaja käy läpi dokumentin ja lisää huomautuksia tarpeellisiksi katsomiinsa kohtiin. Samalla hän merkitsee huomautusten lajin valitsemalla sopivat luokitusten arvot. Lopuksi hän tallentaa huomautukset ja lähettää tallennuksen yhteydessä syntyneen huomautustiedoston takaisin dokumentin tekijälle.

Dokumentin tekijä kokoaa kaikki huomautustiedostot yhdeksi tiedostoksi siten, että se avautuu dokumentin mukana. Hän käy läpi huomautukset ja muuttaa niiden tilan sen mukaan, onko käsitellyt vai huomioinut huomautuksen ja lisää tarvittaessa huomautusteksteihin omia kommenttejaan. Tekemällä raportteja tekijä voi helposti nähdä huomautusten tilat ja määrät. Lopuksi tekijä tallentaa huomautukset ja ottaa tarvittavat tiedostot mukaan tarkastustilaisuuteen.

Tarkastustilaisuudessa tekijä ja tarkastajat käyvät läpi dokumenttia. Kirjuri avaa dokumentin ja poistaa rajoitukset, jonka jälkeen hän pystyy muokkaamaan ja poistamaan huomautuksia sitä mukaa kuin tarkastuksessa päätetään sekä asettamaan samalla niiden tilan. Kirjuri tekee myös halutun määrän raportteja huomautuksista ja niiden yhteenvetotiedoista. Lopuksi käsitellyt huomautukset tallennetaan ja annetaan tekijälle.

Tekijä avaa dokumentin, poistaa rajoitukset ja merkitsee kaikki huomautukset käsittelemättömiksi. Tämän jälkeen hän käy huomautukset läpi ja tekee muutokset alkuperäiseen asiakirjaansa.

2 Ohjelman toiminnot

Seuraavassa käydään läpi ohjelman valikkokomennot, ikkunat ja hiiritoiminnot.

2.1 Tiedosto-valikko

2.1.1 Avaa

Komento näyttää valintaikkunan, josta voit selata levyasemia, hakemistoja ja tiedostoja. Ohjelma rajoittaa näytettävät tiedostot niihin, joiden tunnus on .ddf (Document Definition File eli dokumentin määrittelytiedosto). Kun valitset haluamasi dokumenttitiedoston ja avaat sen, ohjelma lukee tiedoston sisällön.

Avaa-valintaikkuna.

Jos tiedoston lukemisessa tapahtuu virhe, ohjelma ilmoittaa siitä kertoen, tapahtuiko virhe itse lukuoperaatiossa vai oliko tiedoston sisällössä vikaa. Kun olet kuitannut virheilmoituksen, voit yrittää uudelleen avata joko saman tai eri tiedoston.

Jos dokumenttitiedoston lukeminen onnistuu virheittä, ohjelma etsii automaattisesti dokumenttiin liittyvää huomautustiedostoa samasta hakemistosta. Huomautustiedoston tunnus on .dcf (Document Comment File, dokumentin huomautustiedosto) ja sen nimi koostuu tavuviivan erottamasta dokumentin nimestä ja käyttäjätunnuksesta (esim. käyttäjä Matti Meikäläinen on kirjautuneena tunnuksella mmeika ja hän avaa dokumentin nimeltä asiakirja.ddf, jolloin huomautustiedoston nimeksi tulee asiakirja-mmeika.dcf). Ohjelma lukee olemassaolevan huomautustiedoston sisällön ja ilmoittaa samalla tavalla virheistä kuin dokumenttitiedostonkin kohdalla. Puuttuva huomautustiedosto ei aiheuta toimenpiteitä: ohjelma luo sellaisen siinä vaiheessa kun tallennat tekemäsi huomautukset.

2.1.2 Tallenna

Komento tallentaa kaikkien dokumentissa olevien huomautusten tiedot huomautustiedostoon, jonka nimeäminen on kuvattu jo edellä. Jos huomautustiedostoa ei alunperin ollut, ohjelma luo sen samaan hakemistoon missä dokumenttitiedostokin sijaitsee.

Jos tiedoston kirjoittamisessa tapahtuu virhe, ohjelma antaa siitä ilmoituksen. Voit sen jälkeen yrittää tallennusta uudelleen.

2.1.3 Sulje

Komento sulkee nykyisen dokumentin, mutta ei lopeta ohjelman suoritusta. Jos tietoja on muutettu, ohjelma kysyy luvan niiden tallentamiseen.

2.1.4 Luo raportti

Ohjelmalla voi luoda kahdenlaisia raportteja: raportti kaikista huomautuksista tai yhteenvedosta.

Komento Kaikki huomautukset tuo näkyviin ikkunan, jossa on listattu alekkain kaikki dokumentista löytyvät huomautukset. Ohjelma kirjaa raporttiin jokaisesta huomautuksesta seuraavat tiedot:

tarkastajan tunnus
tekopäivämäärä
sivun numero, jolla huomautus sijaitsee
huomautusteksti
kaikkien luokitusten arvot
käsittelyn tila

Kaikki huomautukset -raportti.

Komento Yhteenveto näyttää ikkunan, jossa kaikkien dokumentin huomautuksien määrät on laskettu yhteen luokitusten ja käsittelyn tilan mukaan. Jos dokumentin tekijä ei ole määritellyt luokituksia, raportti näyttää vain huomautusten käsittelyn tilat.

Yhteenveto-raportti.

Molemmissa raportti-ikkunoissa on painikkeet raportin tallentamiseksi sekä tulostamiseksi. Tallennuspainikkeen napsautus avaa Tallenna-valintaikkunan, jossa voit valita raportin tallennuspaikan sekä tiedostonimen. Ohjelma tallentaa raportin ASCII-muotoisena tekstitiedostona.

Tulosta-komentoon liittyy painikkeen vieressä oleva tekstikenttä, johon voit kirjoittaa tulostuskomennon. Oletuksena on lpr, mutta voit muuttaa tilalle periaatteessa minkä tahansa Unix/Linux-järjestelmän komennon. Tulostaminen ei toimi Windows- eikä Macintosh-käyttöjärjestelmissä.

2.1.5 Lopeta

Komento sulkee nykyisen dokumentin ja lopettaa ohjelman suorituksen. Jos tietoja on muutettu, ohjelma kysyy luvan niiden tallentamiseen.

2.2 Muokkaa-valikko

2.2.1 Kieli

Kielen alavalikosta voit valita ohjelman käyttöliittymän kielen. Vaihtoehtoina ovat suomi ja englanti, joista ensimmäinen on oletuskieli. Voit vaihtaa kielen milloin tahansa ohjelman suorituksen aikana ja muutos tapahtuu välittömästi.

2.2.2 Huomautusmerkin koko

Dokumentissa näkyvien pyöreiden huomautusmerkkien koon voit valita viidestä eri vaihtoehdosta: pienin, pieni, keskikoko, suuri ja suurin. Oletuksena on keskikoko, mutta voit muuttaa koon milloin tahansa ohjelman suorituksen aikana, kunhan olet ensin avannut jonkin dokumentin. Muutos tapahtuu välittömästi.

Huomautusmerkin koot.

2.2.3 Rajoitteet käytössä

Komento vaihtaa rajoitteiden tilan. Rajoitteet tarkoittavat käyttäjän tilan mukaan määräytyviä käyttöoikeuksia: esim. tarkastajana saat poistaa tai muokata vain itse lisäämiäsi huomautuksia; dokumentin tekijänä et voi muuttaa tarkastajien asettamia huomautusten luokituksia jne. Ottamalla rajoitteet pois käytöstä pääset käsiksi kaikkiin huomautuksiin samalla tavalla kuin ne olisivat sinun tekemiä.

Normaalisti rajoitukset ovat käytössä ja niiden poistaminen on tarkoitettu vain tarkastustilaisuuden kirjurille, joka voi näin muuttaa huomautuksia (esim. poistaa päällekkäiset huomautukset).

2.2.4 Merkitse kaikki huomautukset käsittelemättömiksi

Komento on toiminnassa vain silloin, kun rajoitukset eivät ole käytössä (katso edellinen luku). Komennolla voit muuttaa kaikkien dokumenttiin lisättyjen huomautusten tilaksi "käsittelemättä", riippumatta siitä mikä huomautusten sen hetkinen tila on. Toiminto on tarkoitettu tehtäväksi sen jälkeen, kun olet dokumentin tekijänä saanut tarkastustilaisuudessa käsitellyn dokumentin takaisin korjattavaksi.

2.3 Näytä-valikko

2.3.1 Valitse tarkastajat

Komento avaa näkyville ikkunan, jossa voit valita keiden tarkastajien tekemät huomautukset haluat näkyville. Valinnan hyväksynnän jälkeen et enää näe valitsemattomien tarkastajien huomautusmerkkejä dokumentissa etkä tekstejä huomautusikkunassa. Jos jätät valitsematta oman tunnuksesi, et pysty lisäämään uusia huomautuksia ennen kuin käyt valitsemassa oman tunnuksesi uudelleen näytettäväksi.

Valitse tarkastajat -ikkuna.

2.3.2. Huomautuslista

Komento palauttaa näkyville huomautuslistan (katso luku 2.5), jos olet sulkenut sen.

2.3.3 Arvot ja selitteet

Jos dokumentin tekijä on määritellyt yhden tai useamman huomautusluokituksen, tämä komento näyttää ikkunan, jossa on lueteltu kaikki luokat, niiden sisältämät arvot sekä niiden selitykset.

Arvot ja selitteet -ikkuna.

2.4 Ohje-valikko

2.4.1 Ohje

Komento näyttää ikkunan, jossa on kerrottu lyhyesti ohjelman toiminnot. Se vastaa suunnilleen tämän käyttöohjeen luvun 1 sisältöä.

2.4.2 Tietoja ohjelmasta

Komento näyttää ikkunan, jossa on ohjelman tekijänoikeustiedot.

Tietoja ohjelmasta -ikkuna.

2.5 Huomautuslista

Huomautuslista on erillinen ikkuna, jossa näkyvät dokumenttiin tehtyjen huomautuksien teksti yhdessä huomautuksen tehneen tarkastajan tunnuksen kanssa. Huomautusten järjestys määräytyy sivulla olevien merkkien mukaan (ylhäältä vasemmalta alas oikealle). Lisäksi listassa on dokumentin sivunumerot, joiden alla on aina kyseisen sivun huomautukset.

Huomautuslistaikkuna.

Jos olet rajannut huomautusten näkymistä Näytä/Valitse tarkastajat... -komennolla (katso luku 2.3.1), valitsematta jääneiden tarkastajien huomautukset eivät näy listassa.

Kaikki huomautuslistan tiedot toimivat linkkeinä. Napsauttamalla sivunumeroa pääset siirtymään dokumentissa kyseiselle sivulle. Napsauttamalla huomautustekstiä ohjelma avaa huomautuksen muokkausikkunan (katso seuraava luku), jossa voit joko

muuttaa tekstiä ja luokituksia (jos huomautus on sinun tekemäsi),
katsella huomautuksen tietoja (jos huomautuksen tekijä on joku muu) tai
muokata tekstiä ja vaihtaa käsittelyn tilan (jos olet dokumentin tekijä)

Samalla ohjelma tuo näkyville sivun, jolla ko. huomautus sijaitsee.

Jos siirryt dokumentissa sivulta toiselle navigointipainikkeiden tai -kentän avulla ja haluat nähdä huomautuslistassa kyseisen sivun huomautustietoja, napsauta kerran jotakin sivulla olevaa huomautusmerkkiä hiiren vasemmanpuoleisella painikkeella. Huomautuslistan näkymä vierittyy tällöin siten, että valittu huomautus tulee näkyviin. Voit tietysti käyttää myös huomautuslistan vieritysnauhaa.

2.6 Muokkausikkuna

Muokkausikkuna on huomautustietojen muokkaukseen ja katseluun tarkoitettu ikkuna. Saat muokkausikkunan esille kun

kaksoisnapsautat hiiren vasemmanpuoleisella painikkeella jotakin kohtaa dokumentin sivulla, jolloin lisäät uuden merkin
napsautat hiiren oikeanpuoleisella painikkeella olemassa olevaa huomautusmerkkiä ja valitse komennon Muokkaa tai Näytä
napsautat hiiren vasemmanpuoleisella painikkeella huomautuslistassa näkyvää huomautuksen tekstiä

Muokkausikkuna.

Voit avata muokkausikkunoita niin monta kuin haluat, mutta kuitenkin vain yhden kutakin huomautusta kohden.

Muokkausikkuna koostuu kolmesta tai neljästä eri osasta. Ensimmäisenä ylimpänä näet huomautustiedot: tarkastajan tunnuksen, luomispäivämäärän ja -kellonajan sekä sivunumeron, jolla huomautus sijaitsee. Näiden tietojen alapuolella on toisena osana tekstikenttä, jossa näkyy varsinainen huomautusteksti. Jos olet kyseisen huomautuksen lisännyt tarkastaja tai dokumentin tekijä, voit muokata tekstiä. Kolmas osa on huomautustekstin alla oleva yksi tai useampi huomautusluokka (jos dokumentin tekijä ei ole määritellyt yhtään luokkaa, tämä osa jää näkymättä). Kukin luokka näkyy omassa kehyksessään ja arvot ovat radionappeina, jolloin voit valita yhden kohdan kustakin luokasta. Jos olet dokumentin tekijä, näet lisäksi käsittelyn tila -nimisen luokan, josta voit valita huomautuksen tilan sen mukaan, oletko käsitellyt, huomioinut tai jättänyt käsittelemättä huomautuksen. Neljäntenä ja alimpana ovat komentopainikkeet, joilla voit hyväksyä muutokset ja sulkea ikkunan, hyväksyä muutokset mutta jättää ikkunan auki tai sulkea ikkunan hyväksymättä muutoksia. Kahden ensimmäisen painikkeen aktiivisuus riippuu oikeuksistasi muokata huomautusta.

Jos jätät muokkausikkunan tekstikentän tyhjäksi, ohjelma olettaa ettet halua tehdä huomautusta ja kysyy haluatko poistaa huomautusmerkin. Vastaamalla ei huomautus jää olemaan, vaikka siinä ei olekaan tekstiä.

2.7 Hiiritoiminnot

Ohjelman käytössä tarvitaan normaalien graafisten käyttöliittymien ohjaamiseen liittyvien toimintojen lisäksi seuraavia:

Kohdistimen vienti huomautusmerkin päälle:

Kohdistimen vienti huomautuslistan huomautustekstin päälle:

Kohdistimen vienti muokkausikkunan päälle:

Hiiren vasemmanpuoleisen painikkeen napsautus huomautusmerkin päällä:

Hiiren vasemmanpuoleisen painikkeen napsautus huomautuslistassa olevan sivunumeron päällä:

Hiiren vasemmanpuoleisen painikkeen napsautus huomautuslistassa olevan huomautustekstin päällä:

Hiiren oikeanpuoleisen painikkeen napsautus huomautusmerkin päällä:

3 Tiedostojen käsittely

3.1 Dokumenttitiedosto

Dokumenttitiedosto on puhdasta ASCII-tekstiä sisältävä tiedosto, jonka sisältö määrittää ohjelmassa näytettävän dokumentin. Dokumentissa käytetään HTML:n tapaista koodia:

<VERSION> 1.0 <AUTHOR> tunnus <DATE> 31.07.2001 19.55	Versionumeron tulee olla sama tai pienempi kuin käytettävänä olevan ohjelman versionumero Tunnus on oma käyttäjätunnuksesi Dokumentin luontipäivämäärä näkyy raporteissa
<PAGES> <!-- dokumentin sivuina näytettävät kuvat --> cocomo_01.gif cocomo_02.gif cocomo_03.gif cocomo_04.gif </PAGES>	Voit lisätä huomautuksia selventämään tiedoston sisältöä Gif-kuvien järjestyksen on oltava oikea; ohjelma ei järjestele niitä mitenkään
<!-- huomautusten vikaluokitukset --> <CLASSIFICATION> <CLASS> <NAME> Vakavuus <VALUE> Mitätön <LEGEND> Ei vaikuta mihinkään <VALUE> Kohtalainen <LEGEND> Tulee vikaraportti ja maksaa paljon <VALUE> Suuri <LEGEND> Koko projekti menee nurin </CLASS> <CLASS> <NAME> (...) </CLASS> </CLASSIFICATION>

Toistaiseksi dokumenttitiedosto on kirjoitettava käsin. Tiedoston tunnisteen on oltava .ddf (Document Definition File, dokumentin määritystiedosto), sillä ohjelma ei huomioi muita tiedostoja.

3.2 Huomautustiedosto

Huomautustiedosto on dokumenttitiedoston tapaan puhdasta ASCII-tekstiä, mutta ohjelma luo sen itse: käyttäjän ei tarvitse (itse asiassa ei edes pidä) kirjoittaa siihen mitään. Huomautustiedoston tunniste on .dcf (Document Comment File, dokumentin huomautustiedosto). Huomautustiedoston nimi muodostuu tarkistettavan dokumentin nimestä sekä tavuviivan erottamasta tarkastajan tunnuksesta. Myös huomautustiedoston sisältö koostuu erilaisista HTML:n tapaisista koodeista, joiden avulla ohjelma osaa lukea ja jäsennellä tarvittavat tiedot.

Jokaisen tarkastajan huomautuksista syntyy erillinen huomautustiedosto. Jos haluat katsoa muiden tekemiä huomautuksia, tiedostot täytyy yhdistää siten, että yhdistetyssä tiedostossa on sinun tunnuksesi. Tämän voit tehdä Unix/Linux-järjestelmissä esim. komennolla cat tähän tapaan:

  cat doku-tark1.dcf doku-tark2.dcf doku-tark3.dcf > doku-omatunnus.dcf

Windows-ympäristössä sama onnistuu copy-komennolla:

  copy /a doku-tark1.dcf + doku-tark2.dcf + doku-tark3.dcf doku-omatunnus.dcf /v

3.3 GIF-tiedosto

Ohjelman näyttämä dokumentti muodostuu muiden tietojen lisäksi yhdestä tai useammasta gif-muotoisesta (Graphics Interchange Format, joka on järjestelmäriippumaton grafiikkatiedon esitystapa) kuvatiedostosta, joista jokainen kuva on yksi dokumentin sivu. Ohjelma ei rajoita mitenkään kuvien kokoa, muotoa tai lukumäärää. Ainoa ehto kuvien käytölle on, että niiden täytyy sijaita samassa hakemistossa dokumenttitiedoston (ja mahdollis(t)en huomautustiedosto(je)n) kanssa.

Asiakirjan muuntaminen gif-muotoisiksi kuviksi onnistuu esimerkiksi tämän ohjeen avulla.

4 Asentaminen

Käyttöjärjestelmästä riippumatta ohjelman asentamiseksi riittää pelkästään tiedoston sfia.tcl kopiointi haluamaasi hakemistoon.

Ohjelman käyttäminen edellyttää, että olet asentanut Tcl/Tk-ohjelmiston koneeseesi. Saat sen automaattisesti useimpien Linux-jakelupakettien mukana. Muihin käyttöjärjestelmiin, kuten Windowsiin, tarkoitetut versiot voit ladata asennusohjeineen esim. osoitteesta www.scriptics.com/software/.

Windows- ja Macintosh-järjestelmissä joudut tekemään ohjelmakoodiin yhden muutoksen: korjaa rivillä 24 oleva komento

  set m(kayttaja) $env(USER)

muotoon

  set m(kayttaja) omatunnus

missä omatunnus on haluamasi yksiosainen, pienillä kirjaimilla kirjoitettu käyttäjätunnus. Tallenna tiedosto muutoksen jälkeen.