wiki:harjoitustyo/vinkkeja
Last modified 22 months ago Last modified on 2015-12-26 22:50:41

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.

1. Suunnitelman kirjoittaminen Wikiin

  • suunnitelma kirjoitetaan kurssin Wikiin
    • ohjeita em. sivulla
    • tällöin files.txt ohjeen mukaan
    • tämä on erityisen hyvä vaihtoehto jos ryhmässä on useampia jäseniä. Vuorotellen editointi sujuu Wikissä kaikkein helpoiten
  • Wikiä muuten voi olla joskus helpompi kirjoittaa niin että kopioi kaiken tekstilootassa olevan ja pasteaa vaikka ConTextiin ja sitten välillä kopioi takaisin Wikiin.

Vaihtoehtoisia tapoja suunnitelman kirjoittamiseen

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
    • kännykkäkameralla
    • tms.
    Suunnitelman kuvat voi piirtää myös kuvankäsittelyohjelmistolla(Paint yms)
  • kuvat voi piirtää (ja vaiheessa 2 pitää piirtää) myös suoraan käyttöliittymiksi Eclipseen asennetulla WindowBuilderillä
    • tällöin kuvista pitää ottaa ruutukaappaus, vaihtoehtoina:
      • Uusimmissa Windowseissa (Vista, 7 ja 8) on valmiina Snippet Tool, jolla saa kuvakaappauksen rajatusta työpöydän kohdasta
      • 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)
      • Mac:ssä on valmiina Kaappari (Finder --> Ohjelmat --> Lisäohjelmat --> Kaappari), jolla saa kuvakaappauksen valitusta työpöydän kohdasta, ikkunasta tai koko näytöstä.

3. Miten tehdään files.txt Wikissä tehtyä suunnitelmaa varten

  • Tämä HT:n vaihetta 1 varten
  • ÄLÄ IKINÄ KÄYTÄ TIEDOSTOJEN NIMISSÄ SKANDEJA, erikoismerkkejä tai VÄLILYÖNTEJÄ
  • files.txt -tiedostoon pitää allekkain kirjoittaa
    • .txt, .html yms. itse kirjoitetut tiedostojen nimet
    • kaikkien tehtyjen kuvatiedostojen nimet (mahdollisine alihakemistoineen)
    • jos piirretään WindowBuilderillä, niin kaikkien syntyneiden .java-tiedostojen nimet alihakemistoineen
    • 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 2 - -merkkiä jos piirretään viiva)
    • files.txt:n syntaksia:
      • jokainen rivi alkaa tiedoston nimellä, josta tulee dokumtaatioon linkki ko tiedostoon ja svnht siirtää ko. tiedoston versionhallintaan
      • = yhtäsuuruusmerkin jälkeen rivillä kaikki on kommenttia Täällä voi käyttää myös normaaleja HTML tageja, esim otsikkotasoja h
      • @ aloittaa linkin osoitteen, tällöin rivillä ei ole tiedoston nimeä vaan = edeltävästä osasta tulee pelkkä linkki
      • ! edelliseen erona, että linkistä tulee oletuslinkki ja sivustoa avattaessa tämä linkki aukeaa automaattisesti oikeaan reunaan. Harjoitustyön tapauksessa suunnitelman viimeistä versiota on järkevä pitää automaattisena linkkinä.
      • =--- yhtäsuuruusmerkki ja vähintän kolme miinus-merkkiä tuotavat pitkän viivan
  • esimerkki Wiki-suunnitelman tekijälle files.txt:n sisällöstä: (korvaa tietysti nimet sinun kuviesi nimillä ja vesal projektisi nimellä)
    !https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesal = Suunnitelma Wikissä
    kuvat/paaikkunak.png = ohjelman pääikkuna (käsin piirretty)
    kuvat/avaak.png      = kuva ohjelman alusta (kp)
    kuvat/eiaukeak.png   = virheilmoitus jos tiedostoa ei ole (kp)
    

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

  • palautetaan suunnitelman pääikkunan kuva ja sen kommentiksi oman työn "julkaisupaikan"-linkki tyyliin:
     https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesal
    
    eli NettiDemoWWW:hen tuleva rivi on esimerkiksi
    TIEDOSTO            TEHTÄVÄ 	PISTEET 	KOMMENTTI
    paaikkunak.png      1-4         4               https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesal
    

5. files.txt kun kuvia on piirretty WindowBuilderillä

  • tämä HT:n vaihetta 2 varten
  • syntyvää files.html:ää voi koristella html-koodilla files.txt:ssä.
  • jos (ja vaiheessa 2 viimeistään kun) käyttöliittymäkuvat on piirretty WindowBuilderillä, niin files.txt näyttäisi seuraavalta:
    =----------------------------------------
    = Ohjelmointi 2, 2015, vaihe 2
    =----------------------------------------
    = Katso <a href="vaiheet" target="_top">työ vaiheittain</a>
    =
    @https://trac.cc.jyu.fi/projects/ohj2ht/browser/k2015/vesal = Työ versionhallinnassa
    
    = <h3>Ohjelman avustus</h3>
    !https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesal2 = Suunnitelma + avustus Wikissä
    kuvat/paaikkuna.png = ohjelman pääikkunan
    kuvat/avaa.png      = kuva ohjelman alusta
    kuvat/eiaukea.png   = virheilmoitus jos tiedostoa ei ole
    kuvat/virhe.png     = pääikkuna virhesyötön tapauksessa
    kuvat/haku.png      = hakuehdolla hakeminen
    kuvat/poisto.png    = poiston varmistus
    kuvat/tulostus.png  = tulostuksen esikatselu
    kuvat/tietoja.png   = tietoja ohjelmasta
    
    = <h3>Ohjelman esisuunnitelma</h3>
    @https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesal = Suunnitelma Wikissä
    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)
    
    = <h3>Käyttöliittymän ulkoasu WindowBuilderillä</h3>
    src/wbKerho/EditPanel.java = perukomponentti Labelin ja tekstin pitämiseksi samassa alueessa
    src/wbKerho/KerhoGUI.java = kerhon varsinainen käyttöliittymä
    src/wbKerho/TulostusDialog.java = alue johon voidaan tulostaa
    src/wbKerho/KerhonNimiDialog.java = dialogi jolla kysytään kerhon nimi
    src/wbKerho/TiedotPanel.java = paneli jossa ohjelman tiedot
    src/wbKerho/TiedotDialog.java = dialogi, joka näyttää ohjelman tiedot
    

6. CRC-kortit

  • tämä HT:n vaihetta 4 varten
  • CRC kortit saa "piirtää" halutessaan myös Wikiin. Tällöin "tiedoston nimi" voi olla tyyliin
    https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesalCRC
    
  • muotoilu Wikissä on ehkä helpointa tehdä vaihtamalla koodimuotoon (kolme {{{ ) ja tehdä viivoja tolppa (|) ja miinus (-) -merkeillä
  • ota malli pohjaksi
  • files.txt:hen sitten tietysti rivit:
    ...
    = <h3>Tietorakenne ja luokat</h3>
    @https://trac.cc.jyu.fi/projects/ohj2ht/wiki/k2015/suunnitelmat/vesalCRC = CRC-kortit Wikissä
    kuvat/kerhohar.jpg = tietorakenteen kuva
    ...
    

7. Tietorakennekuva

  • jos käyttää piirto-ohjelmana Visiota, niin pohjaksi voi ottaa kerhohar.vsd

8. Menusta rungoksi (HT3 -> HT5)