Usunięcie ostrzerzeń z pracy (#1)

* Fix chktex warnings in praca.tex
Ashymad · Jul 20, 2019 · 60a4d46 · 60a4d46
1 parent be1c1ef
commit 60a4d46
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 78 deletions.
diff --git a/praca.tex b/praca.tex
@@ -42,17 +42,17 @@
 \usepackage{placeins}
 
 \ifcsname{chapter}\endcsname%
-    \let\Oldchapter\chapter
+    \let\Oldchapter\chapter%
     \renewcommand{\chapter}{\FloatBarrier\Oldchapter}
 \fi
 
-\let\Oldsection\section
+\let\Oldsection\section%
 \renewcommand{\section}{\FloatBarrier\Oldsection}
 
-\let\Oldsubsection\subsection
+\let\Oldsubsection\subsection%
 \renewcommand{\subsection}{\FloatBarrier\Oldsubsection}
 
-\let\Oldsubsubsection\subsubsection
+\let\Oldsubsubsection\subsubsection%
 \renewcommand{\subsubsection}{\FloatBarrier\Oldsubsubsection}
 
 % --- < bibliografia > ---
@@ -112,7 +112,7 @@
 \usepackage{listings}
 \lstset{language=TeX}
 
-\lstset{
+\lstset{%
         literate={ą}{{\k{a}}}1
            {ć}{{\'c}}1
            {ę}{{\k{e}}}1
@@ -141,7 +141,7 @@
 \definecolor{mygray}{rgb}{0.5,0.5,0.5}
 \definecolor{mymauve}{rgb}{0.58,0,0.82}
 
-\lstset{ %
+\lstset{%
   backgroundcolor=\color{white},     % choose the background color
   basicstyle=\ttfamily\footnotesize, % size of fonts used for the code
   breaklines, breakatwhitespace,     % automatic line breaking only at whitespace
@@ -150,14 +150,14 @@
   showstringspaces=false,
   numberstyle=\tiny,
   frame=l,
-  escapeinside={\%*}{*)},            % if you want to add LaTeX within your code
+  escapeinside={*@}{@*},           % if you want to add LaTeX within your code
   keywordstyle=\color{blue},         % keyword style
   stringstyle=\color{mymauve}        % string literal style
 }
 
 % ------------------------
 
-\AtBeginDocument{
+\AtBeginDocument{%
         \renewcommand{\tablename}{Tab.}
         \renewcommand{\figurename}{Rys.}
 }
@@ -181,34 +181,34 @@
 \author{{[}Imiona i Nazwisko]}
 
 \makeatletter% Poniższe makra są wyłącznie zdefiniowane w klasie aghdpl-imir
-\@ifclassloaded{aghdpl}{
+\@ifclassloaded{aghdpl}{%
 
   \sex{m} % Mężczyzna - m; kobieta - cokolwiek
-  \shortauthor{{[}Im. i nazwisko]}
-  \albumnum{{[}xxxxxx]}
-  \address{{[}Adres]}
+  \shortauthor{{[Im.\ i nazwisko]}}
+  \albumnum{{[xxxxxx]}}
+  \address{{[Adres]}}
 
-  \titlePL{{[}Bardzo długi temat niezwykle dogłębnej pracy dyplomowej inżynierskiej debatującej nad ekstraordynaryjnie pasjonującym zagadnieniem]}
-  \titleEN{{[}Very long title of extremely indepth engineer dimploma thesis exploring an extraordinarily interesing subject]}
+  \titlePL{{[Bardzo długi temat niezwykle dogłębnej pracy dyplomowej inżynierskiej debatującej nad ekstraordynaryjnie pasjonującym zagadnieniem]}}
+  \titleEN{{[Very long title of extremely indepth engineer dimploma thesis exploring an extraordinarily interesing subject]}}
 
-  \shorttitlePL{{[}Skrócony temat pracy]} % skrócona wersja tytułu
-  \shorttitleEN{{[}Short thesis subject]}
+  \shorttitlePL{{[Skrócony temat pracy]}} % skrócona wersja tytułu
+  \shorttitleEN{{[Short thesis subject]}}
 
   % rodzaj pracy bez końcówki fleksyjnej np. inżyniersk, magistersk
   \thesistypePL{magistersk}
   \thesistypeEN{engineer}
 
-  \supervisor{{[}Tytuł, imię i nazwisko promotora]}
+  \supervisor{{[Tytuł, imię i nazwisko promotora]}}
 
-  \reviewer{{[}Tytuł, imię i nazwisko recenzenta]}
+  \reviewer{{[Tytuł, imię i nazwisko recenzenta]}}
 
-  \degreeprogrammePL{{[}Nazwa kierunku studiów]}
-  \degreeprogrammeEN{{[}Field of Study]}
+  \degreeprogrammePL{{[Nazwa kierunku studiów]}}
+  \degreeprogrammeEN{{[Field of Study]}}
 
-  \specialisationPL{{[}Nazwa specjalności]}
-  \specialisationEN{{[}Specialisation]}
+  \specialisationPL{{[Nazwa specjalności]}}
+  \specialisationEN{{[Specialisation]}}
 
-  \graduationyear{{[}Rok ukończenia]}
+  \graduationyear{{[Rok ukończenia]}}
   \years{2017/2018}
   \yearofstudy{IV}
   \formPL{stacjonarne}
@@ -226,7 +226,7 @@
   \facultyPL{Wydział Inżynierii Mechanicznej i Robotyki}
   \facultyEN{Faculty of Mechanical Engineering and Robotics}
 
-  \thesisplan{ % Przykłądowy plan pracy, należy omówić z promotorem
+  \thesisplan{% Przykładowy plan pracy, należy omówić z promotorem
     \begin{enumerate}
     \item Omówienie tematu pracy i sposobu realizacji z promotorem.
     \item Zebranie i opracowanie literatury dotyczącej tematu pracy.
@@ -237,14 +237,14 @@
   }
 
   \summaryPL{\indent\indent%
-    {[}Treść streszczenia]
+	  {[Treść streszczenia]}
   }
   \summaryEN{\indent\indent%
-    {[}Summary text]
+	  {[Summary text]}
   }
 
   \acknowledgements{%
-    Serdecznie dziękuję \dots tu ciąg dalszych podziękowań np. dla promotora,
+    Serdecznie dziękuję \dots tu ciąg dalszych podziękowań np.\ dla promotora,
     żony, sąsiada itp.
   }
 
@@ -260,11 +260,11 @@
 
 \begin{document}
 
-\titlepages
+\titlepages{}
 
 % Ponowne zdefiniowanie stylu `plain`, aby usunąć numer strony z pierwszej strony spisu treści i poszczególnych rozdziałów.
 \fancypagestyle{plain}
-{
+{%
         % Usuń nagłówek i stopkę
         \fancyhf{}
         % Usuń linie.
@@ -282,10 +282,10 @@
 \include{tests}
 
 %Kod poniżej dodaje Bibliografię do spisu treści
-\cleardoublepage
-\phantomsection
+\cleardoublepage{}
+\phantomsection{}
 \addcontentsline{toc}{chapter}{Bibliografia}
-\printbibliography
+\printbibliography{}
 
 % Załączniki
 \begin{appendices}

diff --git a/rozdzial1.tex b/rozdzial1.tex
@@ -1,14 +1,12 @@
-\chapter{Wprowadzenie}
-\label{cha:wprowadzenie}
+\chapter{Wprowadzenie}\label{cha:wprowadzenie}
 
-\LaTeX~jest systemem składu umożliwiającym tworzenie dowolnego typu dokumentów (w~szczególności naukowych i technicznych) o wysokiej jakości typograficznej (\cite{Dil00}, \cite{Lam92}). Wysoka jakość składu jest niezależna od rozmiaru dokumentu -- zaczynając od krótkich listów do bardzo grubych książek. \LaTeX~automatyzuje wiele prac związanych ze składaniem dokumentów np.: referencje, cytowania, generowanie spisów (treśli, rysunków, symboli itp.) itd.
+\LaTeX~jest systemem składu umożliwiającym tworzenie dowolnego typu dokumentów (w~szczególności naukowych i~technicznych) o~wysokiej jakości typograficznej (\cite{Dil00}, \cite{Lam92}). Wysoka jakość składu jest niezależna od rozmiaru dokumentu --- zaczynając od krótkich listów do bardzo grubych książek. \LaTeX~automatyzuje wiele prac związanych ze składaniem dokumentów np.: referencje, cytowania, generowanie spisów (treści, rysunków, symboli itp.) itd.
 
-\LaTeX~jest zestawem instrukcji umożliwiających autorom skład i wydruk ich prac na najwyższym poziomie typograficznym. Do formatowania dokumentu \LaTeX~stosuje \TeX a (wymiawamy 'tech' -- greckie litery $\tau$, $\epsilon$, $\chi$). Korzystając z~systemu składu \LaTeX~mamy za zadanie przygotować jedynie tekst źródłowy, cały ciężar składania, formatowania dokumentu przejmuje na siebie system.
+\LaTeX~jest zestawem instrukcji umożliwiających autorom skład i wydruk ich prac na najwyższym poziomie typograficznym. Do formatowania dokumentu \LaTeX~stosuje \TeX{}a (wymawiamy [tech] --- greckie litery $\tau$, $\epsilon$, $\chi$). Korzystając z~systemu składu \LaTeX~mamy za zadanie przygotować jedynie tekst źródłowy, cały ciężar składania, formatowania dokumentu przejmuje na siebie system.
 
 %---------------------------------------------------------------------------
 
-\section{Cele pracy}
-\label{sec:celePracy}
+\section{Cele pracy}\label{sec:celePracy}
 
 
 Celem poniższej pracy jest zapoznanie studentów z systemem \LaTeX~w zakresie umożliwiającym im samodzielne, profesjonalne złożenie pracy dyplomowej w systemie \LaTeX.
@@ -22,10 +20,9 @@ \subsection{Jakiś tytuł 2}
 
 %---------------------------------------------------------------------------
 
-\section{Zawartość pracy}
-\label{sec:zawartoscPracy}
+\section{Zawartość pracy}\label{sec:zawartoscPracy}
 
-W rodziale~\ref{cha:pierwszyDokument} przedstawiono podstawowe informacje dotyczące struktury dokumentów w \LaTeX u. Alvis~\cite{Alvis2011} jest językiem 
+W rozdziale~\ref{cha:pierwszyDokument} przedstawiono podstawowe informacje dotyczące struktury dokumentów w \LaTeX{}u. Alvis~\cite{Alvis2011} jest językiem 
 
 
 

diff --git a/rozdzial2.tex b/rozdzial2.tex
@@ -1,18 +1,16 @@
-\chapter{Pierwszy dokument}
-\label{cha:pierwszyDokument}
+\chapter{Pierwszy dokument}\label{cha:pierwszyDokument}
 
-W rozdziale tym przedstawiono podstawowe informacje dotyczące struktury prostych plików \LaTeX a. Omówiono również metody kompilacji plików z zastosowaniem programów \emph{latex} oraz \emph{pdflatex}.
+W rozdziale tym przedstawiono podstawowe informacje dotyczące struktury prostych plików \LaTeX a. Omówiono również metody kompilacji plików z zastosowaniem programów \emph{latex} oraz \emph{pdflatex}. % chktex 1
 
 %---------------------------------------------------------------------------
 
-\section{Struktura dokumentu}
-\label{sec:strukturaDokumentu}
+\section{Struktura dokumentu}\label{sec:strukturaDokumentu}
 
-Plik \LaTeX owy jest plikiem tekstowym, który oprócz tekstu zawiera polecenia formatujące ten tekst (analogicznie do języka HTML). Plik składa się z dwóch części:
+Plik \LaTeX owy jest plikiem tekstowym, który oprócz tekstu zawiera polecenia formatujące ten tekst (analogicznie do języka HTML). Plik składa się z dwóch części: % chktex 1
 \begin{enumerate}%[1)]
-\item Preambuły -- określającej klasę dokumentu oraz zawierającej m.in. polecenia dołączającej dodatkowe pakiety;
+\item Preambuły --- określającej klasę dokumentu oraz zawierającej m.in.\ polecenia dołączającej dodatkowe pakiety;
 
-\item Części głównej -- zawierającej zasadniczą treść dokumentu.
+\item Części głównej --- zawierającej zasadniczą treść dokumentu.
 \end{enumerate}
 
 \begin{program}
@@ -35,13 +33,12 @@ \section{Sztuczne życie}
 \end{lstlisting}
 \end{program}
 
-Nie ma żadnych przeciwskazań do tworzenia dokumentów w~\LaTeX u w~języku polskim. Plik źródłowy jest zwykłym plikiem tekstowym i~do jego przygotowania można użyć dowolnego edytora tekstów, a~polskie znaki wprowadzać używając prawego klawisza \texttt{Alt}. Jeżeli po kompilacji dokumentu polskie znaki nie są wyświetlane poprawnie, to na 95\% źle określono sposób kodowania znaków (należy zmienić opcje wykorzystywanych pakietów).
+Nie ma żadnych przeciwwskazań do tworzenia dokumentów w~\LaTeX u w~języku polskim. Plik źródłowy jest zwykłym plikiem tekstowym i~do jego przygotowania można użyć dowolnego edytora tekstów, a~polskie znaki wprowadzać używając prawego klawisza \texttt{Alt}. Jeżeli po kompilacji dokumentu polskie znaki nie są wyświetlane poprawnie, to na 95\% źle określono sposób kodowania znaków (należy zmienić opcje wykorzystywanych pakietów).  % chktex 1
 
 
 %---------------------------------------------------------------------------
 
-\section{Kompilacja}
-\label{sec:kompilacja}
+\section{Kompilacja}\label{sec:kompilacja}
 
 
 Załóżmy, że przygotowany przez nas dokument zapisany jest w pliku \texttt{test.tex}. Kolejno wykonane poniższe polecenia (pod warunkiem, że w pierwszym przypadku nie wykryto błędów i kompilacja zakończyła się sukcesem) pozwalają uzyskać nasz dokument w formacie pdf:
@@ -51,52 +48,50 @@ \section{Kompilacja}
 ps2pdf test.ps
 \end{lstlisting}
 %
-lub za pomocą PDF\LaTeX:
+lub za pomocą PDF\LaTeX\@:
 \begin{lstlisting}
 pdflatex test.tex
 \end{lstlisting}
 
-Przy pierwszej kompilacji po zmiane tekstu, dodaniu nowych etykiet itp., \LaTeX~tworzy sobie spis rozdziałów, obrazków, tabel itp., a dopiero przy następnej kompilacji korzysta z tych informacji.
+Przy pierwszej kompilacji po zmianie tekstu, dodaniu nowych etykiet itp., \LaTeX\ tworzy sobie spis rozdziałów, obrazków, tabel itp., a dopiero przy następnej kompilacji korzysta z tych informacji.
 
-W pierwszym przypadku rysunki powinny być przygotowane w~formacie eps, a~w~drugim w~formacie pdf. Ponadto, jeżeli używamy polecenia \texttt{pdflatex test.tex} można wstawiać grafikę bitową (np. w formacie jpg).
+W pierwszym przypadku rysunki powinny być przygotowane w~formacie eps, a~w~drugim w~formacie pdf. Ponadto, jeżeli używamy polecenia \texttt{pdflatex test.tex} można wstawiać grafikę bitową (np.\ w formacie jpg).
 
 
 
 %---------------------------------------------------------------------------
 
-\section{Narzędzia}
-\label{sec:narzedzia}
+\section{Narzędzia}\label{sec:narzedzia}
 
 
 Do przygotowania pliku źródłowego może zostać wykorzystany dowolny edytor tekstowy. Niektóre edytory, np. GEdit, mają wbudowane moduły ułatwiające składanie tekstów w LaTeXu (kolorowanie składni, skrypty kompilacji, itp.).
 
-Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org}
+Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org} % chktex 1
 
 
-Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX~ zamienia się w wygodne i szybkie środowisko pracy.
+Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX\ zamienia się w wygodne i szybkie środowisko pracy. % chktex 1
 
 \textbf{Dla testu łamania stron powtórzenia powyższego tekstu.}
 
 
 Do przygotowania pliku źródłowego może zostać wykorzystany dowolny edytor tekstowy. Niektóre edytory, np. GEdit, mają wbudowane moduły ułatwiające składanie tekstów w LaTeXu (kolorowanie składni, skrypty kompilacji, itp.).
-Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org}
-Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX~ zamienia się w wygodne i szybkie środowisko pracy.
-Po instalacji wtyczki obsługującej \LaTeX~ zamienia się w wygodne i szybkie środowisko pracy.
+Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org} % chktex 1
+Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX\ zamienia się w wygodne i szybkie środowisko pracy. % chktex 1
+Po instalacji wtyczki obsługującej \LaTeX\ zamienia się w wygodne i szybkie środowisko pracy.
 
-Do przygotowania pliku źródłowego może zostać wykorzystany dowolny edytor tekstowy. Niektóre edytory, np. GEdit, mają wbudowane moduły ułatwiające składanie tekstów w LaTeXu (kolorowanie składni, skrypty kompilacji, itp. itd. itp.).
-Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org}
-Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX~ zamienia się w wygodne i szybkie środowisko pracy.
+Do przygotowania pliku źródłowego może zostać wykorzystany dowolny edytor tekstowy. Niektóre edytory, np. GEdit, mają wbudowane moduły ułatwiające składanie tekstów w \LaTeX u (kolorowanie składni, skrypty kompilacji, itp.\ itd.\ itp.). % chktex 1
+Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org} % chktex 1
+Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX\ zamienia się w wygodne i szybkie środowisko pracy. % chktex 1
 
 Do przygotowania pliku źródłowego może zostać wykorzystany dowolny edytor tekstowy. Niektóre edytory, np. GEdit, mają wbudowane moduły ułatwiające składanie tekstów w LaTeXu (kolorowanie składni, skrypty kompilacji, itp.).
-Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org}
-Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX~ zamienia się w wygodne i szybkie środowisko pracy.
+Jednym z bardziej znanych środowisk do składania dokumentów  \LaTeX a jest {\em TeXstudio}, oferujące kompletne środowisko pracy. Zobacz: \url{http://www.texstudio.org} % chktex 1
+Bardzo dobrym środowiskiem jest również edytor gEdit z wtyczką obsługującą \LaTeX a. Jest to standardowy edytor środowiska Gnome. Po instalacji wtyczki obsługującej \LaTeX\ zamienia się w wygodne i szybkie środowisko pracy. % chktex 1
 
 %---------------------------------------------------------------------------
 
-\section{Przygotowanie dokumentu}
-\label{sec:przygotowanieDokumentu}
+\section{Przygotowanie dokumentu}\label{sec:przygotowanieDokumentu}
 
-Plik źródłowy \LaTeX a jest zwykłym plikiem tekstowym. Przygotowując plik
+Plik źródłowy \LaTeX a jest zwykłym plikiem tekstowym. Przygotowując plik % chktex 1
 źródłowy warto wiedzieć o kilku szczegółach:
 
 \begin{itemize}

diff --git a/rozdzial3.tex b/rozdzial3.tex
@@ -10,7 +10,7 @@ \section{Liczba}
 
 \section{Rysunek}
 
-Pakiet \texttt{subcaption} pozwala na umieszczanie w podpisie rysunku odnośników do ,,podilustracji'': \\
+Pakiet \texttt{subcaption} pozwala na umieszczanie w podpisie rysunku odnośników do ,,podilustracji'':\\ % chktex 26
 
 \begin{figure}[h]
         \centering
@@ -23,9 +23,8 @@ \section{Rysunek}
                 \centering
                 \framebox[2.0\width]{B}
                 \subcaption{\label{subfigure_b}}
-        \end{subfigure}
-        \label{fig:subcaption_example}
-        \caption{Przykład użycia \texttt{\textbackslash subcaption}: \protect\subref{subfigure_a} litera A, \protect\subref{subfigure_b} litera B.}
+        \end{subfigure}\label{fig:subcaption_example}
+	\caption{Przykład użycia \texttt{\textbackslash{} subcaption}: \protect\subref{subfigure_a} litera A, \protect\subref{subfigure_b} litera B.}
 \end{figure}
 
 \section{Tabela}
@@ -36,8 +35,7 @@ \section{Tabela}
         \centering
 
         \begin{threeparttable}
-                \caption{Przykład tabeli}
-                \label{tab:table_example}
+                \caption{Przykład tabeli}\label{tab:table_example}
 
                 \begin{tabularx}{0.6\textwidth}{C{1}}
                         \toprule
@@ -50,7 +48,7 @@ \section{Tabela}
 
                 \begin{tablenotes}
                         \footnotesize
-                        \item[a] Jakiś komentarz\textellipsis
+			\item[a] Jakiś komentarz\textellipsis{}
                 \end{tablenotes}
 
         \end{threeparttable}