robot wiki

h1. 

*Jak pisać i korzystać z latex* 

*Środowisko:* 

* 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, a nawet 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 np. pakietu subfigure. Najlepiej kiedy rysunki wstawiane obok siebie są tej samej wysokości.

* 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 

* Zbiór użytecznych porad, które w dużej mierze odnoszą się zarówno do artykułów naukowych jak i prac dyplomowych zawarty jest w prezentacji profesora Zielińskiego http://www.robotyka.ia.pw.edu.pl/redmine/attachments/download/166/cz-jak-pisac-artykuly.pdf