diff --git a/preamble.tex b/preamble.tex new file mode 100644 index 0000000000000000000000000000000000000000..fb688716e6fd27fb294ac7a40d56ac675ad2f2e9 --- /dev/null +++ b/preamble.tex @@ -0,0 +1,99 @@ +% ----------------------------------------------------------------------------- +% Preamble for the Rotare documentation. +% +% Author: Thomas Lambert <t.lambert@uliege.be> +% ULiege - Aeroelasticity and Experimental Aerodynamics +% https://gitlab.uliege.be/thlamb/Rotare-doc +% +% License: CC-BY-SA-4.0 +% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 +% International License (https://creativecommons.org/licenses/by-sa/4.0/) +% ------------------------------------------------------------------------------ + + +% ============================================================================== +% DOCUMENT METADATA +% ============================================================================== + +% Document metadata +% *********************************************** +\newcommand{\docDate}{\today} +\newcommand{\docVersion}{v0.0.0} +\newcommand{\docTitle}{Rotare} +\newcommand{\docSubtitle}{Documentation} +\newcommand{\docAuthor}{Thomas Lambert} +\newcommand{\docAffiliation}{\protect{University of Liège}} + +% ============================================================================== +% PACKAGES +% ============================================================================== + +% Encoding and language +% *********************************************** +\PassOptionsToPackage{utf8}{inputenc} +\usepackage{inputenc} +\usepackage[english]{babel} + +% Debugging +% *********************************************** +%\listfiles % Used for debugging + + +% Document style +% *********************************************** +\PassOptionsToPackage{ + figuresep=colon,% + hangfigurecaption=false,% + hangsection=true,% + hangsubsection=true,% + sansserif=false,% + configurelistings=true,% + colorize=full,% + colortheme=bluemagenta,% + configurebiblatex=true,% + bibsys=biber,% + bibfile=rotare-bib,% + bibstyle=alphabetic,% + bibsorting=nty,% +}{cleanthesis} +\usepackage{cleanthesis} +\KOMAoptions{draft=false} % Get rid of rulers, keep the rest in draft mode + + +% Hyperref setup and pdf metadata +% *********************************************** +\hypersetup{% + pdftitle={\docTitle}, % title (PDF meta) + pdfsubject={\docSubtitle}, % subject (PDF meta) + pdfauthor={\docAuthor}, % author (PDF meta) + plainpages=false, % + colorlinks=false, % colorize links + pdfborder={0 0 0}, % link border + breaklinks=true, % allow line break inside links + bookmarksnumbered=true, % + bookmarksopen=true % +} + +% Other additional packages +% *********************************************** + +% Style +\usepackage{ULiege-colors} % ULiege color theme +\usepackage{scrhack} % So other packages play nice with KOMA-Scripts +\usepackage{booktabs} % Better looking tables + +% Functionality +\usepackage{amsmath} % Math +\usepackage{menukeys} % Keys, menus, directories, etc +\renewmenumacro{\directory}{pathswithfolder} % default: paths +\usepackage[scale=2]{ccicons} % Icons for CC licenses +\usepackage[nolinks]{qrcode} % QR codes + +% For inkscape figures +\usepackage{xifthen} +\usepackage{pdfpages} +\usepackage{transparent} + +% Fixme for todo messages in text +\usepackage[inline, marginclue]{fixme} +\fxsetup{theme=color} diff --git a/rotare-doc.tex b/rotare-doc.tex index 2439aece48c3a43dc8ca012a67ee08d2aeb94ffc..c091b22c73ee06783cdbbfe8f3fa34561e8ed096 100644 --- a/rotare-doc.tex +++ b/rotare-doc.tex @@ -29,93 +29,13 @@ draft, % toggle if draft version ]{scrreprt}% -% ============================================================================== -% DOCUMENT METADATA -% ============================================================================== - -% Document metadata -% *********************************************** -\newcommand{\docDate}{\today} -\newcommand{\docVersion}{v0.0.0} -\newcommand{\docTitle}{Rotare} -\newcommand{\docSubtitle}{Documentation} -\newcommand{\docAuthor}{Thomas Lambert} -\newcommand{\docAffiliation}{\protect{University of Liège}} - -% ============================================================================== -% PACKAGES -% ============================================================================== - -% Encoding and language -% *********************************************** -\PassOptionsToPackage{utf8}{inputenc} -\usepackage{inputenc} -\usepackage[english]{babel} - -% Debugging -% *********************************************** -%\listfiles % Used for debugging - -% Document style -% *********************************************** -\PassOptionsToPackage{ - figuresep=colon,% - hangfigurecaption=false,% - hangsection=true,% - hangsubsection=true,% - sansserif=false,% - configurelistings=true,% - colorize=full,% - colortheme=bluemagenta,% - configurebiblatex=true,% - bibsys=biber,% - bibfile=rotare-bib,% - bibstyle=alphabetic,% - bibsorting=nty,% -}{cleanthesis} -\usepackage{cleanthesis} -\KOMAoptions{draft=false} % Get rid of rulers, keep the rest in draft mode - -% Hyperref setup and pdf metadata -% *********************************************** -\hypersetup{% - pdftitle={\docTitle}, % title (PDF meta) - pdfsubject={\docSubtitle}, % subject (PDF meta) - pdfauthor={\docAuthor}, % author (PDF meta) - plainpages=false, % - colorlinks=false, % colorize links - pdfborder={0 0 0}, % link border - breaklinks=true, % allow line break inside links - bookmarksnumbered=true, % - bookmarksopen=true % -} - -% Other additional packages -% *********************************************** - -\usepackage{ULiege-colors} % ULiege color theme -\usepackage{scrhack} % So other packages play nice with KOMA-Scripts -\usepackage[nolinks]{qrcode} % QR codes -\usepackage{booktabs} % Better looking tables -\usepackage{amsmath} -\usepackage{menukeys} % Keys, menus, directories, etc -\renewmenumacro{\directory}{pathswithfolder} % default: paths -\usepackage[scale=2]{ccicons} % Icons for CC licenses - - -% For inkscape figures -\usepackage{xifthen} -\usepackage{pdfpages} -\usepackage{transparent} +% Main document preamble +\input{preamble.tex} -% Fixme for todo messages in text -\usepackage[inline, marginclue]{fixme} -\fxsetup{theme=color} - -% MY PACKAGES -\usepackage{definitions} % Custom definitions (see style/definitions.sty) -\usepackage{symbols} % Custom definitions (see style/definitions.sty) -\usepackage{commands} % Custom definitions (see style/definitions.sty) +% My custom packages +\usepackage{definitions} % Definitions (see style/definitions.sty) +\usepackage{symbols} % Math symbols (see style/symbols.sty) +\usepackage{commands} % New commands (see style/commands.sty) % ============================================================================== % DOCUMENT CONTENT @@ -130,16 +50,14 @@ draft, % toggle if draft version \input{contents/titlepage} % Titlepage \cleardoublepage -\thispagestyle{empty} -\input{contents/copyright} - -% TODO: Add a copyright notice -% Documentation and images are CC-BY-SA-4.0 -% Code is MIT - - - +% Copyright statement +{ + \thispagestyle{empty} + \input{contents/copyright} + \cleardoublepage +} +% TOC \currentpdfbookmark{\contentsname}{toc} \setcounter{tocdepth}{2} % define depth of toc \tableofcontents % display table of contents