rotare-doc.tex

% -----------------------------------------------------------------------------
% This file is the main documentation of Rotare, a feature-rich and open-source
% implementation of the Blade Element Momentum Theory in MATLAB.
%
% 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/)
% ------------------------------------------------------------------------------

\documentclass[%
paper=A4,               % paper size
twoside=false,           % oneside or twoside printing
openright,              % chapter headings on right side
parskip=half,           % spacing value / method for paragraphs
chapterprefix=true,     % prefix for chapter marks
11pt,                   % font size
headings=normal,        % size of headings
bibliography=totoc,     % include bib in toc
listof=totoc,           % include listof entries in toc
titlepage=on,           % own page for each title page
captions=tableabove,    % display table captions above the float env
chapterprefix=false,    % do not display a prefix for chapters
appendixprefix=false,   % do not display a prefix for appendix chapter
draft=false,            % 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}

% 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{definitions} % Custom definitions (see style/definitions.sty)
\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
% ==============================================================================
%                        COMMANDS AND ENVIRONMENTS
% ==============================================================================

\newcommand{\describeOption}[4]{
  \par\noindent
  \textbf{\textsf{#1}}
  \if\relax\detokenize{#2}\relax
    % nothing
  \else
    [#2]
  \fi
  \dotfill\, #3\newline
  #4
}


% ==============================================================================
%                             DOCUMENT CONTENT
% ==============================================================================
\begin{document}


% Front matter
% ***********************************************
\pagenumbering{roman}			% roman page numbing (invisible for empty page style)
\pagestyle{empty}			% no header or footers
\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




\currentpdfbookmark{\contentsname}{toc}
\setcounter{tocdepth}{2}		% define depth of toc
\tableofcontents			% display table of contents
\cleardoublepage

% Body
% ***********************************************
\pagenumbering{arabic}			% arabic page numbering
\setcounter{page}{1}			% set page counter
\pagestyle{scrheadings}			% header and footer style


\input{contents/intro}   % Introduction

\part{User manual}
\label{part:user}
\input{contents/user-install}
\input{contents/user-usage}
\input{contents/user-input}
\input{contents/user-troubleshooting}

\part{Technical documentation}
\label{part:tech}
\input{contents/definitions}
%\input{contents/tech-architecture}
\input{contents/tech-solvers}
\input{contents/tech-extensions}
%\input{contents/tech-validation}
%\input{contents/tech-roadmap}

% Back matter
% ***********************************************
%
%{%
%  \setstretch{1.1}
%  \renewcommand{\bibfont}{\normalfont\small}
%  \setlength{\biblabelsep}{0pt}
%  \setlength{\bibitemsep}{0.5\baselineskip plus 0.5\baselineskip}
%  \printbibliography[nottype=online]
%  \newrefcontext[labelprefix={@}]
%  \printbibliography[heading=subbibliography,title={Webpages},type=online]
%}
%\cleardoublepage


%\appendix\cleardoublepage
%\input{contents/changelog}       % INCLUDE: appendix

\newpage
\mbox{}

% ==============================================================================
%                              END OF DOCUMENT
% ==============================================================================
\end{document}