From 0e44e8ee7747b3c7533d38b6769dd001eca5458a Mon Sep 17 00:00:00 2001 From: Michael Roland Date: Mon, 21 Oct 2024 12:34:32 +0200 Subject: [PATCH] update example documentation --- main-report.tex | 26 +++++++++++++++++--------- main-seminarreport.tex | 14 ++++++++------ main-thesis.tex | 16 +++++++++------- 3 files changed, 34 insertions(+), 22 deletions(-) diff --git a/main-report.tex b/main-report.tex index 9407206..48d7c74 100644 --- a/main-report.tex +++ b/main-report.tex @@ -9,7 +9,8 @@ %% %% You can safely use "pdflatex" instead of "xelatex" if you prefer the pdfLaTeX toolchain. %% However, pdfLaTeX will not be able to deliver the professional font experience that you -%% will get with XeLaTeX. +%% will get with XeLaTeX. You can also safely use "lualatex" instead of "xelatex" while +%% preserving the professional font experience if you prefer the LuaLaTeX toolchain. %% %% _Important_: These magic comments should be on the first lines of your source file. %% @@ -27,8 +28,8 @@ %% JJJJJJJJJJJJJ KKKKKKKKKKKKKKKKKKKKKKKKKKK UUUUUUUUUUUUUUU %% JJJJJJJJJ KKKKKKKKKKKKKKKKKKKKKKKKKKK UUUUUUUUUUU %% -%% This is an example file for using the JKU LaTeX technical report template for -%% your technical report. +%% This is an example file for using the JKU LaTeX technical report template +%% for your technical report. %% %% Template created by Michael Roland (2021) %% @@ -74,7 +75,7 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% Treat input files as UTF-8 encoded. Make sure to always load this when you use pdfLaTeX -%% so that pdfLaTeX knows how to read and interpret characters this source file. +%% so that pdfLaTeX knows how to read and interpret characters in this source file. %% \usepackage[utf8]{inputenc} %% @@ -107,7 +108,7 @@ %% * SOWI ... Use SOWI faculty color scheme. %% * TNF ... Use TNF faculty color scheme. %% -%% Space-efficient monospace font options (requires XeTeX): +%% Space-efficient monospace font options (requires XeTeX/LuaTeX): %% * compactmono ... Use condensed fixed-width font everywhere. %% * nocompactverb ... Do not use condensed fixed-width font for verbatim and listings. %% @@ -115,15 +116,15 @@ %% * noimprint ... Do not insert imprint on title pages. %% * nojkulogo ... Do not insert JKU & K logos on title pages. %% * capstitle ... Set document title in capital letters. -%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX / supress pdfLaTeX warning. +%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX/LuaTeX / supress pdfLaTeX warning. %% * equalmargins ... Decrease the outer page margin to have both page margins of equal size %% (the additional outer margin is intentional and to be used for %% anotations; equalmargins also causes the text width to be %% significantly larger than optimal for reading). %% %% Experimental options: -%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font) -%% in math mode. +%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font +%% when using XeTeX/LuaTeX) in math mode. %% %% Advanced options: %% * noautopdfinfo ... Do not automatically try to add pdfinfo with hyperref from document @@ -153,6 +154,7 @@ \usepackage{import} \usepackage{amsfonts} \usepackage{subfigure} +%\usepackage{acronym} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -235,6 +237,11 @@ %% Print the table of contents \tableofcontents +%% Make sure to start the list of acronyms on a new odd page (odd is only relevant in twoside layout) +%\cleardoubleoddpage +%% Include list of acronyms (optional and often not necessary) +%\import{./}{acronyms} + %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -340,7 +347,7 @@ \section{Conclusion} %% %% Print the bibliography %% -%% Make sure to start the bibliography on a new odd page (odd is only relevant in twoside layout) +%% (Optionally) let the bibliography start on a new odd page (odd is only relevant in twoside layout) %\cleardoubleoddpage \printbibliography %% @@ -366,6 +373,7 @@ \section{An Appendix} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \cleardoubleoddpage \end{document} diff --git a/main-seminarreport.tex b/main-seminarreport.tex index 1528eb0..a33cd9f 100644 --- a/main-seminarreport.tex +++ b/main-seminarreport.tex @@ -9,7 +9,8 @@ %% %% You can safely use "pdflatex" instead of "xelatex" if you prefer the pdfLaTeX toolchain. %% However, pdfLaTeX will not be able to deliver the professional font experience that you -%% will get with XeLaTeX. +%% will get with XeLaTeX. You can also safely use "lualatex" instead of "xelatex" while +%% preserving the professional font experience if you prefer the LuaLaTeX toolchain. %% %% _Important_: These magic comments should be on the first lines of your source file. %% @@ -74,7 +75,7 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% Treat input files as UTF-8 encoded. Make sure to always load this when you use pdfLaTeX -%% so that pdfLaTeX knows how to read and interpret characters this source file. +%% so that pdfLaTeX knows how to read and interpret characters in this source file. %% \usepackage[utf8]{inputenc} %% @@ -107,7 +108,7 @@ %% * SOWI ... Use SOWI faculty color scheme. %% * TNF ... Use TNF faculty color scheme. %% -%% Space-efficient monospace font options (requires XeTeX): +%% Space-efficient monospace font options (requires XeTeX/LuaTeX): %% * compactmono ... Use condensed fixed-width font everywhere. %% * nocompactverb ... Do not use condensed fixed-width font for verbatim and listings. %% @@ -115,15 +116,15 @@ %% * noimprint ... Do not insert imprint on title pages. %% * nojkulogo ... Do not insert JKU & K logos on title pages. %% * capstitle ... Set document title in capital letters. -%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX / supress pdfLaTeX warning. +%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX/LuaTeX / supress pdfLaTeX warning. %% * equalmargins ... Decrease the outer page margin to have both page margins of equal size %% (the additional outer margin is intentional and to be used for %% anotations; equalmargins also causes the text width to be %% significantly larger than optimal for reading). %% %% Experimental options: -%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font) -%% in math mode. +%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font +%% when using XeTeX/LuaTeX) in math mode. %% %% Advanced options: %% * noautopdfinfo ... Do not automatically try to add pdfinfo with hyperref from document @@ -356,6 +357,7 @@ \section{An Appendix} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \cleardoubleoddpage \end{document} diff --git a/main-thesis.tex b/main-thesis.tex index 0c51440..3bd3aa4 100644 --- a/main-thesis.tex +++ b/main-thesis.tex @@ -9,7 +9,8 @@ %% %% You can safely use "pdflatex" instead of "xelatex" if you prefer the pdfLaTeX toolchain. %% However, pdfLaTeX will not be able to deliver the professional font experience that you -%% will get with XeLaTeX. +%% will get with XeLaTeX. You can also safely use "lualatex" instead of "xelatex" while +%% preserving the professional font experience if you prefer the LuaLaTeX toolchain. %% %% _Important_: These magic comments should be on the first lines of your source file. %% @@ -73,7 +74,7 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% Treat input files as UTF-8 encoded. Make sure to always load this when you use pdfLaTeX -%% so that pdfLaTeX knows how to read and interpret characters this source file. +%% so that pdfLaTeX knows how to read and interpret characters in this source file. %% \usepackage[utf8]{inputenc} %% @@ -106,7 +107,7 @@ %% * SOWI ... Use SOWI faculty color scheme. %% * TNF ... Use TNF faculty color scheme. %% -%% Space-efficient monospace font options (requires XeTeX): +%% Space-efficient monospace font options (requires XeTeX/LuaTeX): %% * compactmono ... Use condensed fixed-width font everywhere. %% * nocompactverb ... Do not use condensed fixed-width font for verbatim and listings. %% @@ -114,15 +115,15 @@ %% * noimprint ... Do not insert imprint on title pages. %% * nojkulogo ... Do not insert JKU & K logos on title pages. %% * capstitle ... Set document title in capital letters. -%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX / supress pdfLaTeX warning. +%% * nofancyfonts ... Do not use custom TTF fonts with XeTeX/LuaTeX / supress pdfLaTeX warning. %% * equalmargins ... Decrease the outer page margin to have both page margins of equal size %% (the additional outer margin is intentional and to be used for %% anotations; equalmargins also causes the text width to be %% significantly larger than optimal for reading). %% %% Experimental options: -%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font) -%% in math mode. +%% * mathastext ... Use standard document fonts (enhanced with symbols from Fira Math font +%% when using XeTeX/LuaTeX) in math mode. %% %% Advanced options: %% * noautopdfinfo ... Do not automatically try to add pdfinfo with hyperref from document @@ -286,7 +287,8 @@ %% %% Print the bibliography %% -\cleardoubleoddpage% Make sure to start bibliography on a new odd page +%% Make sure to start the bibliography on a new odd page (odd is only relevant in twoside layout) +\cleardoubleoddpage \printbibliography %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%