Repozytorium zawiera opracowanie szablonu aghdpl, którego autorami są prof. dr hab. Marcin Szpyrka, prof. dr hab. inż. Grzegorz J. Nalepa i dr inż. Paweł Kłeczek. Oryginalny szablon dostępny jest na stronie prof. Szpyrki.
Opracowanie to powstało za namową mojego promotora, dr inż. Sebastiana Ernsta, któremu dziękuję za polecenie filtra pandoc-crossref oraz pomoc ze stworzeniem Makefile.
Niniejsze opracowanie ma na celu umożliwienie napisania pracy dyplomowej w Markdown i wyeksportowanie jej do formatu PDF za pośrednictwem pandoc oraz latexmk.
Napisana praca jest najpierw generowana w formacie latex, ponieważ pandoc nie obsługuje użytego w szablonie biblatex. Następnie tworzony jest dokument PDF, domyślnie out/praca-dyplomowa-latest.
makelatexmkpandocpandoc-crossref
apt install make texlive-full pandoc
wget https://github.com/lierdakil/pandoc-crossref/releases/download/latest/pandoc-crossref-Linux.tar.xz
tar -xf pandoc-crossref-Linux.tar.xz
mv pandoc-crossref /usr/local/binbrew install make mactex pandoc pandoc-crossrefW katalogu src/ znajdują się pliki źródłowe dokumentu. Są one załączane do pliku wynikowego w kolejności alfabetycznej, stąd sugestia, by stosować nazwy XX-description.md, gdzie XX to wartość liczbowa, zaczynając od 00.
Plik 00-headers.md zawiera niezbędne nagłówki w formacie YAML (tzw. YAML front matter), gdzie można dostosować informacje o pracy: tytuł, dane autora, promotora, bibliografię. Dobrą praktyką jest nie wpisywać treści pracy w tym pliku, jednak nie jest to błędem.
Plik Makefile zawiera w sobie polecenia tworzące końcowy plik PDF. Jako źródło brane są wszystkie pliki z rozszerzeniem .md znajdujące się w katalogu src/.
Można zmienić domyślne zachowanie polecenia make ustawiając zmienne środowiskowe:
OUTPUT_FILE_SUFFIX- domyślnielatest, suffix dołączany do bazowej nazwypraca-dyplomowa-{suffix}.pdfOUTPUT_PATH- domyślnieout, ścieżka, gdzie zostanie zapisany plik PDF
OUTPUT_FILE_SUFFIX=latest OUTPUT_PATH=out make pdf