Upute za oblikovanje i predaju seminarskih radova

Upute su podijeljene u slijedeće kategorije:
Upute za izradu dokumentacije
Opširne upute kako oblikovati dokumentaciju dostupne su u pdf obliku. Upute sadrže informacije kako oblikovati dokument, kakva mora biti struktura i slično.

Upute za fizičku organizaciju datoteka
Ove upute bitne su u slučaju kada se izrađuje rad koji sadrži više datoteka, ili čak programsku implementaciju. Najprije nekoliko pravila o imenovanju datoteka:
Dokumente je potrebno organizirati na slijedeći način.
ROOT_DIR(*)
|
+---- DODACI
|
+---- WEB
(*) U nastavku je objašnjeno kako se ROOT_DIR treba nazvati.

Potrebno je provjeriti da se ne predaju datoteke koje nisu potrebne, poput .tmp, .bak i sličnih datoteka koje za sobom ostavljaju neki alati.

Umjesto naziva ROOT_DIR, osnovni direktorij treba se nazvati KraticaPredmeta_KraticaAkademskeGodine_PrezimenaPoAbecediApremaZ_KraticaTeme. Kratice predmeta su: EFNC (Neizrazito, evolucijsko i neuro-računarstvo), IS (Inteligentni sustavi), ML (Strojno učenje). Kratica akademske godine sastoji se od zadnje dvije znamenke godina; npr. akademska godina 2000 . / 2001. ima kraticu 0001. Kratice tema biti će unaprijed zadane (obično uz zadatke; ukoliko nije specificirano, potrebno je pitati). Prezimena su prezimena svih autora koji su sudjelovali u izradi rada. Npr. neka grupa Pero Perić i Ivica Ivić predaju rad na temu s kraticom WUMPUS u akademskoj godini 2001. / 2002. u kolegiju Neizrazito, evolucijsko i neuroračunarstvo. Osnovni direktorij mora se zvati EFNC_0102_IvicPeric_WUMPUS.

U direktorij DODACI potrebno je staviti sve datoteke koje nisu direktno vezane uz sam rad. Npr. prilikom izrade rada korištenjem paketa XYZ koji je skinut negdje s Interneta (i nije poznat širokim masama) instalacija takvog paketa može se staviti u direktorij DODACI (ukoliko je umjerene veličine). U ovom direktoriju mora biti smještena i datoteka info.txt u kojoj se nalazi opis svake datoteke smještene u direktorij. Npr. ako je korišten paket CLIPS (čija je instalacija clipsinst.exe pohranjena u direktorij DODACI), datoteka ROOT_DIR/info.txt sadržavati će npr:

clipsinst.exe
-------------
Instalacija paketa CLIPS. Prije pokretanja našeg rada ovo je potrebno instalirati jer inaće naš rad neće raditi

U direktorij WEB smješta se generirana dokumentacija, programske implementacije kao i upute za korištenje programa u HTML obliku. Ukoliko je programska implementacija u jeziku Java, može se čak staviti i gotov applet. U ovom direktoriju mogu se po potrebi kreirati poddirektoriji. U direktorij mora biti pohranjena i datoteka index.inc čiji će sadržaj biti opisan u nastavku.

Sadržaj direktorija WEB biti će (ako se tako odluči) biti prebačen na web. To znači da svi linkovi u html dokumentima moraju biti relativni, i ne smiju izlaziti iz web direktorija (dakle ne smiju pokazivati na npr. direktorij DODACI). Datoteke smještene u direktorij DODACI, ukoliko se spominju u web dokumentaciji, moraju biti referencirane linkom na originalnu stranicu sa koje su skinute. Ukoliko se želite iz jednog rada pozvati na vaš prethodni rad, obratite se na e-mail adresu navedenu na dnu ove dokumentacije s pitanjem za točan link prema prethodnom radu.

Izrada datoteke index.inc
Svaki seminar predstavljen je na međustranici karakterističnog dizajna za određeni kolegij. Prvi dio te stranice generira se automatski (autori, naziv rada, ključne riječi, sažetak), dok je drugi dio upravo datoteka index.inc , koja sadrži popis svih bitnih materijala koji čine rad, i predstavlja polaznu točku iz koje se kreće u pregled rada. Na ovu stranicu potrebno je staviti samo linkove sa kratkim opisom, dok se programske implementacije (poput Java appleta) stavljaju na zasebne stranice na koje se stavlja samo link.

Primjer index.inc datoteke, kao i neki dodaci mogu se skinuti sa slijedećih linkova: Inteligentni sustavi , Strojno učenje , Evolucijsko, neizrazito i neuro-računarstvo . Priložena je i datoteka index.html koja je identična index.inc datoteci osim što ima nekoliko tagova koji omogućavaju njezin prikaz kao HTML dokumenta.

Napomena: prilikom upisa teksta u datoteku index.inc (npr. koristeći notepad) vodite računa da tekst koji ima naše znakove zamijenite sa tekstom gdje su ti znakovi kodirani unicodom. Za ovu svrhu u dodatke je smještena kodovi/pretvorba.html datoteka koja ima dva polja: u prvo upišete tekst, a u drugom nakon pritiska tipke pretvori dobijete tekst s našim znakovima u unicodu. Posebno je značajno da ovu datoteku ne uređujete u Microsoft Wordu (i njemu sličnim alatima) jer će dobivena datoteka zbog gomile dodanih oznaka i stilova biti potpuno neupotrebljiva!

CSS stilovi su definirani u datoteci "mycss.css" i NE SMIJU se mijenjati. Nazivi stilova označavaju "LOGIČKU" funkciju teksta. Tako npr.:
<div class="semMATERIJALItitle">Popis materijala</div>
označava da je tekst "Popis materijala" logički promatrano naslov rubrike. Uočite da svaki redak (materijal, dodatak) predstavlja fizički redak tablice na stranici. Tablica ima tri kolone:
1. kolona: tekstualni opis
2. i 3. kolona: sličica - link
Ukoliko imate dokument u samo jednom formatu, popunjava se 3. kolona, a 2. kolona ostaje prazna (popunjena tekstom &nbsp;) Za svaku ekstenziju postoji sličica. Ukoliko nemamo sličicu, napraviti ćemo je. Za dokumente u dva formata poredak ektenzija mora biti slijedeći: txt, ppt, doc, html, pdf, zip. Dakle, ako imate A.doc i A.zip u 2. kolonu dođe A.doc a u 3. kolonu A.zip.

Kako bi to sve trebalo izgledati, možete provjeriti na: http://www.zemris.fer.hr/predmeti/su/Seminari.php (odabrati neki od seminara).

Izrada datoteke index.html
Svaki seminar koji ima dokumentaciju u HTML obliku mora imati i index.html datoteku. Datoteku treba napisati prema slijedećim pravilima:

Uputa za uključivanje Java appleta u HTML stranice
Kako sve više ljudi prilikom izrade appleta koristi Java verzija 1.3 koju preglednici standardno ne prepoznaju (u trenutku pisanja ovih uputa), takav applet se ne smije u stranicu ugraditi APPLET tagom, jer tako neće raditi na svim računalima. Umjesto toga, potrebno je koristiti slijedeći blok naredbi:
<object classid="clsid:8AD9C840-044E-11D1-B3E9-00805F499D93"
WIDTH="600" HEIGHT="400"
codebase="http://java.sun.com/products/plugin/1.3/jinstall-13-win32.cab#Version=1,3,0,0">
<param NAME="CODE" VALUE="hr/fer/zemris/fsit/Prva" >
<param NAME="CODEBASE" VALUE="." >
<param NAME="ARCHIVE" VALUE="fsit.jar" >
<param NAME="type" VALUE="application/x-java-applet;version=1.3">
<param NAME="scriptable" VALUE="false">
<COMMENT>
<embed type="application/x-java-applet;version=1.3"
CODE="hr/fer/zemris/fsit/Prva"
CODEBASE="."
ARCHIVE="fsit.jar"
WIDTH="600" HEIGHT="400" scriptable=false
pluginspage="http://java.sun.com/products/plugin/1.3/plugin-install.html">
<noembed>
</COMMENT>
</noembed>
</embed>
</object>
Parametar CODE je relativna staza do class datoteke koja predstavlja applet. U primjeru to je hr/fer/zemris/fsit/Prva.class . Uočite da se ekstnzija .class ne piše. Parametar ARCHIVE određuje u kojoj se arhivi nalazi smješten applet. Arhiva može biti tipa JAR ili ZIP. Ukoliko se rade Java appleti (u seminaru) obavezno je pakirati ih u arhivu. Direktoriji prepuni class datoteka neće biti prihvaćeni - sve zapakirajte u arhivu! Obratite pažnju na to da u arhivi mora biti pohranjena cijela staza. Npr. applet iz primjera se nalazi u direktoriju: hr/fer/zemris/fsit/Prva.class . Tada ta ista staza mora biti valjana i u arhivi, bez obzira kako se ona zvala (hr.zip ili perica.zip). Bilo je slučajeva kada se je arhiva nazvala hr.zip, a applet unutra pohranio kao fer/zemris/fsit/Prva.class što je, dakako, krivo, i neće raditi.Potrebno je podesiti parametre CODE, ARCHIVE, WIDTH i HEIGHT. Uočite da se ti parametri pojavljuju na dva mjesta (jednom za Internet Explorer, jednom za Netscape Navigator).

Elektroničko slanje dokumenata
Kada se pripreme svi materijali i slože prema navedenim uputama, cijelu strukturu direktorija potrebno je pohraniti u zip arhivu istog imena kao i ROOT_DIR (*). Zatim je potrebno otići na stranicu za elektroničko slanje dokumenata i poslati samo tu arhivu. Na stranici je potrebno popuniti sve tražene podatke (Imena i prezimena autora odvojena zarezima, naziv rada, ključne riječi, sažetak) kao i polja login i password. Polja login i password popunjava samo jedna od osoba koja šalje zajednički rad. Nakon što uspješno pošaljete rad, dobiti ćete broj koji je potrebno zapamtiti za slučaj "reklamacije".

Obratite pažnju na slijedeća pravila:
Daljnja pitanja šaljite na adresu marcupic@zemris.fer.hr .