Częste uwagi redakcyjne: jak składać prace doktorskie i dyplomowe w LaTeX-u po polsku i angielsku#

Wersja: 0.5 (2023-02-09)

Nie zostawiamy „samotnych” jednoliterowych przyimków, spójników itd. (w, z, i, …) na końcu wiersza. Należy wstawić niełamliwą spację, np. tak: Bolek i~Lolek. Dotyczy to języka polskiego; w angielskim nikt raczej nie zwraca (niestety) na to uwagi. Ale my wiemy lepiej.

Uwaga jednak na kropki w angielskim tekście – LaTeX po kropce wstawia domyślnie duży odstęp, tj. zakłada, że zaczynamy nowej zdanie. Czasem więc trzeba będzie napisać np. see Tab.~\ref{etykieta} (porównaj, co się stanie, gdy nie będzie tam niełamliwej spacji).

Jeśli takie zachowanie obserwujemy w polskim tekście, włączamy \frenchspacing (albo \usepackage{polski}).
Operatory, nazwy indeksów itp. występujące we wzorach formatujemy innym krojem pisma (np. \mathrm{...}). Niektóre z nich są już zdefiniowane (\min, \max, \sin, \exp, \log itd.).

Przykład: $\mathrm{sensitivity}(\mathbf{x}) = ...$ daje $\mathrm{sensitivity}(\mathbf{x}) = ...$.

Porównaj bowiem: $exp(3)$ vs $\exp(3)$

Inny sposób:
```
\DeclareMathOperator*{\argmin}{arg\,min}
\DeclareMathOperator*{\argmax}{arg\,max}
```
We wzorach może pojawić się tekst w języku „mówionym” – do jego wprowadzania używamy \text. Na przykład dla:
```
\[
f_\text{optymalna}(x)=wx, \quad\text{gdzie }w=7.
\]
```
otrzymujemy:

\[ f_\text{optymalna}(x)=wx, \quad\text{gdzie }w=7. \]
W języku polskim separatorem części ułamkowej liczb jest przecinek. Nie piszemy jednak: $1,5$ ($1,5$), lecz tak: $1{,}5$ ($1{,}5$). Większość liczb (może poza latami) wstawiamy w trybie matematycznym (dolary), zatem piszemy $-100$ ($-100$) zamiast po prostu -100 (-100).

Wzory matematyczne (także inline) traktujemy jak części zdania. Pamiętamy o znakach interpunkcyjnych. Przykład:

Zauważmy, że:              % (uwaga: dwukropek)
\[
f(x)=wx,                   % (uwaga: przecinek)
\]                         % tu nie ma nowego zdania -- brak odstępu
gdzie $w = 7$.

Ewentualnie:

Zauważmy, że:

\[
f(x)=wx,
\]

\noindent % kontynuujemy zdanie
gdzie:

\[
w = 7.
\]

Odwołania do numerowanych równań (\label{etykieta}) tworzymy przy użyciu \eqref{etykieta}. Wtedy numerowanie mamy w stylu (1).

Tytuły (\caption) umieszczamy POD rysunkami, ale NAD tabelami (tablicami). Między etykietą a tabelą czasem miło jest zobaczyć \smallskip. Po tytule tabeli nie stawia się kropki. Po podpisie pod ilustracją nie stawia się kropki. Ponadto warto ustawić:

\usepackage{caption}
% \captionsetup{labelsep=period}
\captionsetup{font=small,labelfont=bf,labelsep=period,justification=centering}
\addto\captionspolish{\renewcommand{\figurename}{Rys.}}
\addto\captionspolish{\renewcommand{\tablename}{Tab.}}
\addto\captionspolish{\renewcommand{\seename}{zob.}}

Środowiska table i figure wstawiamy zawsze najlepiej w pozycji [t!] (ewentualnie czasem [p!] lub [tb!]) – wykrzyknik wymusza większy priorytet w pozycjonowaniu. Zauważmy, że na przykład:
```
\begin{table}[t!] % top!
\caption{\label{Tab:wyniki_glowne} Podsumowanie wyników}
\smallskip
\begin{tabular}
...
\end{tabular}
\end{table}
```
generuje tzw. floating environment – nie jest ono częścią tekstu głównego i nie zwracamy zbyt bacznej uwagi na to, gdzie będą one fizycznie wstawione. Po to mamy do nich odnośniki numerowane, by zwrócić uwagę Czytelnika na ich zawartość. Dlatego też przyjmujemy zasadę, że do każdej tabeli (tablicy) i rysunku należy odwołać się (\ref{...}) w tekście głównym.

\clearpage lub \cleardoublepage stosujemy tylko w skrajnych przypadkach. Lepiej:
```
\usepackage{afterpage}  % w preambule
% a potem:
\afterpage{\clearpage}
```

Wykazów tabel i rysunków nie zamieszczamy w tekście pracy dyplomowej. Takowe tworzy się raczej w przypadku podręczników lub monografii. Z kolei spis treści będzie lepiej wyglądał, jeśli zastosujemy:

\usepackage[nottoc]{tocbibind}
\usepackage[subfigure,titles]{tocloft}
\tocloftpagestyle{fancy}
\renewcommand{\cfttoctitlefont}{}
% \renewcommand{\cftbeforetoctitle}{}
\renewcommand{\cftaftertoctitle}{}
\setlength{\cftaftertoctitleskip}{0pt}
\setlength{\cftbeforetoctitleskip}{0pt}
\setlength{\bibsep}{1pt}
\setcounter{tocdepth}{2}
\setcounter{secnumdepth}{3}
\renewcommand{\cftsecaftersnum}{. }
\renewcommand{\cftsubsecaftersnum}{. }

Lista wypunktowana i numerowana (tzw. wyliczenia): poszczególne punkty kończy się przecinkiem lub średnikiem, a całe wyliczenie – kropką. Na przykład:
- jeden,
- dwa,
- siedem.
Rozdział 1, Podrozdział 1.1, Punkt 1.1.1, Rysunek 7, Tablica 2 – tak piszemy na początku zdania (oczywiście numeracja jest wstawiana automatycznie, zob. \ref{...}). W środku zdania skracamy: zob. rozdz. 1, podrozdz. 1.1, p. 1.1.1, rys. 2, tab. 8. Podobnie w tekście angielskim – Chapter 1, Section 1.1, Section 1.1.1 (raczej nie piszemy subsection), Figure 2, Table 8 na początku zdania lub Chap. 1, Sec. 1.1, Sec. 1.1.1, Fig. 2, Tab. 2 gdzieś w środku.
Cudzysłów: ``po angielsku’’ (grawis-grawis… apostrof-apostrof), ,,po polsku’’ (przecinek-przecinek… apostrof-apostrof).
Wielokropek wstawiamy przy użyciu \dots a nie trzech kropek.
Myślnik (pauza) --- (—) służy do wstawiania wtrąceń. Pamiętajmy o odstępach przed i po pauzach, czyli ,,wiesz — tak sobie myślę — jedźmy gdzieś’’. W tym kontekście dobre też są półpauzy -- (–), czyli ,,wiesz – tak sobie myślę – jedźmy w Bieszczady’’. Oczywiście spójność przede wszystkim.
Półpauza -- (–) służy do definiowania m.in. zakresów liczbowych (1990–1999, s. 123–666) czy podawania autorów metod będących wynikiem pracy zespołowej (np. twierdzenie Banacha–Steinhausa). Uwaga: tutaj nie ma odstępów.
Łącznik - (-) stosujemy tylko w przypadku tzw. złożeń (czarno-biały, Bielko-Biała, Skłodowska-Curie).
Używajmy edytora, który automatycznie sprawdza pisownię już podczas tworzenia dokumentu (i podkreśla błędy), np. Kile, Texmaker lub VS Code z różnymi wtyczkami. Ja używam kate.

Typowe błędy/niezręczności językowe (por. też https://pl.wikipedia.org/wiki/Pomoc:Powszechne_błędy_językowe):

~~źle~~	dobrze
~~w konsoli~~	na konsoli
~~pomiędzy~~	między
~~poprzez~~	przez
~~za pomocą~~	przy użyciu
~~z użyciem~~	przy użyciu
~~dla przykładu~~	na przykład
~~ilość elementów~~	liczba elementów
~~oparty o~~, ~~bazujący o~~	oparty na
~~w oparciu o~~, ~~na bazie~~	na podstawie
~~dwutysięczny osiemnasty~~	dwa tysiące osiemnasty
~~Internet~~	internet
~~dedykowane dla~~	przeznaczone do
~~linia kodu~~	wiersz
~~pod rząd~~	z rzędu
~~odnośnie czegoś~~	odnośnie do czegoś, w stosunku do czegoś, w odniesieniu do czegoś, wobec czegoś
~~przekonywujący~~	przekonujący, przekonywający
~~wydaje się być lepszy~~	wydaje się lepszy
~~najbardziej optymalny~~	optymalny, najlepszy
~~unikalny~~	unikatowy
~~w Linux’ie~~	w systemie Linux
~~R’a~~	języka R
~~w cudzysłowiu~~	w cudzysłowie
~~drugi największy~~	drugi co do wielkości, drugi pod względem wielkości
~~stał się bardziej wpływowy~~	zyskał na znaczeniu

Odmiana nazwisk angielskich i francuskich: np. Disneya, Arrowa, Murphy’ego, Moore’a (zob. np. https://sjp.pwn.pl/zasady/Odmiana-nazwisk-angielskich-i-francuskich;629617.html).

Przymiotniki w języku polskim piszemy małą literą, np. metryka euklidesowa, język polski (ale w jęz. ang. mamy już Euclidean metric, Polish language).

Podajemy (gdzie się da) angielskie odpowiedniki tłumaczonych na język polski terminów, np. ,,precyzja (ang. precision)’’. Wprowadzane terminy wyróżniamy np. pogrubieniem.
Wszelkie wykresy powinny być zapisane w postaci wektorowej (PDF, ew. EPS lub SVG) a nie rastrowej (np. JPG, PNG), chyba że są to zdjęcia – wówczas zapisujemy je w odpowiednio wysokiej rozdzielczości (np. 300 dpi) i pamiętamy, by przypadkiem LaTeX ich nie przeskalował (będą rozmyte).
Dobrym pomysłem jest tworzenie tekstu pracy przy użyciu pakietu Pweave (Python) lub knitr (R) albo czegoś podobnego. Wówczas na bieżąco możemy generować tabele i wykresy w kodzie źródłowym (oczywiście nie przeprowadzamy tutaj żadnych czasochłonnych obliczeń – wyniki eksperymentów powinny być zapisane np. do plików .csv).
Kod w LaTeX-u to kod źródłowy – ręcznie łamiemy wiersze do max. 80 znaków. Bardzo nie lubię wcięć dokonywanych przy użyciu tabulatorów – sugeruję 4 spacje (spójnie w całym kodzie). Radzę zaprzyjaźnić się z git-em.
Pamiętamy o numerowaniu stron.
Każdy rozdział pracy powinien zaczynać się na prawej stronie (openright). Oznacza to, że czasami strona poprzedzająca nowy rozdział będzie musiała być zupełnie pusta (nawet bez numerów stron).
Bibliografię zawsze tworzymy w BibTeX-u, nigdy ręcznie. Na dobry początek polecam ustawienie \bibliographystyle{plplain} (PL) lub \bibliographystyle{plain} (EN).
W przypadku artykułów w czasopismach naukowych nie mylimy volume (numeru woluminu, tomu – zawsze obecne) i number (podnumeru issue – można pominąć), np. odnośnik do Journal of Magical Science 43(2) oznacza volume=43 oraz number=2, a Nature 123 to tylko volume=123;
Na koniec pracy z dziełem wycinamy zawartość pobocznego pliku .bbl i wklejamy go w miejsce wywołania makra \bibliography{nazwa_pliku}, dzięki temu plik źródłowy nie będzie zależny od pliku .bib.
Przykładowe wpisy w bibliografii:

[1] Kowalski J., Nowak B., Tytuł książki, Wydawnictwo, Warszawa, 2054.

[2] Skłodowska M., Tytuł artykułu, Czasopismo 666, 1999, s. 123–432.

[3] Brzdąc I., Tytuł konferencyjniaczka, W: Proc. Taka Ważna Konferencja, 2019, s. 423–424.

Używamy kodowania UTF-8, a nie np. WINDOWS-1250 (ponieważ żyjemy w zglobalizowanym świecie). Sugerowane minimalne polskojęzyczne ustawienia w preambule dokumentu to:

\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[T1,plmath]{polski}
\usepackage[polish]{babel}
\selectlanguage{polish}
\let\lll\undefined % to avoid babel-amssymb conflict, see below
\usepackage{amssymb}
\usepackage{amsmath}
\usepackage{amsfonts}

Bibliografia#

Chwałkowski R., Typografia typowej książki, Helion, Gliwice, 2001
Zasady pisowni i interpunkcji, PWN, https://sjp.pwn.pl/zasady/Zasady-pisowni-i-interpunkcji;713485.html.

Serdecznie dziękuję p. red. Izabeli Mika.