diff --git a/.gitignore b/.gitignore index d9a77e18566558b6ae8259d5387d08192c57f42a..cbb2a356eb90acfcecc8ab0a51248784e883a520 100644 --- a/.gitignore +++ b/.gitignore @@ -63,3 +63,7 @@ build.conf local/ **/local/ +docs/userGuide/objs +docs/userGuide/res +docs/userGuide/objs/* +docs/userGuide/res/* diff --git a/docs/userGuide/makefile b/docs/userGuide/makefile new file mode 100644 index 0000000000000000000000000000000000000000..bdb22289e42333c461b8e65d79db36d12de2d9ac --- /dev/null +++ b/docs/userGuide/makefile @@ -0,0 +1,21 @@ +-include ../../build.conf + +compile: + if [ ! -w objs ] && [ $(USE_RAMDISK) -eq 1 ]; then\ + ln -s /tmp/`date +'%s%N'`-objs $(subst /,, objs) 2>/dev/null;\ + fi;\ + if [ -L $(subst /,, objs) ]; then\ + mkdir -p `readlink $(subst /,, objs)`;\ + else\ + mkdir -p objs;\ + fi + if [ ! -w res ] && [ $(USE_RAMDISK) -eq 1 ]; then\ + ln -s /tmp/`date +'%s%N'`-res $(subst /,, res) 2>/dev/null;\ + fi;\ + if [ -L $(subst /,, res) ]; then\ + mkdir -p `readlink $(subst /,, res)`;\ + else\ + mkdir -p res;\ + fi + pdflatex -output-directory objs userGuide.tex + mv objs/*pdf res diff --git a/docs/userGuide/userGuide.tex b/docs/userGuide/userGuide.tex new file mode 100644 index 0000000000000000000000000000000000000000..e3b3dd84a54240a3126475c768b8d63ce9f714bc --- /dev/null +++ b/docs/userGuide/userGuide.tex @@ -0,0 +1,211 @@ +%%% DOCUMENTCLASS +%%%------------------------------------------------------------------------------- + +\documentclass[ +a4paper, % Stock and paper size. +11pt, % Type size. +% article, +% oneside, +onecolumn, % Only one column of text on a page. +% openright, % Each chapter will start on a recto page. +% openleft, % Each chapter will start on a verso page. +openany, % A chapter may start on either a recto or verso page. +]{memoir} + +%%% PACKAGES +%%%------------------------------------------------------------------------------ + +\usepackage[utf8]{inputenc} % If utf8 encoding +% \usepackage[lantin1]{inputenc} % If not utf8 encoding, then this is probably the way to go +\usepackage[T1]{fontenc} % +\usepackage[english]{babel} % English please +\usepackage[final]{microtype} % Less badboxes + +% \usepackage{kpfonts} %Font + +\usepackage{amsmath,amssymb,mathtools} % Math + +% \usepackage{tikz} % Figures +\usepackage{graphicx} % Include figures + +%%% PAGE LAYOUT +%%%------------------------------------------------------------------------------ + +\setlrmarginsandblock{0.15\paperwidth}{*}{1} % Left and right margin +\setulmarginsandblock{0.2\paperwidth}{*}{1} % Upper and lower margin +\checkandfixthelayout + +%%% SECTIONAL DIVISIONS +%%%------------------------------------------------------------------------------ + +\maxsecnumdepth{subsection} % Subsections (and higher) are numbered +\setsecnumdepth{subsection} + +\makeatletter % +\makechapterstyle{standard}{ + \setlength{\beforechapskip}{0\baselineskip} + \setlength{\midchapskip}{1\baselineskip} + \setlength{\afterchapskip}{8\baselineskip} + \renewcommand{\chapterheadstart}{\vspace*{\beforechapskip}} + \renewcommand{\chapnamefont}{\centering\normalfont\Large} + \renewcommand{\printchaptername}{\chapnamefont \@chapapp} + \renewcommand{\chapternamenum}{\space} + \renewcommand{\chapnumfont}{\normalfont\Large} + \renewcommand{\printchapternum}{\chapnumfont \thechapter} + \renewcommand{\afterchapternum}{\par\nobreak\vskip \midchapskip} + \renewcommand{\printchapternonum}{\vspace*{\midchapskip}\vspace*{5mm}} + \renewcommand{\chaptitlefont}{\centering\bfseries\LARGE} + \renewcommand{\printchaptertitle}[1]{\chaptitlefont ##1} + \renewcommand{\afterchaptertitle}{\par\nobreak\vskip \afterchapskip} +} +\makeatother + +\chapterstyle{standard} + +\setsecheadstyle{\normalfont\large\bfseries} +\setsubsecheadstyle{\normalfont\normalsize\bfseries} +\setparaheadstyle{\normalfont\normalsize\bfseries} +\setparaindent{0pt}\setafterparaskip{0pt} + +%%% FLOATS AND CAPTIONS +%%%------------------------------------------------------------------------------ + +\makeatletter % You do not need to write [htpb] all the time +\renewcommand\fps@figure{htbp} % +\renewcommand\fps@table{htbp} % +\makeatother % + +\captiondelim{\space } % A space between caption name and text +\captionnamefont{\small\bfseries} % Font of the caption name +\captiontitlefont{\small\normalfont} % Font of the caption text + +\changecaptionwidth % Change the width of the caption +\captionwidth{1\textwidth} % + +%%% ABSTRACT +%%%------------------------------------------------------------------------------ + +\renewcommand{\abstractnamefont}{\normalfont\small\bfseries} % Font of abstract title +\setlength{\absleftindent}{0.1\textwidth} % Width of abstract +\setlength{\absrightindent}{\absleftindent} + +%%% HEADER AND FOOTER +%%%------------------------------------------------------------------------------ + +\makepagestyle{standard} % Make standard pagestyle + +\makeatletter % Define standard pagestyle +\makeevenfoot{standard}{}{}{} % +\makeoddfoot{standard}{}{}{} % +\makeevenhead{standard}{\bfseries\thepage\normalfont\qquad\small\leftmark}{}{} +\makeoddhead{standard}{}{}{\small\rightmark\qquad\bfseries\thepage} +% \makeheadrule{standard}{\textwidth}{\normalrulethickness} +\makeatother % + +\makeatletter +\makepsmarks{standard}{ +\createmark{chapter}{both}{shownumber}{\@chapapp\ }{ \quad } +\createmark{section}{right}{shownumber}{}{ \quad } +\createplainmark{toc}{both}{\contentsname} +\createplainmark{lof}{both}{\listfigurename} +\createplainmark{lot}{both}{\listtablename} +\createplainmark{bib}{both}{\bibname} +\createplainmark{index}{both}{\indexname} +\createplainmark{glossary}{both}{\glossaryname} +} +\makeatother % + +\makepagestyle{chap} % Make new chapter pagestyle + +\makeatletter +\makeevenfoot{chap}{}{\small\bfseries\thepage}{} % Define new chapter pagestyle +\makeoddfoot{chap}{}{\small\bfseries\thepage}{} % +\makeevenhead{chap}{}{}{} % +\makeoddhead{chap}{}{}{} % +% \makeheadrule{chap}{\textwidth}{\normalrulethickness} +\makeatother + +\nouppercaseheads +\pagestyle{standard} % Choosing pagestyle and chapter pagestyle +\aliaspagestyle{chapter}{chap} % + +%%% NEW COMMANDS +%%%------------------------------------------------------------------------------ + +\newcommand{\p}{\partial} %Partial +% Or what ever you want + +%%% TABLE OF CONTENTS +%%%------------------------------------------------------------------------------ + +\maxtocdepth{subsection} % Only parts, chapters and sections in the table of contents +\settocdepth{subsection} + +\AtEndDocument{\addtocontents{toc}{\par}} % Add a \par to the end of the TOC + +%%% INTERNAL HYPERLINKS +%%%------------------------------------------------------------------------------- + +\usepackage{hyperref} % Internal hyperlinks +\hypersetup{ +pdfborder={0 0 0}, % No borders around internal hyperlinks +pdfauthor={I am the Author} % author +} +\usepackage{memhfixc} % + +%%% THE DOCUMENT +%%% Where all the important stuff is included! +%%%------------------------------------------------------------------------------- + +\author{J. Travnicek} +\title{The algorithms library toolkit} + +\usepackage{lipsum} % Just to put in some text + +\begin{document} + +\frontmatter + +\maketitle + +\begin{abstract} +\lipsum[1-2] +\end{abstract} +\clearpage + +\tableofcontents* +\clearpage + +\chapter{Introduction} + +\lipsum[1-12] + +\mainmatter + +\chapter{The query language} + +\lipsum[1-13] + +\chapter{Builtin commands} + +\lipsum[1-14] + +\chapter{Summary on registered commands} + +\lipsum[1-14] + +\appendix + +\chapter{Examples} + +\lipsum[1-15] + +\backmatter + +%%% BIBLIOGRAPHY +%%% ------------------------------------------------------------- + +% \bibliographystyle{utphysics} +% \bibliography{ref} + +\end{document}