Vaje pri predmetu Osnove in Postopki Konstruiranja (OPK)
šolsko leto 2000/2001

Pomembni datumi

Za opravljanje vaj so pomembni naslednji datumi:

• 16.11.2000: Izbira nalog (seminarjev)
  Študentje so razdeljeni v tri skupine (A, B in C), glede na uspešnost do sedaj oddanih nalog in status (redno vpisan, ponavljalec). Prednost pri izbiri nalog imajo tisti študentje, ki so bolje naredili domače naloge, na koncu naloge izbirajo ponavljalci. Razdelitev študentov po skupinah bo obešena na oglasni deski pred laboratorijem LECAD. Datumi izbiranja nalog so napisani v spodnji tabeli:

  
  

  Skupina	od datuma	do datuma
  A	17.11.2000	21.11.2000
  B	22.11.2000	24.11.2000
  C	27.11.2000	--

  
  

• 11.12.2000: Razčlenitev problema in časovno ovrednotenje faz izdelave
  Poročilo mora vsebovati tudi eazčlenitev reševanja problema naloge. Vsaki fazi pripišete predvideno porabo časa za izdelavo (v odstotkih glede na celoten čas izdelave naloge). Celotno razdelitev naloge strnite v poročilo, ki ga oddate na strežnik do navedenega datuma. V podimeniku pub/vaje/porocila/naloge si vsak kreira imenik s številko naloge. Začetni dokument mora imeti ime index.html.
  

  Primer razdelitve:
  Cilj naloge je napisati program osnove planetnih gonil.
  

  1.	predstaviev osnovnih enačb	10%
  2.	izdelava dveh primerov izračuna	25%
  3.	razdelitev programa na podprograme	5%
  4.	izdelava podprogramov za moči, hitrosti,... in testi	10%
  5.	izdelava racč. skic za vhod in poročilo	25%
  6.	gradnja programa s testiranjem	40%
  7.	izdelava poročila in integracija programa	10%

  
  

• 22.1.2001: Oddaja poročila in programa
  Na polovici predvidenega časa za izdelavo naloge, na strežnik oddate poročilo in deloma delujoč program. Vsak odda poročilo na imenik pub/vaje/porocila/naloge v katerem kreirate podimenik s številko naloge (npr. mkdir 13.100).

• 19.2.2001: Potrditev naloge pred zagovorom
  Pred predstavitvijo naloge, morata biti poročilo in program potrjena s strani mentorja najkasnje teden dni pred predstavitvijo. Mentor oceni ali izdelano poročilo in program ustrezata zahtevam naloge. Če vse ustreza, mentor prenese poročilo in program na ustrezno mesto na strežnik.
  Poročila in program prinesete na disketi ali prej shranite na
  pub/vaje/porocila/naloge v poimenik enak številki naloge.

• 26.2.2001 : zagovor (predstavitev) naloge pred ostalimi študenti
  Vsak študent v 10-tih minutah predstavi problematiko, zahteve, potek izdelave ter rezultate naloge. Namen teh predstavitev je v tem, da se študentje seznanijo z nalogami ostalih študentov.

Poročilo

Poročilo oddate le v elektronski obliki, napisano v jeziku HTML. Osnove in načini pisanja dokumentov v jeziku HTML ste spoznali na vajah in dodatno utrdili s pomočjo že izdelanih nalog.

Ne glede na to, da se poročilo oddaja v elektronski obliki, mora biti napisano kot pisno poročilo. Vsebovati mora: uvod, matematične osnove, razčlenitev problema na faze, opis rešitve problema (z algoritmi ali delom programske kode, vendar ne celote kode programa) in zaključek. Na začetku dokumenta mora biti napisan naslov vaje, na koncu pa leto opravljanja vaj, predmet pri katerm opravljate vaje in avtorja poročila in programa.

Poročilo mora biti napisano v slovenščini (s šumniki). Poleg slovenskega naslova in uvoda, mora imeti naslov in uvod tudi angleškem jeziku. Za pisanje šumnikov se uporablja UNICODE oziroma pisavo UTF-8. Primer uporabe UTF-8 je napisan na strani http://www.lecad.fs.uni-lj.si/$\sim$kolsek/
obvestila_in_seznami/pravilna_uporaba_sumnikov.html.

Poročilo naj bo napisano tako, da je na podlagi poročila možno razumevanje delovanja programa.

Standardi

Vse naloge imajo za osnovo standarde (ISO, VDI ali DIN). Zaradi varovanja pravic, ki izhajajo iz standarizacije ni dovoljeno:

• fotokopiranje dela ali celotnega standarda
• objava diagramov, tabelaričen izpis podatkov v obliki kot je to predstavljeno v standardu
• dobesedno prepisovanje delov ali celotnega standarda

Program

• izgled programa: Iskanje napak v programu (ki ne deluje pravilno) je naporno in včasih dolgotrjano opravilo, saj izgled napisanega programa dosti pripomore k temu da je program težko ali lahko brati. Pri programiranju se zamika dele kode, med funkcijami se pušč dve ali tri vrstice prazne (tudi če je program komentiran). Zamika se tudi telo zanke (while, for) in pogojne stavke (if). Širina kode v vrstici naj ne presega 80 znakov. Primer:

  
  .
  .
  .
  function drawScrew( dim ){
  
    // draw bottom of the screw
    circle( x, y, d[12] );
  
    for( i=0 ; i < 6 ; i++ )
    {
      // display all 6 sides of screw
      dispSide( x, y, i );
    } 
  
    // display the top of the nut
    circle( x, y, d[11] );
  .
  .
  .
  }
  

• komentarji: Uporabljajte komentarje za dodatno razlago pomena funkcij ali parametrov v funkcijah. Komentirajte del programske kode, ki je na prvi pogled težko razumljiv. Komentarji ne povzročijo daljšega izvajanja program, le pomagajo kasnejše razumevanje programa. Komentarji so enako zamaknjieni kot koda, ki ji komentar pripada.

• imena funkcij/spremenljivk: Imena funkcij in spremenljivk se izbira utrezno namenu. Če funkcija izriše vijak, je boljše ime drawScrew kot aabb. Za spremenljivke, ki pomenijo le števce in jih uporabljate le lokalno (na enem delu programa), se uporablja kratka imena ali le eno črko (npr. števec i, j ali k). Za imena funkcij se uporabljajo angleška imena.

• modularno programiranje: Program se razdel na module (funkcije / procedure). S tem je program bolj razumljiv in lovljenje napak je enostavnejše. Pri programiranju se programer osredotoči na en modul, ga sprogrmira, preveri (testiranje je sestavni del programiranja) in ko pravilno deluje, se z njem ne ukvarja več!

• modularno programiranje 2: Z uporabo večjega števila datotek (z js končnico), pri izdelavi večjih projektov (programov) združite module, ki se uporabljajo za podobno (enako) stvar (zaključene celote kot so velike količine podatkov). Npr.: datoteka z imenom izracun.js vsebuje vse funkcije, ki se uporabljajo pri izračunu (izračun faktorjev, tabelirani podatki, preverjanje, itd). Datoteke z glavno datoteko predstavljajo celoten program.

• vključevanje tuje kode: če dela kode ni napisal avtor celotnega programa (prevzamete kodo po nekomu drugemu), mora napisati izvor (avtorja) kode in avtor kode mora dovoliti njeno uporabo. Vsekakor program, ki ima vse dele kode ''uvožene'' ne bo ''prestal'' preverjanja ustreznosti.

Povzetek

• imena funkcij in spremenljivk (ki so opisana v standardu) morajo biti v angleščini
• uporabniški vmesnik (vnos, izpis) morata biti v angleščini

Zadnju dve zahtevi sta pomembni zato, ker bodo programi objavljeni na internetu in to pomeni, da jih lahko uporablja kdorkoli na svetu. Programe napišite tako, da bo uporaba programov enostavna tudi za uporabnike, ki ne govorijo slovensko.

About this document ...

This document was generated using the LaTeX2HTML translator Version 99.1 release (March 30, 1999)

Copyright © 1993, 1994, 1995, 1996, Nikos Drakos, Computer Based Learning Unit, University of Leeds.
Copyright © 1997, 1998, 1999, Ross Moore, Mathematics Department, Macquarie University, Sydney.

The command line arguments were:
latex2html -split 0 -no_navigation -no_reuse -html_version 3.2,unicode opk0001-obvestilo.tex

The translation was initiated by Janez Krek on 2000-11-14