Commit 0c354214 authored by Christian Fibich's avatar Christian Fibich Committed by Stefan Tauner
Browse files

Added skeleton for user guide

parent 942db516
% This file was created with JabRef 2.9.2.
% Encoding: Cp1252
@BOOK{adams2007hitchhiker,
title = {The Hitchhiker's Guide to the Galaxy},
publisher = {Random House Publishing Group},
year = {2007},
author = {Adams, Douglas},
series = {Hitchhiker's Guide to the Galaxy},
isbn = {9780307417138}
}
\acro{LOC}{Lines Of Code}
\acro{WWW}{World Wide Web}
\section{Introduction}
Silence bibtex error \cite{adams2007hitchhiker}
\ No newline at end of file
\section{Installation \& Setup}
\ No newline at end of file
\section{FIJI Setup Tool}
\ No newline at end of file
\section{Instrumentation}
\ No newline at end of file
\section{Synthesis}
\ No newline at end of file
\section{Runtime Fault Injection Tool}
\ No newline at end of file
% Copyright page
\clearpage
\thispagestyle{empty}
\null\vfill
\begingroup
\setlength{\parindent}{0pt}
\setlength{\parskip}{\baselineskip}
Copyright \textcopyright{} \the\year{} by UAS Technikum Wien. Some rights reserved.
This document was created in the context of the research project
``Josef Ressel Centre for Verification of Embedded Computing Systems''
at the University of Applied Sciences Technikum Wien, Department of Embedded Systems.
\makeatletter
\textit{Address:} University of Applied Sciences Technikum Wien\\
Department of Embedded Systems\\
Hoechstaedtplatz 6\\
A-1200 Vienna, Austria
\makeatother
\url{http://embsys.technikum-wien.at}
\endgroup
\clearpage
\thispagestyle{empty}
\begin{picture}(0,0)
\color{twgray}
\sffamily
\fontfamily{phv}
\selectfont
\put(-68,-155){\includegraphics[width=\paperwidth]{style/jrc_logo.pdf}}
\put(-10,-380){\bfseries\huge Josef Ressel Centre for}
\put(-10,-415){\bfseries\huge Verification of Embedded Computing Systems}
\put(-10,-460){\Large FIJI User Guide}
\put(-10,-480){\Large Authors: Christian Fibich, Stefan Tauner}
\put(-10,-500){\Large Revision: 0.1}
\put(250,-705){\includegraphics[width=0.15\textwidth]{img/fiji_logo.pdf}}
\put(350,-710){\includegraphics[width=0.3\textwidth]{style/fhtw_logo.pdf}}
\put(-10,-647){UAS Technikum Wien}
\put(-10,-665){H\"ochst\"adtplatz 6, A-1200 Vienna}
\put(-10,-683){I: www.technikum-wien.at}
\put(-10,-701){E: \{fibich, tauner\}@technikum-wien.at}
\color{black}
\end{picture}
\newpage
% For longer reports use: (starts with chapter) %
% \documentclass[a4paper,bibtotoc,oneside,halfparskip]{scrbook}
% For short reports use: (starts with section) %
\documentclass[a4paper,bibtotoc,oneside]{scrartcl}
\usepackage[colorlinks=true,
linkcolor=black,
citecolor=black,
filecolor=black,
pagecolor=black,
urlcolor=black,
bookmarks=true,
bookmarksopen=true,
bookmarksopenlevel=3,
plainpages=false,
pdfpagelabels=true]{hyperref}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[ngerman,english]{babel}
\usepackage{enumerate}
\usepackage{amsmath,amssymb,amsfonts,amstext}
\usepackage{textcomp}
\usepackage{multirow}
% Use more powerful glossaries instead of acronym (requires a "makeglossary") %
\usepackage[acronym,toc,shortcuts,nomain,nonumberlist]{glossaries}
% Use multicol for the definition of the glossary style %
\usepackage{multicol}
% Define the look of the glossary %
\newglossarystyle{myAcroStyle}{%
\glossarystyle{list}%
\renewcommand*{\glspostdescription}{}%
\renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossarypreamble}{\begin{multicols*}{2}}%
\renewcommand*{\glossarypostamble}{\end{multicols*}}%
}
% Redefine the acro command (from acronym) to be used with glossaries %
\newcommand{\acro}[2]{\newacronym{#1}{#1}{#2}}
% Initiate glossaries %
\makeglossaries
% Load acronym definitions from separate file %
\input{abbreviations.tex}
% Can be used to generate blindtext to get a preliminary "look and feel" %
\usepackage{blindtext}
\usepackage{fancyhdr}
\lfoot[\fancyplain{}{}]{\fancyplain{}{}}
\rfoot[\fancyplain{}{}]{\fancyplain{}{}}
\cfoot[\fancyplain{}{\footnotesize\thepage}]{\fancyplain{}{\footnotesize\thepage}}
\lhead[\fancyplain{}{\footnotesize\nouppercase\leftmark}]{\fancyplain{}{}}
\chead{}
\rhead[\fancyplain{}{}]{\fancyplain{}{\footnotesize\nouppercase\sc\leftmark}}
% Use of an extended color table %
\usepackage{xcolor}
\usepackage{color}
\usepackage{colortbl}
% Define the FHTW corporate design colors %
\definecolor{twgray}{RGB}{99,106,111}
\definecolor{twgreen}{RGB}{0,146,110}
\definecolor{twblue}{RGB}{10,143,217}
% Caption package to define caption style of images, tables, etc. %
\usepackage{caption}
\captionsetup[table]{singlelinecheck=false}
% Use cleveref to reference sections, chapters, etc. (\cref{} & \Cref{}) %
\usepackage{cleveref}
% Can be used to append pages of an existing PDF document %
%\usepackage{pdfpages}
% Can be used to define the hierarchy depth appearing in the TOC %
%\usepackage{tocvsec2}
%\settocdepth{section}
% % % % % Listings % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
% Use listings for listings %
\usepackage{listings}
% Define the listings caption (=> "Listing #No - Title")
\DeclareCaptionFormat{listing}{\par\vskip1pt#1#2- #3}
\captionsetup[lstlisting]{format=listing,singlelinecheck=false,margin=0pt,font={sf},labelsep=space,labelfont=bf}
% % % VHDL % % %
\lstdefinestyle{VHDL}{
language = VHDL,
%numbers=left,
%numberstyle=\tiny,
% More Keywords taken from Patricks Example %
morekeywords = {
library,use,all,entity,is,port,in,out,end,architecture,of,
begin,and,not,xor,or,mod,abs,*,/,rm,+,-,&,sll,srl,sla,sra,rol,ror,
nand,nor,xnor, if, elsif, else, then, downto
},
morecomment = [l]--,
tabsize = 4,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % XML % % %
\lstdefinestyle{XML}{
language = XML,
%numbers=left,
%numberstyle=\tiny,
columns = fullflexible,
tabsize = 4,
showstringspaces = false,
morestring=[b]",
morecomment=[s]{<?}{?>},
morecomment=[s][\color{green!40!black}]{<!--}{-->},
morekeywords={version,type}, % list your attributes here
emph={},
emphstyle=\color{red!40!black},
basicstyle = \footnotesize\ttfamily,
commentstyle = \itshape\color{green!40!black},
keywordstyle = \color{blue!100!black!80}\bfseries,
stringstyle = \color{purple!40!black},
tagstyle = \color{blue!100!black!80}\bfseries,
}
% % % C % % %
\lstdefinestyle{C}{
language = C,
%numbers=left,
%numberstyle=\tiny,
belowcaptionskip = 1\baselineskip,
breaklines = true,
xleftmargin = \parindent,
tabsize = 4,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % PERL % % %
\lstdefinestyle{Perl}{
language = Perl,
%numbers=left,
%numberstyle=\tiny,
tabsize=4,
columns=fixed,
showstringspaces=false,
showtabs=false,
keepspaces,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % INI % % %
\lstdefinestyle{Ini}{
%numbers=left,
%numberstyle=\tiny,
morecomment = [l][\color{purple!40!black}]{//},
morecomment = [s][\color{blue!100!black!80}]{[}{]},
morecomment = [l][\textrm]{[...]},
columns = fixed, %fullflexible
morestring = [b]"
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
}
% % % MATHLAB % % %
\lstdefinestyle{Mathlab}{
language = Matlab,
%numbers = left,
%numberstyle = \tiny,
breaklines = true,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
identifierstyle = \color{blue!100!black!80}\bfseries,
}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\usepackage{float}
\usepackage{array}
\usepackage{helvet}
\usepackage[toc,page]{appendix}
\renewcommand{\familydefault}{cmss}
\usepackage[pdftex]{graphicx}
\usepackage{tikz}
\usepackage[margin=2cm]{geometry}
\usetikzlibrary{
arrows,%
folding,%
patterns,%
plotmarks,%
shapes.geometric,%
shapes.misc,%
shapes.symbols,%
shapes.arrows,%
shapes.multipart,%
automata,%
backgrounds,%
chains,%
topaths,%
trees,%
mindmap,%
positioning,%
decorations,%
decorations.fractals,%
decorations.shapes,%
decorations.text,%
decorations.pathmorphing,%
decorations.pathreplacing,%
decorations.markings,%
shadows}
% Define global page properties %
\setlength{\textheight}{245mm}
%\setlength{\textheight}{225mm}
%\setlength{\textwidth}{1.025\textwidth}
\sloppy
% Load global definitions
\input{global_defines.tex}
\begin{document}
% Initiate header and footer
\pagestyle{fancy}
% Cover page:
\input{cover_page.tex}
% Copyright page:
\input{copyright.tex}
\tableofcontents\thispagestyle{empty}
\newpage
\setcounter{page}{1}
%%%%% MAIN CONTENT %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\input{content/01-intro.tex}
\input{content/02-installation.tex}
\input{content/03-setup.tex}
\input{content/04-instrumentation.tex}
\input{content/05-synthesis.tex}
\input{content/06-runtime.tex}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newpage
% Bibliography
\bibliographystyle{IEEEtran}
\bibliography{Bibliography}
% List of Figures %
\listoffigures
\addcontentsline{toc}{section}{\nonumberline List of Figures}
% List of Tables %
\listoftables
\addcontentsline{toc}{section}{\nonumberline List of Tables}
% List of Abbreviations %
\printglossary[style=myAcroStyle,type=acronym,title=List of Abbreviations,toctitle=List of Abbreviations]
\end{document}
\newcommand{\todo}[1]{\textcolor{red}{\textbf{TODO}: #1}}
\newcommand{\fixme}[1]{\textcolor{red}{\textbf{FIXME}: #1}}
\ No newline at end of file
JOB ?= fiji_user_guide
TEX_MAIN ?= $(JOB)
# trailing / is important below
OUTDIR := ./
#shell escape needed for epstopdf, svg2pdf etc.
# TEX := pdflatex -shell-escape -output-directory $(OUTDIR) -jobname $(JOB)
TEX := pdflatex -shell-escape -jobname $(JOB)
BIB := bibtex
IDX := makeindex
# ACR := /home/bla/bin/makeglossaries -d $(OUTDIR)
ACR := makeglossaries
VIEW := "gnome-open"
CWD := $(shell pwd)
TEX_OUT := $(OUTDIR)$(JOB).pdf
#all: $(TEX_OUT)
all: view
fast:
$(TEX) $(TEX_MAIN).tex
"$(VIEW)" "$(CWD)/$(TEX_OUT)"
view: $(TEX_OUT)
"$(VIEW)" "$(CWD)/$(TEX_OUT)"
clean:
rm -f $(OUTDIR)*.aux $(OUTDIR)*.bcf $(OUTDIR)*.bbl $(OUTDIR)*-blx.bib $(OUTDIR)*.run.xml $(OUTDIR)*.idx $(OUTDIR)*.ilg $(OUTDIR)*.lot $(OUTDIR)*.lof $(OUTDIR)*.blg $(OUTDIR)*.alg $(OUTDIR)*.ind $(OUTDIR)*.toc $(OUTDIR)*.acl $(OUTDIR)*.acn $(OUTDIR)*.acr $(OUTDIR)*.out $(OUTDIR)*.log $(OUTDIR)*.gls $(OUTDIR)*.glo $(OUTDIR)*.glg $(OUTDIR)*.ist $(OUTDIR)*.brf $(OUTDIR)*.ver $(OUTDIR)*.hst $(OUTDIR)*.glsdefs
$(JOB).pdf: *.tex content/*.tex img/*.pdf *.bib
$(TEX) $(TEX_MAIN)
$(BIB) $(OUTDIR)$(JOB)
#$(IDX) $(OUTDIR)$(JOB).idx
$(ACR) $(JOB)
$(TEX) $(TEX_MAIN)
#$(ACR) $(JOB)
$(TEX) $(TEX_MAIN)
.PHONY = clean view all fast
......@@ -156,6 +156,7 @@ sub main {
my $abspath = File::Spec->rel2abs(__FILE__);
my ($vol, $basedir, $file) = File::Spec->splitpath($abspath);
my $libdir = File::Spec->catdir($basedir, "lib");
my $ugdir = File::Spec->catdir($basedir, "docs", "userguide");
my $tests_ini_name;
$self->{'tests_ini_name'} = \$tests_ini_name;
......@@ -246,7 +247,7 @@ sub main {
$mw->toplevel()->bind("<F1>" => sub { $self->_show_documentation; });
$mw->toplevel()->bind("<Control-q>" => sub { $self->_onexit($mw); });
$self->{'documentation_path'} = File::Spec->catpath($vol, $libdir, 'fiji.pdf');
$self->{'documentation_path'} = File::Spec->catpath($vol, $ugdir, 'fiji_user_guide.pdf');
$self->{'FIJITestsViewer'} = $mw->FIJITestsViewer(
-change_indicator_ref => \$change_indicator,
-change_indicator_values => {'changed' => CHANGED_VALUE, 'unchanged' => UNCHANGED_VALUE},
......
......@@ -87,6 +87,7 @@ sub main {
my $abspath = File::Spec->rel2abs(__FILE__);
my ($vol, $basedir, $file) = File::Spec->splitpath($abspath);
my $libdir = File::Spec->catdir($vol, $basedir, "lib");
my $ugdir = File::Spec->catdir($basedir, "docs", "userguide");
my $ini_name; # = $cfg{"cli.fiji_cfg"};
$self->{'ini_name'} = \$ini_name;
......@@ -126,7 +127,7 @@ sub main {
$mw->toplevel()->bind("<F1>" => sub { $self->_show_documentation; });
$mw->toplevel()->bind("<Control-q>" => sub { $self->_onexit($mw); });
$self->{'documentation_path'} = File::Spec->catpath($vol, $libdir, 'fiji.pdf');
$self->{'documentation_path'} = File::Spec->catpath($vol, $ugdir, 'fiji_user_guide.pdf');
$self->{'FIJISettingsViewer'} = $mw->FIJISettingsViewer(
-settings => $self->{'settings'},
-documentation_path => $self->{'documentation_path'},
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment