aboutsummaryrefslogtreecommitdiffstats
path: root/longbow/documentation/LaTeX Documentation/Packages.tex
diff options
context:
space:
mode:
Diffstat (limited to 'longbow/documentation/LaTeX Documentation/Packages.tex')
-rw-r--r--longbow/documentation/LaTeX Documentation/Packages.tex58
1 files changed, 58 insertions, 0 deletions
diff --git a/longbow/documentation/LaTeX Documentation/Packages.tex b/longbow/documentation/LaTeX Documentation/Packages.tex
new file mode 100644
index 00000000..90f5f6db
--- /dev/null
+++ b/longbow/documentation/LaTeX Documentation/Packages.tex
@@ -0,0 +1,58 @@
+%
+% Specify packages that you need in this file.
+% If a package requires configuration, do that here.
+\usepackage{lipsum}
+\usepackage{tcolorbox}
+
+\usepackage{listings}
+
+\definecolor{goodCodeColor}{rgb}{1.0,1.0,1.0}
+\definecolor{badCodeColor}{rgb}{1.0,0.95,0.95}
+\definecolor{mygreen}{rgb}{0,0.6,0}
+\definecolor{mygray}{rgb}{0.5,0.5,0.5}
+\definecolor{mymauve}{rgb}{0.58,0,0.82}
+\lstset{ %
+ backgroundcolor=\color{goodCodeColor}, % choose the background color; you must add \usepackage{color} or \usepackage{xcolor}
+ basicstyle=\tt\small, % the size of the fonts that are used for the code
+ breakatwhitespace=false, % sets if automatic breaks should only happen at whitespace
+ breaklines=true, % sets automatic line breaking
+ captionpos=b, % sets the caption-position to bottom
+ commentstyle=\color{mygreen}, % comment style
+ deletekeywords={...}, % if you want to delete keywords from the given language
+ escapeinside={@}{@}, % if you want to add LaTeX within your code
+ extendedchars=true, % lets you use non-ASCII characters; for 8-bits encodings only, does not work with UTF-8
+ frame=single, % adds a frame around the code
+ keepspaces=true, % keeps spaces in text, useful for keeping indentation of code (possibly needs columns=flexible)
+ keywordstyle=\color{blue}, % keyword style
+ language=C, % the language of the code
+ morekeywords={*,...}, % if you want to add more keywords to the set
+ numbers=left, % where to put the line-numbers; possible values are (none, left, right)
+ numbersep=5pt, % how far the line-numbers are from the code
+ numberstyle=\tiny\color{mygray}, % the style that is used for the line-numbers
+ rulecolor=\color{black}, % if not set, the frame-color may be changed on line-breaks within not-black text (e.g. comments (green here))
+ showspaces=false, % show spaces everywhere adding particular underscores; it overrides 'showstringspaces'
+ showstringspaces=false, % underline spaces within strings only
+ showtabs=false, % show tabs within strings adding particular underscores
+ stepnumber=2, % the step between two line-numbers. If it's 1, each line will be numbered
+ stringstyle=\color{mymauve}, % string literal style
+ tabsize=2, % sets default tabsize to 2 spaces
+ title=\lstname % show the filename of files included with \lstinputlisting; also try caption instead of title
+}
+
+
+\newcommand{\functionBox}[1]{%
+ \begin{tcolorbox}[boxrule=0.5pt,arc=4pt,left=6pt,right=6pt,top=6pt,bottom=6pt,boxsep=0pt]
+ #1
+ \end{tcolorbox}}
+
+\newcommand{\Returns}[2]{{\bf Returns:} #1\hfil\break\begin{tabular}{l r l} #2 \end{tabular}}
+\newcommand{\retval}[2]{\hbox to1em{} & {#1} & {#2}\\ }
+
+\newcommand{\Cfunctionparam}[3]{\hbox to1em{} & #1 & {\tt #2} & #3 \\}
+\newcommand{\paramdef}[1]{\begin{tabular}{ r r l l } #1\end{tabular}\hfil\break}
+\newcommand{\Cfunctiondef}[3]{\functionBox{{#1} {\tt #2(}\hfil\break\paramdef{#3}{\tt )}}}
+
+\newcommand{\Cfunctionref}[1]{{\tt #1()}}
+\newcommand{\functionAbstract}[1]{#1\hfil\break}
+\newcommand{\functionReturns}[2]{{\bf Returns:}\hfil\break\indent\hbox to3em{} #1: #2\hfil\break}
+\newcommand{\NULL}{{\tt NULL }}