wiki:harjoitustyo/nayttaminen
Last modified 16 months ago Last modified on 2015-12-26 21:54:03

Ohjelmointi 2 / Harjoitustyön näyttäminen

1. Lyhyt ohje 1. vaihetta varten

  1. päätä mikä on projektisi nimi (jos teet yksin, tunnuksesi on hyvä nimi), seuraavissa se nimi tuon PROJNAME tilalle (ei skandeja, ei välilyöntejä)
  2. piirrä tarvittavat käyttöliittymän kuvat c:\mytemp\ohj2\PROJNAME\kuvat-nimiseen alihakemistoon
  3. kirjoita files.txt-mallin mukainen tiedosto c:\mytemp\ohj2\PROJNAME\files.txt (vaikka Notepad++ tai ConText-editorilla)
  4. kirjoita komentoriviltä hakemistossa c:\mytemp\ohj2\PROJNAME
    svnht PROJNAME
    
    Tämän komennon aikana voi tulla salasanakysymyksiä sekä aueta Notepad, jolloin tiedoston ensimmäiselle riville kirjoitetaan sopiva kuvaus siitä, mitä tehtiin (esim. "Lisättiin harjoitustyön kuva"), tallennetaan tiedosto ja suljetaan Notepad. Tämä toimii mikroluokissa. Jos käytät omaa konetta, katso ohjeet siihen.
  5. jatka: suunnitelman kirjoittamisella Wikiin jos et ole sitä vielä aloittanut
  6. Hae harjoitustyösi NettiDemoWWW:hen antamalla demon numeroksi ht ja sitten paina Päivitä index.html.
  7. Lisää NettiDemoWWW linkkisi suunnitelmat -sivulle
  8. Kun on aika jäädyttää vaihe, tee se valitsemasi NettiDemoWWW:ssä kirjoittaen vaiheen kohdalle vaiheesi numero ja paina Luo vaihe.

Lue myös:

2. Pidempi versio

  • ennenkuin teet mitään, pitää hakemistorakenteesi olla seuraavan tyylinen
    c:\mytemp\ohj2\vesal
                     files.txt
                     src      // Java tiedostot tämän alla, tätä ei tarvita HT1:ssä
                       kerho
                         Jasen.java
                         Jasenet.java
                         ...
                     kuvat
                       paaikkuna.png
                       ...
    
  • HT on aina kurssin versiohallinassa (katso: 2015 harjoitustyöt).
  • Jokainen tallettaa harjoitustyönsä myös NettiDemoWWW:hen (ohjaajat katsovat sitä täältä)
  • Itse tiedostot voivat olla suhteellisissa alihakemistoissa (ja .java hakemistojen pitääkin olla pakettien mukaisissa alihakemistoissa), jos se on tiedostossa files.txt kerrottu. Tarvittava mallin mukainen index.html syntyy esim. alla olevilla ohjeilla NettiDemoWWW:llä kun demonumeroksi annetaan ht.
  • Muista lukea myös tyypilliset HT viat!

Malli: files.txt. Pienin mahdollinen files.txt (jolla tulee tällainen tulos)

3. Käyttö

Vaiheet hoituvat helpoiten komennolla svnht yliopiston koneilla. Katso ohjeet omalta koneelta käyttämiseen sivun lopusta.

  1. Kirjoitetaan files.txt mallin mukaan: Tiedostossa kuvataan kaikki oman ohjelman kääntämisessä ja tämän jälkeen ajamisessa tarvittavat tiedostot (ei siis .class, .exe, .obj yms., koska ne syntyvät käännöksessä). HUOM! Isoilla ja pienillä kirjaimilla ON eroa!
    HUOM''' .class-tiedostoja ei saa laittaa versionhallintaan (eikä luetella files.txt:ssä
  2. Jos tiedosto on files.txt:hen nähden alihakemistossa src\kerho, niin files.txt:hen kirjoitetaan esimerkiksi (huomaa että nimenomaan / eikä \):
    src/kerho/Jasen.java = jäsenen käsittely
    
  3. Mikroluokissa files.txt-tiedosto kirjoitetaan käyttäjän omaan hakemistoon. Esimerkki hakemistoista ja tiedostoista (jossa tietysti PROJNAME korvataan omalla käyttäjätunnuksella tai ryhman tunnuksella):
    c:\MyTemp\ohj2\PROJNAME\files.txt  - "sisällysluettelo"
    c:\MyTemp\ohj2\PROJNAME\*.*        - harjoitustyön palaset, voi olla alihakemistoja
    c:\MyTemp\ohj2\PROJNAME\src\PAKETTI\*.java - javatiedostot asianmukaisessa paketissa
    
    • Jos haluat että projektin nimenä on oma käyttäjätunnuksesi ei seuraavissa ole pakko kirjoittaa PROJNAME svnht:n perään.
    • Jos teitä on ryhmässä 2, niin se, jonka käyttäjätunnus ei ole projektin nimenä, JOUTUU kirjoittamaan PROJNAME
  4. Annetaan komento (toimii ainakin Agoran luokissa, 1. käyttökerralla luonnollisesti ei löydä sivua ja silloin voi joutua salasanan antamaan useita kertoja, jos ei toimi, lue lisää ohjeita)
    svnht PROJNAME
    
    Jos kone valittaa, ettei komentoa svnht ole, niin yhdistä N-levy
  5. Mene NettiDemoWWW:hen ja valitse demon numeroksi ht. Tarkista projektisi nimi. Paina Päivitä index.html ja katso minkälainen index.html syntyi.
  6. Kun tulet näyttämään työtäsi, kerrot tuon oman käyttäjätunnuksesi USERNAME ja työntunnuksen PROJNAME jos se on eri kuin käyttäjätunnus.
  7. Antamalla komennon
    svnht PROJNAME
    
    saat otettua työsi "alas" toisessa koneessa.
  8. Tiedoston files.txt ylläpidon voi tehdä myös ohjelmalla DemoWWW.exe, kun poistaa syntyneestä tiedostosta rivin Demo.... Tähän voi tiedostoja raahata esim Explorerista. Mikroluokissa ohjelma lähtee komentoriviltä käyntiin komennolla DemoWWW ja se pitää käynnistää siitä hakemistosta, minkä alla on Eclipsen src-hakemisto. Pitäisi toimia myös kotikoneilla jos laitetaan polkuun. (samoin Linux ja Mac jos käynistetään wine ~/bin/DemoWWW.exe).
  9. Kun herjoitustyön vaihe on hyväksytty, mene Mene NettiDemoWWW:hen ja valitse demon numeroksi ht. Tarkista projektisi nimi. Kirjoita vaiheen kohdalle vaiheen numero ja paina Luo vaihe.

4. Käyttö omassa koneessa jossa on verkkoyhteys

svnht-komento toimii ilman asennusta vain yliopiston koneilla. Versionhallinnan käyttöön omalta koneelta on kuitenkin monia eri vaihtoehtoja:

  • Voit rakentaa samat komennot, mitä yliopiston koneilla on, omalle koneellesi.
    • Windows:
      1. Asenna koneeseesi ActivePerl (Jos tämä ei asennu, kokeile asentaa esimerkiksi Strawberry Perl)
        • kokeile että Perl toimii, kirjoittamalla komentoriviltä:
          perl --version
          
      2. Asenna TortoiseSVN niin, että asennat myös komentorivityökalut
      3. Pidä huoli että svn.exe löytyy sinulta polusta. Se voi olla Tortoisen asentamisen jälkeen esim:
        C:\Program Files\TortoiseSVN\bin\svn.exe
        
        Homma toimii jos komentoriviltä kirjoittamalla svn tulee
        Type 'svn help' for usage.
        
      4. Kopioi itsellesi johonkin polussa olevaan hakemistoon (esim c:\bin, ks esim: kohta pathit kuntoon)
      5. jos käyttäjätunnuksesi eroaa yliopiston tunnuksesta, niin joudut käyttämään muotoa:
        svnht PROJNAME ohj2 trunk USERNAME
        
      6. Voit myös asettaa alempana mainittuja ympäristömuuttujia niin, että parametrejä ei tarvitse antaa svnht komennolle. Ympäristömuuttujia asetetaan kuten PATH-muuttujaakin.
  • Mac (ja suurimmaksi osaksi Linux myös):
    1. Kokeile että perl ja svn löytyvät koneestasi, eli anna komentoriviltä:
      perl
      svn
      
    2. Jos jompikumpi puuttuu, asenna se
      1. OSX 10.7 tai vanhemmat
        • SVN valmiiksi asennettu
      2. OSX 10.8
        • Asenna xcode ohjelma App Storesta ja sieltä asenna "commad line tools"
      3. OSX 10.9
        • Kirjoita komentoriville jompi kumpi ja noudata ohjeita
          svn 
          
          xcode-select --install 
          
      4. Debian (Ubuntu myös?)
        • Kirjoita komentoriville
          sudo apt-get install perl subversion -y
          
      5. Tiedät että SVN on asennettu ja toimii, kun kirjoitat komentoriville
        svn 
        
        ja komentorivi vastaa
        Type 'svn help' for usage. 
        
    3. Hae svnht.pl nimelle svnht (ja DemoWWW.exe jos haluat):
      • esim. komentoriviltä
        mkdir ~/bin
        curl -o ~/bin/svnht http://users.jyu.fi/~vesal/kurssit/bin/svnht.pl
        curl -o ~/bin/DemoWWW.exe http://users.jyu.fi/~vesal/kurssit/bin/DemoWWW.exe
        
    4. anna sitten ko tiedostolle ajo-oikeus
      chmod 755 ~/bin/svnht
      
    5. Kirjoita komentoriviltä
      nano ~/.bash_profile 
      
      ja laita (tai lisää) tiedoston sisällöksi (muuttaen =-merkin jälkeiset osat vastaamaan sinun tapaustasi, editoriksi voit valita jonkin muunkin):
      export HTUSERNAME=omatunnusYliopistonKoneessa
      export HTPROJDIR=projektinimi
      export HTSVNUSER=omatunnusYliopistonKoneessa
      export PATH=$PATH:~/bin
      export SVN_EDITOR=nano
      
      Linux: Jos svn yrittää avata notepadia, kokeile muuttaa SVN_EDITOR > EDITOR.
      Editoinnin lopettamiseksi paina Ctrl-X
    6. sammuta komento-ikkuna ja käynnistä uudelleen, jotta asetukset tulevat voimaan. Tai voit myös antaa komentoriviltä komennon:
      source ~/.bash_profile
      
    7. tämän jälkeen sinulla pitäisi toimia svnht mistä tahansa paikasta ajettuna. Jos käyttäjätunnuksesi omalla koneellasi on eri, kuin mitä yliopistolla käytit projektille, niin anna komento muodossa
      svnht PROJNAME
      
      • svnht -komennon jälkeen aukeaa mahdollisesti GNU nano editori (oletus OS X), jolloin kommentoit muutoksen ja sen jälkeen painat "CRTL + X" ja hyväksyt muutokset Y-kirjaimella (ei crtl). Tämän jälkeen muutokset ajetaan loppuun. Kannattaa varmuuden vuoksi tarkistaa https://trac.cc.jyu.fi/projects/ohj2ht/browser/k2015?order=name että muutokset toteutuivat.
    8. muista tehdä files.txt-tiedosto kuten muutkin
  • yhteiset ohjeet sekä Windows/Linux/Mac
    • käytettävissä olevat ympäristömuuttujat:
      • HTUSERNAME = tällä voi asettaa "pysyvästi" harjoitustyön käyttäjän käyttäjänimen, jos se käyttäjänimi on kotikoneessa eri kuin käyttäjätunnus yliopistolla
      • HTPROJDIR = tällä voi asettaa työn varsinaisen projektinimen
      • HTSVNUSER = tähän tulee yliopiston käyttäjänimi svn-siirtoja varten, tämä on yleensä sama kuin HTUSERNAME
      • SVN_EDITOR = mitä editoria käytetään kun svn pyyttää kommenttia
  • Mitä tahansa tapaa käytätkin, muista hakea harjoitustyösi NettiDemoWWW:hen. Tätä varten files.txt tiedosto pitää olla olemassa ja siinä pitää luetella työhön kuuluvat tiedostot.

Liite:

Pienin mahdollinen files.txt

kuvat/paaikkuna.png = Pääikkunan kuva