wiki:harjoitustyo/vaihtoehtoVinkkejaKirjoittamiseen
Last modified 5 years ago Last modified on 2013-01-25 21:11:05

Ohjelmointi 2 / Harjoitustyön suunnitelman kirjoittaminen

Tärkeää on että ohjaaja pystyy lukemaan suunnitelman opiskelijan WWW-sivulta ASENTAMATTA mitään ylimääräistä koneeseensa (ei siis joudu esim. Wordiä asentamaan). Selaimen ja PDF-lukijan olemassaoloon voi luottaa.

Harkitse kuitenkin vakavasti: suositeltavinta tapaa. Äärihätätilassa voi käyttää muita tapoja.

1. Vaihtoehtoisia tapoja harjoitustyön kirjoittamiseen

Tässä muut tavat suositeltavuusjärjestyksessä

  • HTML:nä esim. tekstieditorilla tai Eclipse EE:llä tai muulla HTML-editorilla
    • kuvat img-attribuutilla tyyliin: <img src="tietoja.png" alt="Kuva Tietoja-dialogista" />
  • Google Docs dokumenttina
    • files.txt:hen tässäkin tapauksessa julkaistun dokumentin linkki (ks Wiki-versio ja esimerkki alempana)
    • kuvat saa upotettua dokumenttiin
    • tämäkin on hyvä tapa ryhmätyössä kunhan julkaisee dokumentin editoitavaksi kaikille ryhmäläisille
  • tekstinä tekstieditorilla (esim ConText)
    • kuviin vain viitataan nimellä tyyliin: Kuva 1: tietoja.jpg
  • OpenOfficella (tällöin pitää tallentaa myös "tulostettu PDF")
    • kuvat normaalisti kuten OO:lla laitetaan
  • TeXillä (tällöin pitää tallentaa myös "tulostettu PDF")
    • kuvat kuten TeXillä normaalisti laitetaan
  • Wordillä (tällöin pitää tallentaa myös "tulostettu PDF")
    • kuvat normaalisti kuten Wordillä laitetaan

2. Miten kuvat suunnitelmaan?

  • suunnitelmaan tarvittavia kuvia voi piirtää aluksi käsin kynällä paperille. Tällöin kuvat pitää muuttaa digitaaliseen muotoon esim:
    • skannaamalla
      • Ohjeet Ricoh-monitoimilaitteilla skannaamiseen: Ohjeet
    • digikameralla
    • tms.
  • kuvat voi piirtää myös suoraan käyttöliittymiksi Eclipseen asennetulla WindowBuilderillä
    • tällöin kuvista pitää ottaa ruutukaappaus
      • esim: IrfanView käy tähän hyvin.
        • laita se ikkunan näkyville, josta haluat kaappauksen
        • aktivoi IrfanView (muista Alt-Tab)
        • valitse Options/Capture ja valitse sitten Object Selected ja Start
        • valitse ikkuna josta haluat kaappauksen
        • talleta samaan hakemistoon (tai sen alihakemistoon) missä files.txt on (mielellään tyyppinä .png)

3. Miten tehdään files.txt kussakin tapauksessa?

  • files.txt -tiedostossa pitää tällöin allekkain kirjoittaa
    • mahdollinen "tulostettu" .pdf -tiedosto
    • .txt, .html, .doc yms. itse kirjoitetut tiedostot
    • kaikki kuvatiedostot
    • jos piirretään WindowBuilderillä, niin kaikki syntyneet .java-tiedostot
    • huomaa että files txt:ssä hakemistomerkkinä PITÄÄ olla / (ei saa olla\) ja kommenttimerkkinä on yhtäsuuruusmerkki (=) eli tiedoston nimi ja selitys tulee erottaa

merkillä, ei millään mulla (esim ei miinusmerkillä: - ) =-merkin jälkeen on oltava välilyönti tai vähintään kaksi -- merkkiä (jos piirretään viiva).

  • esimerkki GoogleDocs-suunnitelman tekijälle files.txt:n sisällöstä:
    !https://docs.google.com/document/pub?id=14vgFfDWCUMeFGrZY6Wjcl4-vzm0HnVT1_cFs7wZv0S8 = Suunnitelma Google Docissa
    kuvat/paaikkunak.png = ohjelman pääikkunan (kp)
    kuvat/avaak.png      = kuva ohjelman alusta (käsin piirretty)
    kuvat/eiaukeak.png   = virheilmoitus jos tiedostoa ei ole (kp)
    
  • esimerkki files.txt Html:llä tehdystä suunnitelmasta:
    suunnitelma.html     = ht:n vaihe 1
    kuvat/avaak.png      = kuva ohjelman alusta (käsin piirretty)
    kuvat/eiaukeak.png   = virheilmoitus jos tiedostoa ei ole (kp)
    kuvat/paaikkunak.png = ohjelman pääikkunan (kp)
    
  • esimerkki files.txt OpenOffice-tekijälle:
    suunnitelma.pdf = suunnitelman tulostettu versio 
    suunnitelma.odt = OO:lla kirjoitettu suunnitelma
    tietoja.jpg     = tietoja-dialogin kuva (kuvat piirretty käsin ja skannattu)
    kysy.jpg        = tiedoston nimen kysymisen kuva
    kaytto.jpg      = kuva varsinaisesta käytöstä
    

4. Miten palautetaan demon 1 tehtävä 1-4 kussakin tapauksessa?

  • jos suunnitelman voi lukea vain yhdestä tiedostosta (esim PDF), niin tämä voidaan palauttaa NettiDemoWWW:llä sellaisenaan (ei .doc tai .odt)
  • muuten palautetaan suunnitelman pääikkunan kuva ja sen kommentiksi oman työn "julkaisupaikan"-linkkiin tyyliin:
    http://users.jyu.fi/~vesal/ohj2/
    
    eli NettiDemoWWW:hen tuleva rivi on esimerkiksi
    TIEDOSTO            TEHTÄVÄ 	PISTEET 	KOMMENTTI
    paaikkunak.png      1-4         4               https://trac.cc.jyu.fi/projects/ohj2k12/wiki/vesal