Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Corryvreckan
Corryvreckan
Commits
6d384471
Commit
6d384471
authored
Jun 22, 2018
by
Simon Spannagel
Browse files
Start updating user manual
parent
6890bf4d
Changes
3
Hide whitespace changes
Inline
Side-by-side
doc/usermanual/chapters/modules.tex
View file @
6d384471
This section describes the currently available Corryvreckan modules in detail.
\chapter
{
Modules
}
\label
{
ch:modules
}
This chapter describes the currently available Corryvreckan modules in detail.
The description comprises a description of the module implemented as well as possible configuration parameters along with their defaults.
Furthermore, a list of (potentially optional) output plots is provided.
For inquiries about certain modules or their documentation, the respective maintainers should be contacted directly.
...
...
doc/usermanual/config.tex
View file @
6d384471
% Add command to display allpix squared
\DeclareMathAlphabet\mathbfcal
{
OMS
}{
cmsy
}{
b
}{
n
}
\newcommand
{
\corry
}{$
\mathcal
{
C
}$
orryvreckan
\xspace
}
\newcommand
{
\corrybold
}{$
\mathbfcal
{
C
}$
\textbf
{
orryvreckan
}
\xspace
}
% Temporary TODO commands
% \newcommand{\comment}[1]{#1} % DRAFT
\newcommand
{
\comment
}
[1]
{}
% FINAL
...
...
@@ -66,7 +71,7 @@
% Command to add the license (overwritten for HTML in config)
\newcommand
{
\addlicense
}{
\begin{table}
\begin{table}
[H]
\centering
\renewcommand
{
\arraystretch
}{
1.5
}
% Spread rows out...
\begin{tabular}
{
>
{
\centering\arraybackslash
}
m
{
.10
\textwidth
}
>
{
\raggedright\arraybackslash
}
m
{
.90
\textwidth
}}
...
...
doc/usermanual/corryvreckan-manual.tex
View file @
6d384471
...
...
@@ -2,7 +2,7 @@
% PACKAGES AND DOCUMENT CONFIGURATIONS
%----------------------------------------------------------------------------------------
\documentclass
[
fontsize=12pt,
parskip=half]
{
scr
artcl
}
\documentclass
[
captions=tableheading,a4paper,11pt,numbers=noenddot,headsepline,titlepage,twoside,openright,DIV=14,BCOR=8mm,
parskip=half]
{
scr
book
}
\PassOptionsToPackage
{
obeyspaces
}{
url
}
\usepackage
[backend=biber,
autocite=plain,
...
...
@@ -64,7 +64,7 @@
% DOCUMENT INFORMATION
%----------------------------------------------------------------------------------------
\titlehead
{
\centering\includegraphics
[width=7cm]
{
logo.png
}}
\title
{
C
orry
vreckan
User Manual
}
% Title
\title
{
\c
orry
bold
User Manual
}
% Title
\author
{
Morag Williams (
\href
{
mailto:morag.williams@cern.ch
}{
morag.williams@cern.ch
}
)
\\
Daniel Hynds (
\href
{
mailto:daniel.hynds@cern.ch
}{
daniel.hynds@cern.ch
}
)
\\
...
...
@@ -76,26 +76,30 @@
\graphicspath
{{
usermanual/figures/
}}
\begin{document}
\
begin{titlepage}
\
maketitle
% Insert the title, author and date
\
frontmatter
\
pagenumbering
{
Roman
}
\thispagestyle
{
empty
}
\maketitle
% Insert the title, author and date
\cleardoublepage
\thispagestyle
{
empty
}
\addlicense
\
end{tit
lepage
}
\
cleardoub
lepage
\clearpage
% Table Of Contents
\tableofcontents
\clearpage
\mainmatter
\pagenumbering
{
arabic
}
% intro
\input
{
chapters/introduction
}
% modules
\section
{
Modules
}
\label
{
sec:modules
}
\input
{
chapters/modules
}
\lstset
{
language=Ini
}
\includemodulesmd
\lstset
{
language=
}
\clearpage
% additional tools and resources
\input
{
chapters/tools
}
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment