Skip to content
aginiewicz edited this page Sep 13, 2010 · 2 revisions

Klasa PwrMgr

Na stronie tej znajduje się nieoficjalna klasa dokumentów LaTeXa do składu prac
magisterskich na Politechnice Wrocławskiej, zgodna z logotypem:
http://logotyp.pwr.wroc.pl/wzory.php?co=pracadypl.

Klasa rozwija i wykorzystuje fragmenty pakietu pwrdtyt.sty autorstwa Wojciecha Myszki,
przeznaczonej do składu strony tytułowej prac magisterskich na Politechnice Wrocławskiej:
http://www.immt.pwr.wroc.pl/index.php?option=com_docman&task=docclick&Itemid=137&bid=74&limitstart=0&limit=5.

Klasę wykorzystywałem do złożenia swojej pracy magisterskiej. Korzystała z niej już też spora ilość moich kolegów i koleżanek z roku, którym dziękuję za ich cenne uwagi – dzięki nim naprawiłem wiele błędów i wprowadziłem wiele udoskonaleń. Mam nadzieję, że przyda się kolejnym osobom i zaoszczędzi wam wiele czasu, który możecie poświęcić na pisanie samej pracy.

Jako dystrybucję TeX’a polecam TeXLive – zawsze najnowszą wersję do pobrania ze strony domowej projektu TeXLive.

Do zarządzania pracą polecam też pakiet Git lub Mercurial (dla użytkowników Windowsa – poszukajcie aktualnego TortoiseGit lub TortoiseHg) oraz serwer GitHub lub BitBucket. Dzięki temu systemowi kontroli wersji możecie przechowywać waszą pracę w zabezpieczonym hasłem repozytorium w internecie, przechowując całą historię wersji wstecz, oraz mając wiele innych dodatkowych opcji. Sam również z tego korzystałem podczas pisania pracy magisterskiej i korzystał będę przy pisaniu kolejnych prac (do pisania pracy magisterskiej używałem zestawu Mercurial+TortoiseHg+BitBucket, obecnie Git+TortoiseGit+GitHub).

Poniżej zamieszczam krótką instrukcję używania pakietu.

Budowa dokumentu

Klasa automatycznie składa stronę tytułową starającą się być zgodną ze wzorem dostępnym na stronie Politechniki (uwaga, ramka musi trafić w otwór w okładce). Sama postać strony została zapożyczona z pakietu pwrdtyt.sty autorstwa Wojciecha Myszki – bez tego pakietu byłoby o wiele trudniej wszystko poskładać.

Również automatyczny składany jest spis treści zaraz po stronie tytułowej, oraz bibliografię i skorowidz na końcu dokumentu. Strony przed pierwszym rozdziałem numerowane są liczbami rzymskimi, począwszy od pierwszej strony pierwszego rozdziału liczbami arabskimi od strony 1 – ilość stron w dokumentacji zapisujemy na przykład tak: 59 (vi+53). Klasa przystosowana jest do składu dwustronnego (szkoda lasu, osoby bardzo chcące otrzymać wersję przystosowaną do składu jednostronnego mogą takową otrzymać, po przesłaniu zdjęcia na którym widać jak sadzą przynajmniej jedno drzewo – w dodatku zielonym do góry :-)).

Co ważne, z powodów czysto praktycznych klasa jest modularna. Pojawiły się następujące komendy, które mogą wystąpić w różnych miejscach dokumentu:

  • \wstep{plik} – dołącza wstęp, musi występować dokładnie jeden raz, przed komendami \rozdzial i \dodatek
  • \rozdzial{plik} – dołącza rozdział, przynajmniej jeden, może wystąpić pomiędzy \wstep i \dodatek
  • \wykaz{nazwa}{plik} – dołącza niestandardowy spis, przykładowo oznaczeń, dowolna ilość, może wystąpić przed \wstep lub po \dodatek
  • \dodatek{plik} – dołącza dodatek, dowolna ilość, może wystąpić po \rozdzial

Powyższe komendy pozwalają na dołączenie pliku o nazwie plik.tex i edycję rozdziałów/dodatków w osobnych plikach – tym samym na łatwą zmianę ich kolejności lub przeniesienie z/do dodatków bez ryzykownego kopiowania/wklejania dużych fragmentów tekstu – wystarczy zmienić kolejność występowania komend \rozdzial lub podobnych. Proszę zwrócić uwagę, że kompilujemy tylko główny plik .tex.

Polecam wszystkie niestandardowe definicje załączać w jednym pliku, przykładowo common.tex. Bibliografia powinna być przygotowana w formacie BibTeX, do edycji plików .bib polecam JabRef.

W archiwum zip znajduje się przykład zastosowania komend dołączających. Osoby korzystające z systemu Linux mogą również skorzystać z gotowego pliku Makefile ułatwiającego znacznie kompilację, generację indeksów, bibliografii, itp.
Nowe środowiska

  • RCode i MatlabCode – pozwala wkleić fragment programu w R lub Matlabie, pobiera 2 argumenty dodatkowe – etykietę oraz podpis
  • definicja, twierdzenie, lemat, uwaga – środowiska o wszystko mówiących nazwach
  • dowod – środowisko do prostego składu dowodów, automatycznie wstawia pusty kwadracik po prawej stronie w ostatniej linii tekstowej lub nowej linii, o ile nie użyto komendy \CND
  • figurehere i tablehere – wiele osób zgłaszało zapotrzebowanie, pozwala dodawać rysunki i tabele dokładnie w miejscu wystąpienia, bez środowiska figure i automatycznego rozmieszczania

Nowe komendy dla preambuły

Obowiązkowe są następujące elementy:

  • \tytul[20mm]{tytuł} – ustawia tytuł, opcjonalnym argumentem możemy regulować odstęp pionowy przed tytułem
  • \tytulen[3mm]{tytuł} – ustawia tytuł w wersji angielskiej, opcjonalnym argumentem możemy regulować odstęp pionowy przed tytułem
  • \autor{autor} – autor
  • \promotor{promotor} – promotor
  • \kluczowe{słowa kluczowe} – słowa kluczowe
  • \streszczenie{streszczenie} – streszczenie
  • \bibliografia{plik} – powoduje dołączenie pliku plik.bib jako bibliografii

Elementy nieobowiązkowe:

  • \wydział{wydział} – wydział, domyślnie W11
  • \wciecia{ilość} – ilość widocznych wcięć/zagłębień w spisie, domyślnie 2 (rozdziały i podrozdziały)

Nowe komendy dla ciała dokumentu

  • \listoflistings – spis programów dodanych przy użyciu środowisk RCode i MatlabCode
  • \CND – wstawia pusty kwadracik w środowisku dowodów, powoduje wyłączenie automatycznego (przydatne, jeśli w ostatniej linii znajduje się wzór lub inna niestandardowa struktura
  • \en{tekst} – powoduje wymuszenie angielskiego łamania słów podanych w argumencie