robot wiki

[[Zaliczanie pracowni studenckich, pisanie pracy i obrona]]

[[korzystanie z svn]]

[[korzystanie z latex]]

[[Eksploatacja baterii]]

*Pracownie pierwsze (na ocenę) rozliczamy sprawozdaniem napisanym w latex składającym się z kilku zasadniczych części:*

* wymagań stawianych pracy 

* wstępu teoretycznego 

* opisu tego co zrobiono dotychczas 

* planów na kolejny semestr 

*Pracownie ostanie (na zaliczenie) rozliczamy także sprawozdaniem napisanym w latex składającym się z:* 

* streszczenia pracy 

* spisu treści 

*Ocenie podlegają pracownie zakomitowane na naszym SVN. Szczegóły w poradniku. 

*Poradnik (lektura obowiązkowa)* 

* Oficjalne informacje dydaktyczne w IAiIS http://dydaktyka.ia.pw.edu.pl/dydaktyka.html 

* Terminy zaliczeń pracowni i miejsce składania sprawozdań: Informacje u Alicji Trojanowskiej w pokoju 22 

h1. 

*Jak pisać pracę i sprawozdania w latex i korzystać z naszego svn - poradnik dla studentów i nie tylko* 

*Jak pisać i korzystać z latex* 

*Środowisko:* 

* pracę piszemy w latex, bo ładnie składa tekst, jest stabilny i daje nam namiastkę radości programowania podczas pisania tekstów 

* na Windows popularną dystrybucją *latex* jest *miktex* (uwaga - instalujcie go w wersji full) - w *miktex* jest edytor *texworks*, który jest całkiem niezły. Inny dobry moim zdaniem lepszy edytor to texstudio. 

* pracę kompilujcie pdflatexem uzyskując na wyjściu dokument *pdf*. Bibliografię przechowujcie w plik *.bib* (korzystajcie z *bibtex*). Do każdej pozycji literatury powinno być odwołanie z tekstu za pomocą *\cite{}*. *Nie wolno używać \nocite{}*. 

* wszystkie pliki *kodujemy w utf8 bez BOM*

* wybieramy domyślne kodowanie w ustawieniach edytora latexa na utf8 

* kodowanie potwierdzamy odpowiednim odwołaniem się do pakietu. Uczulam, że jest to *utf8* a nie utf8x 

\usepackage[utf8]{inputenc}

- W nagłówek plików źródłowych z kodem latex (na samej górze plików .tex) dodajemy dwie linie (w tym wypadku ze słownikiem polskim, ale może też ew. być angielski/amerykański): 

<pre>

% TeX encoding = utf8

% TeX spellcheck = pl_PL

</pre> 

* w przypadku prac dyplomowych jako klasę dokumentu latex należy wybrać book a nie article. Pracę dyplomową drukujemy dwustronnie. 

* rozmiar czcionki standardowy - 12pkt 

* marginesy 

# top, bottom, right 2.5cm,

# left 3.5cm

*Uwagi redakcyjne:* 

- po spójnikach stosujcie znak tyldy, a nie spację. W texstudio można do tego użyć wyrażenia regularnego w opcji replace. W search wpisujemy " ([wziuoaAWZ]) " natomiast w replace " \1~" - zwróćcie uwagę na znaki spacji 

superscrypt do texstudio: 

<pre>

%SCRIPT

editor.replace(/[ {(~][wziuoaAWZ] /g, function(a){ return a.selectedText()[0]+a.selectedText()[1]+"~"; });

editor.replace(/^[wziuoaAWZ] /g, function(a){ return a.selectedText()[0]+"~"; }); 

</pre>

* Wszystkie tabele, wzory, rysunki powinny być numerowane

* W tekście należy odwoływać się do WSZYSTKICH tabel i rysunków (\ref). Odwołanie do rysunku należy poprzedzić słowem rysunek, odwołanie do tabeli słowem tabela, natomiast do wzorów odwołujemy się po prostu za pomocą \eqref.

* Jeśli odwołujecie się do numeru wzoru, sekcji, tabeli etc. uważajcie aby nie przeniosły się do nowej linii. Także i tutaj stosujcie znak tyldy przed odwołaniem. 

* Uważajcie aby nie wchodzić na marginesy, w szczególności zbyt dużymi ilustracjami oraz wyrazami, które się nie dzielą na sylaby. 

* Dzieląc sekcje na podsekcje rozgałęziajcie ją na co najmniej dwie. W przeciwnym razie nie stosujcie podsekcji. Na początku rozdziałów opiszcie co będzie w nich dalej korzystając z odwołań do sekcji (\ref) a w samych sekcjach (\label).

* Grafikę rastrową zapisujcie w *jpg* (zdjęcia), ewentualnie *png* (schematy szaroodcieniowe, choć tu właściwsza jest reprezentacja rastrowa). Dobierajcie właściwą rozdzielczość i kompresję zdjęć. Przyjmuje się rozdzielczość 300dpi, a więc 300 pikseli na cal. Zdjęcie (nie schematy) jak najbardziej mogą być kolorowe, ale powinny być też czytelne w wydruku szaroodcieniowym.

* Wielkość plików graficznych nie powinna przekraczać kilkuset kilobajtów.

* Starajcie się tworzyć schematy szaroodcieniowe, unikajcie zbędnego kolorowania. Zdjęcia i schematy powinny być mało zaczernione (w szczególności ich tło ze względu na wydruk).

* Unikajcie spiętrzania kilku rysunków pod rząd bez tekstu. 

# Nie przejmujcie się jak rysunek nie jest dokładnie w tym miejscu, gdzie opisujący go tekst.

# Unikajcie zbyt wysokich rysunków, gdyż z reguły znajdują się one daleko za tekstem, który się do nich odwołuje. Twórzcie rysunki możliwie szerokie i jak najniższe.

# Nie bójcie się wstawiać dwóch lub więcej rysunków obok siebie jak jest za mało tekstu w stosunku do liczby ilustracji. Używajcie pakietu subfigure. 

* Nie zamieszczajcie spisu tabel i rysunków.

* Działanie algorytmów prezentujcie na schematach blokowych (zapisanych wektorowo w pdf). Starajcie się aby czcionka na wykresach i schematach była taka jak w tekście.

* Wszelkie wyrażenia matematyczne zapisujcie za pomocą wzorów, w trybie matematycznym. Wyjaśniajcie znaczenie wszystkich symboli matematycznych.

* Liczebników w innym przypadku niż mianownik nie można zapisywać jedynie za pomocą liczby. Najprościej pisać je wówczas słownie.

* Tytuł pracy bez kropki na końcu 

h1. 

Prezentacja na obronę:

* Prezentację na obronę należy wykonać także w latex w oparciu o pakiet *beamer* i tworzyć ją według wskazówek analogicznych do sformułowanych dla prac dyplomowych.

* Filmy są jak najbardziej pożądane, ale:

# Nie należy ich wstawiać bezpośrednio do prezentacji,

# Dla potomnych według obecnego stanu najlepiej je przechowywać na youtube, vimeo itp.

# *Filmów nie wolno komitować na svn.* 

h1. 

Jak korzystać z naszego svn

* pliki ŹRÓDŁOWE pracy komitujemy w naszym svn, plików WYNIKOWYCH, TYMCZASOWYCH i KOPII LOKALNYCH nie komitujemy

# pliki źródłowe to takie, które sami edytujecie (w szczególności pliki *.tex* oraz rysunki, w tym rysunki w pdf)

# pliki wynikowe to takie, które powstają podczas kompilacji (*.toc, .bbl, .log, .aux*, finalna wersja dokumentu w *pdf*). Te pliki należy dodać do listy plików ignorowanych.

# kopie lokalne(np. *.bak, *.tex~*) w przypadku korzystania z svn są zbędne bo sam svn jest kopią.

# Do listy plików ignorowanych dodajemy też widowsowy *thumb.db*, którego oczywiście nie komitujemy.

# *Wolno komitować tylko pliki i katalogi składające się z małych liter i cyfr, bez znaków specjalnych w tym spacji i polskich liter.* Wynika to z kompatybilności między Windows i Linux

# to co zakomitujecie ma być wystarczające, żeby ktoś inny (np. promotor) mógł skompilować pracę. 

* jeżeli nie macie jeszcze dostępu do svn poproście o niego swojego promotora, on Was skieruje do właściwej osoby

* adres Waszego svn to https://robotyka.ia.pw.edu.pl/svn/students. Ściągacie całe repozytorium svn. Na windows popularny klient svn to tortoise svn.

* pracę inżynierską przechowujcie w podkatalogu *bsc\LOGIN\praca*, natomiast magisterską *msc\LOGIN\praca*. Tylko tam komitujcie, chyba, że promotor zalecie inaczej.

* prezentację na obronę przechowujcie odpowiednio dla pracy inżynierskiej w podkatalogu *bsc\LOGIN\obron*a, natomiast dla pracy magisterskiej w *msc\LOGIN\obrona. Nie komitujcie filmów*.

* sprawozdania z pracowni przechowujcie w odpowiednich podkatalogach np. *msc\LOGIN\pdi1*.

* autoryzacja dostępu przeprowadzana jest loginem i hasłem uzyskanym wcześniej w naszym laboratorium (tym samym, którym logujecie się w laboratorium na linuxa, windowsa, redmine, twiki)

* postępy komitujcie co najmniej raz na tydzień (najlepiej około raz dziennie na koniec dnia pracy)

* *Nie przesyłajcie skompilowanych wersji pracy, pracowni czy prezentacji mailem,* chyba, że promotor wyraźnie tego zażąda. Pamiętajcie, że svn służy do tego, żeby te dokumenty wygenerować.

h1. 

Gdzie są dotychczasowe prace na naszym Twiki?

* http://robotyka.ia.pw.edu.pl/publications/

h1. 

Czy warto robić film na prezentację podczas obrony?

* Jak najbardziej ;)

* film umieszczamy na youtube albo vimeo

* długość trwania około 1 do 2 minut

* Na planszach umieszczonych w filmie z zasady nie wstawiamy autorów, ale za to wstawiamy nazwę instytutu

* Wszystkie opisy po angielsku

POWODZENIA ;)