EIM projekta uzbūve

Šeit izklāstītas EIM projekta izstrādes un dokumentēšanas vadlīnijas. Attiecas g.k. uz projekta izstrādātājiem, nevis studentiem, kuri šos materiālu izmanto. (Daži studentu individuālie mājasdarbi var būt saistīti ar Maven dokumentēšanas rīkiem, utml. Šajā gadījumā studenti var uzlūkot EIM projekta saturu kā testa datus savam mājasdarbam.)

Failu struktūra un versiju pārvaldība

Java-EIM ir Subversion projekts, kuru anonīmie lietotāji var izčekot no http://java-eim.googlecode.com/svn/trunk/, bet izstrādātāji - no https://java-eim.googlecode.com/svn/trunk/. Mūsu lietotais Subversion serviss ir Google code (projektu hostēšana). Anonīmā izčekošana uz brīdi var kļūt neiespējama, kas jāņem vērā, plānojot nodarbības datorklasē - var gadīties, ka studenti nevar piekļūt kodam. Tad tas jāizčeko pasniedzējam un jāizplata ar citiem līdzekļiem (lokāls failu serveris, utml.).

Zem "trunk" ir vairāki apakšprojekti, kuriem ir kopīgs prefikss: "java-eim-", lai attiecīgās direktorijas Eclipse darbapgabalā atrastos vienkopus.

EIM dokumentācija

Parasti visu dokumentāciju raksta projektā "java-eim-parent" (t.sk. latvisko dokumentāciju - apakšdirektorijā "src/site/de/apt"; tā jāpielinko arī navigācijas joslu definējošajā failā "src/site/site_de.xml"). Vācu lokalizāciju lietojam tādēļ, ka Maven dokumentācijas rīks vēl nav lokalizēts latviešu valodai. Anglisko dokumentāciju raksta zem "src/site/apt", un navigāciju - "src/site/site.xml". Attēlus ievieto apakšdirektorijā "src/site/resources/images". Formāts APT (Almost Plain Text) ir Wiki-veidīgs formāts, kuru lieto Maven - sk. APT User Guide.

Ir saprastas Maven dokumentācijas latviskošanas iespējas (t.i. lai nevajadzētu rakstīt apakšdirektorijā "de" un redzēt paziņojumus vāciski) - drīz to varēsim izmēgjināt. Vairāk par šo tēmu sk. "mvn site" lokalizācija.