Metódy inžinierskej práce

ak. rok 2024/25

Cvičenie 3

• Spresnenie rámcovej témy projektu
• Práca na predbežnej verzii článku
• Nástroje na tvorbu diagramov
• Úlohy

späť

Spresnenie rámcovej témy – aj keď môže vyžadovať štylistické úpravy – prakticky predstavuje prvú verziu abstraktu vášho článku. Článku ste dali už aj názov. Ďalším krokom je vytvorenie štruktúry článku. Použite pripravený súbor clanok.tex s bibliografiou literatura.bib (s ktorým ste pracovali na predchádzajúcich cvičeniach), do ktorého následne budete písať aj text (článok je štandardnej triedy article). Zrušte nepotrebný text a uveďte zatiaľ len meno, názov článku, abstrakt a vrchnú štruktúru článku (príkazmi \section).

Pozrite usmernenia ohľadom vypracovania predbežnej verzie článku a presvedčte sa, že im rozumiete. Vypracovaniu článku budete musieť venovať primeraný čas mimo cvičení.

Nástroj UMLet je jednoduchý nástroj na tvorbu diagramov. Prvky do diagramu pridávate dvojitým kliknutím v palete (vpravo). Označenie prvku upravujete tak, že ho označíte a následne upravíte obsah zobrazený v okne nástroja vpravo dole.

1. Vytvorte si nový adresár pre článok. Cez príkazový riadok (command prompt) sa nastavte do tohto adresára. Príkazom git init si v ňom inicializujte prázdny Git repozitár.
2. Stiahnite príklad článku a súbor s bibliografickými zdrojmi, na ktoré sa tento článok odvoláva práve do vytvoreného adresára s git repozitárom.
3. Skúste postupne pracovať na článku, na jeho predbežnej verzii tak, že budete commit-ovať vykonané zmeny (v zmysle príkladov z prednášky) v samotnoom článku a súvisiacich artefaktoch (obrázky, grafy, tabuľky a pod.). Snažte sa o čo najvačší počet commitov.
4. Článok udržiavajte v hlavnej master vetve. Vytvore si aj novú vetvu s názvom predbeznaVerzia a v tejto vetve editujte predbežnú verziu článku.
5. V prípade, že vo vetve predbeznaVerzia máte hotové časti pripojte ich do master vetvy.
6. Konfrontujte lokálnu inštaláciu distribúcie MiKTeX a editora TeXworks s riešením uvedeným v prých dvoch kapitolách o spoločnom písaní . Realizujte úlohu 2.1.5. Uistite sa, že rozumiete úlohe 2.1.6. Nastavte zdieľanie dokumentu v zmysle úlohy 2.1.8.
7. Vytvorte si nový adresár pre článok na GitHub-e. Predpokladom je vytvorenie GitHub účtu - ten už máte.
8. Synchronizujte obsah Git repozitára (MIP článok) s vytvoreným GitHub repozitárom.
9. Pridajte do GitHub repozitára aspoň jedného ďalšieho GitHub používateľa - Invite a collaborator (aspoň jedného svojho spolužiaka). Môžete napr. recipročne. Od pridaného "spolupracovníka" sa očákáva, že si prečíta rozpracovanú predbežnú verziu článku a v podobe komentára ponechá pre jeho autora: poznámku užitočnú pre skvalitnenie článku, ľubovoľné súvisiace postrehy, odkazy na ďalšie užitočné súvisiace články, konštruktívne návrhy či odporúčania apod.
10. Pokračujte ďalej v práci na vlastnom článku, na jeho predbežnej verzii tak, že budete commit-ovať vykonané zmeny v samotnom článku a súvisiacich artefaktoch (obrázky, grafy, tabuľky a pod.). Snažte sa o čo najväčší počet commitov. Informujte cvičiacich o vlastnom progrese, prezentujte aj z výpisu histórie commit-ov svoju aktivitu a aktivitu pridaného/pridaných "spolupracovníkov".
11. Článok udržiavajte v hlavnej master vetve aj na GitHub-e.
12. Nakreslite ľubovoľný diagram v nástroji UMLet/UMLetino napr. vývojový diagram zachytávajúci aktivity ohľadne MIP projektu. Taktiež vyskúšajte ďalší nástroj na tvorbu grafiky. Obidva grafické výstupy realizujte ako samostatné PDF súbory.
13. Vyskúšajte si použitie vytvorených diagramov (vytvorené PDF súbory) v súbore clanok.tex. Nastavte veľkosť diagramov podľa potreby (prvotne nastavená na 1.0).
14. Exportovaný diagram v PDF formáte môžete orezať – odstrániť nadbytočný biely priestor – nástrojom pdfcrop, ktorý je súčasťou distribúcie MiKTeXu (nájdete ho v adresári miktex\bin). Nástroj pdfcrop vyžaduje prostredie pre aplikácie v programovacom jazyku Perl (napr. Strawberry Perl). Nástroj pdfcrop zavoláte z príkazového riadku:

    pdfcrop diagram.pdf

    Týmto vznikne súbor diagram-crop.pdf.
15. Konfrontujte lokálnu inštaláciu distribúcie MiKTeX a editora TeXworks s riešením uvedeným v tretej kapitole o spoločnom písaní . Realizujte úlohy v časti 3.5 až 3.8.