Laboratorium Przetwarzania i Przesyłania Sygnałów

Narzędzia realizacji pracy dyplomowej

W mojej ocenie jedynym sensownym narzędziem do realizacji pracy dyplomowej jest LaTeX. Jeśli pierwszy raz słyszysz o tym narzędziu, to nie szkodzi. A może i nawet lepiej, bo nikt nie zdążył Cię nim niepotrzebnie nastraszyć. Dla porządku przejrzę jednak alternatywne rozwiązania.

Rozważyć można dwie kategorie aplikacji, z użyciem których da się opracować tekst pracy dyplomowej:

  • edytory typu WYSIWYG
  • edytory wykorzystujące język znaczników

WYSIWYG #

Pierwsza kategoria, do której zaliczyć można LibreOffice Writer, Microsoft Word, Google Documents, jest wyborem powszechnym.

Jeśli ma się do dyspozycji tylko młotek, to każdy problem wygląda jak gwóźdź.

Jeśli nie masz innej możliwości jako dyplomantka/dyplomant, to niech pocieszeniem będzie to, że razem ze swoim promotorem będziesz cierpieć z powodu:

  • problemów z utrzymaniem jednolitego stylu formatowania,
  • kiepskiej kontroli wyrównania akapitów,
  • niedopasowania światła międzywierszowego i międzywyrazowego,
  • przesuwających się rysunków,
  • niespójnego z treścią (bo zapewne “ręcznego”) numerowania pozycji bibliografii,
  • kiepskiego wyglądu wzorów

…i wielu podobnych problemów.

Edytory WYSIWYG są bardzo złym wyborem, gdyż promują myślenie o dokumencie z perspektywy dbania o jego wygląd a nie z perspektywy tworzenia wartościowej treści. Właśnie to złe przyzwyczajenie a nie brak umiejętności posługiwania się nowym narzędziem, stanowi największą trudność przy próbie zmiany środowiska pisania tekstów.

Da się w edytorach tego typu przygotować zestaw stylów i sumiennie korzystać z nich podczas pisania całego tekstu. Kto tak jednak robi?

Języki znaczników #

Wymienić można kilka języków znaczników:

  • HTML - najpopularniejszy ale do pisania prac dyplomowych nieodpowiedni,
  • Markdown - prosty język z garścią znaczników, którego podstaw można nauczyć się w ciągu kwadransa,
  • reStructuredText - podobny do Markdown, o nieco bardziej złożonej składni,
  • LaTeX (czytaj: latech) - środowisko profesjonalnego składu tekstu.

Chociaż w różnym stopniu, to mają one podobne zalety:

  • pozwalają skupić się na treści merytorycznej,
  • ich proste formaty tekstowe są odporne na zmiany w aplikacjach i standardach plików binarnych,
  • są lekkie i łatwe w przenoszeniu między urządzeniami,
  • doskonale wpasowują się w wersjonowanie plików za pomocą Git a dzięki temu usprawniają archiwizację i współpracę,
  • pozwalają na łatwe i skuteczne generowanie dokumentu dla różnych mediów takich jak strona internetowa, druk lub czytnik ekranowy dla osób niewidomych.

Trzeba jednak pamiętać, że to tylko narzędzia, które nie są magiczną różdżką rozwiązującą wszystkie problemy. Ostateczny poziom pracy dyplomowej i tak zależy wyłącznie od Dyplomantek i Dyplomantów.

Markdown i reStructuredText #

Markdown i reStructuredText są podobnymi sobie formatami pozwalającymi zapisać tekst mający strukturę rozdziałów, podrozdziałów, akapitów, list punktowanych, list numerowanych, tabel. Można w tekst włączyć rysunki rastrowe i wektorowe. Da się zakodować wzory w podobny sposób, jak robi to Wikipedia. Z powodzeniem da się w tych formatach zapisać książkę naukowo-techniczną. Pliki źródłowe można przekonwertować do HTML albo PDF za pomocą Pandoc, czyli darmowego “kombajnu” do konwersji dokumentów.

Niniejsza strona powstaje na bazie plików źródłowych Markdown. Wygląd jest ustalany arkuszami stylów CSS.

Jeśli komuś uda się zaaplikować uczelniane wymogi składu i formatowania prac dyplomowych do plików tego typu, to z pewnością ich użycie będzie ciekawą alternatywą dla innych rozwiązań.

LaTeX #

Bezpłatne środowisko składu tekstów LaTeX jest narzędziem profesjonalnym i darmowym. Biorąc pod uwagę uczelniane wymogi formatowania tekstów prac, obecnie wydaje się złotym środkiem między pozorną prostotą użycia edytorów WYSIWYG a zbytnią prostotą jaka cechuje Markdown i reStructuredText.

Plik źródłowy LaTeXa jest kompilowany i w efekcie uzyskujemy plik PDF.

Chcąc użyć LaTeXa można rozważyć:

  • zainstalowanie na własnym komputerze jednej z dystrybucji takich jak TeX Live, MiKTeX lub MacTeX, co może wymagać pewnego poziomu umiejętności komputerowych i nieco cierpliwości,
  • wykorzystanie rozwiązania chmurowego Overleaf, co jest proste nawet dla osób nie mających większego doświadczenia informatycznego.

Prace dyplomowe zrealizowane z użyciem LaTeXa można na pierwszy rzut oka odróżnić od prac napisanych w typowym edytorze tekstu. Dokumenty PDF otrzymane z LaTeXa utrzymują jednolity styl w całym tekście i pomiędzy sobą. Tekst przestrzega subtelnych wymogów typografii i składu tekstów.

By ułatwić rozpoczęcie pisania pracy dyplomowej w LaTeXu na Politechnice Warszawskiej, przygotowałem odpowiedni szablon. Jest on jedynym znanym mi szablonem zgodnym z obowiązującymi Zarządzeniami JM Rektora PW: 57/2016, 42/2020, 109/2021, 3/2022 oraz 4/2022. W przypadku zauważenia błędów bardzo proszę o kontakt ze mną. W szablonie znajduje się szereg wskazówek i przykładów.

Wspomniany wyżej szablon można zaimportować do Overleaf a następnie projekt pracy w Overleaf udostępnić promotorowi. Wymagane jest zalogowanie się w tym serwisie, co można zrobić za pomocą adresu poczty elektronicznej albo za pomocą już istniejącego konta na przykład w Google, IEEE albo ORCID. Szczególnie ostatni z wymienionych serwisów jest powszechnie znany w środowisku naukowym.

Do lokalnej edycji pliku źródłowego LaTeXa polecam otwartoźródłowy i darmowy edytor Kile.

Dokumentacja #

Edytory wzorów #

Problemy z edycją wzorów w LaTeX najczęściej wynikają z nieznajomości składni. Edytory online pozwalają uzyskać szybki podgląd wzoru na podstawie jego formuły LaTeXowej i wspierają edycję poprzez możliwość wybrania elementów wzoru za pomocą czytelnych ikonek.

Edytory online z podglądem na żywo:

Narzędzie umożliwiające narysowanie symbolu matematycznego i podpowiadające jak ten symbol uzyskać w LaTeXu:

Generatory tabel #

Proste tabele wygenerować dość łatwo ale LaTeX pozwala robić je z użyciem kolorów, łączenia kolumn lub wierszy i podobnych, bardziej złożonych technik. Wtedy już to takie proste nie jest i można sięgnąć po wsparcie dedykowanych narzędzi, które wygenerują odpowiedni fragment pliku źródłowego.

  • LaTeX Tables Editor – całkiem rozbudowany, pozwala myszką rysować krawędzie i to w różnych kolorach – łatwiej niż “w łerdzie”!
  • Tables Generator – podobny edytor do powyższego ale bardziej stara się przypominać edytory WYSIWYG. Wygenerowany kod ma kolorowaną składnię, więc dobrze się go ogląda. Też potrafi wygenerować MD. Zapamiętuje (cookies?) poprzednio edytowaną tabelkę.
  • Table Editor – generator tabelek nie tylko dla LaTeX ale na przykład MD i RST również. Eksport do JSON również i kilku innych. Prosty, dobrze się nadaje do tabelek w MD bez fajerwerków.