Skip to content

Commit bd90de2

Browse files
BIA3IABIA3IA
authored
Add documentation for ATD and update README (#228)
* Add documentation files for ATD. Removed obsolete images. * Delete unused files and update README for project structure and implementation details Added ATD Introduction * Add icon image to README and update image source path
1 parent 86a7d96 commit bd90de2

96 files changed

Lines changed: 1951 additions & 1360 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/icon.png‎

966 KB
Loading

‎ATD/ATD.pdf‎

228 KB
Binary file not shown.

‎ATD/ATD.tex‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
% A LaTeX template for MSc Thesis submissions to
2+
% Politecnico di Milano (PoliMi) - School of Industrial and Information Engineering
3+
%
4+
% Copyright 2021 Politecnico di Milano, Italy. NC-BY
5+
6+
\documentclass{./Configuration_Files/PoliMi3i}
7+
8+
%------------------------------------------------------------------------------
9+
% REQUIRED PACKAGES AND CONFIGURATIONS
10+
%------------------------------------------------------------------------------
11+
12+
% CONFIGURATIONS
13+
\usepackage{setspace} % For using single or double spacing
14+
\usepackage{emptypage} % To insert empty pages
15+
\usepackage{multicol} % To write in multiple columns (executive summary)
16+
\setlength\columnsep{15pt} % Column separation in executive summary
17+
\setlength\parindent{0pt} % Indentation
18+
\raggedbottom
19+
20+
% PACKAGES FOR TITLES
21+
\usepackage{titlesec}
22+
% \titlespacing{\section}{left spacing}{before spacing}{after spacing}
23+
\titlespacing{\section}{0pt}{3.3ex}{2ex}
24+
\titlespacing{\subsection}{0pt}{3.3ex}{1.65ex}
25+
\titlespacing{\subsubsection}{0pt}{3.3ex}{1ex}
26+
\usepackage{color}
27+
28+
% PACKAGES FOR LANGUAGE AND FONT
29+
\usepackage[english]{babel} % The document is in English
30+
\usepackage[utf8]{inputenc} % UTF8 encoding
31+
\usepackage[T1]{fontenc} % Font encoding
32+
\usepackage[11pt]{moresize} % Big fonts
33+
34+
% PACKAGES FOR IMAGES
35+
\usepackage{graphicx}
36+
\usepackage{transparent} % Enables transparent images
37+
\usepackage{eso-pic} % For the background picture on the title page
38+
\usepackage{subfig} % Numbered and caption subfigures using \subfloat.
39+
\usepackage{tikz}
40+
\usetikzlibrary{calc,fit,backgrounds}
41+
\graphicspath{{./Images/}} % Directory of the images
42+
\usepackage{caption} % Coloured captions
43+
\usepackage{xcolor} % Coloured captions
44+
\usepackage{amsthm,thmtools,xcolor} % Coloured "Theorem"
45+
\usepackage{float}
46+
\usepackage{wrapfig}
47+
48+
% STANDARD MATH PACKAGES
49+
\usepackage{amsmath}
50+
\usepackage{amsthm}
51+
\usepackage{amssymb}
52+
\usepackage{amsfonts}
53+
\usepackage{bm}
54+
\usepackage[overload]{empheq} % For braced-style systems of equations.
55+
\usepackage{fix-cm} % To override original LaTeX restrictions on sizes
56+
57+
% PACKAGES FOR TABLES
58+
\usepackage{tabularx}
59+
\usepackage{longtable} % Tables that can span several pages
60+
\usepackage{colortbl}
61+
62+
% PACKAGES FOR ALGORITHMS (PSEUDO-CODE)
63+
\usepackage{algorithm}
64+
\usepackage{algorithmic}
65+
66+
% PACKAGES FOR REFERENCES & BIBLIOGRAPHY
67+
\usepackage[colorlinks=true,linkcolor=black,anchorcolor=black,citecolor=black,filecolor=black,menucolor=black,runcolor=black,urlcolor=black]{hyperref} % Adds clickable links at references
68+
\usepackage{cleveref}
69+
\usepackage[square, numbers, sort&compress]{natbib} % Square brackets, citing references with numbers, citations sorted by appearance in the text and compressed
70+
\bibliographystyle{abbrvnat} % You may use a different style adapted to your field
71+
72+
% OTHER PACKAGES
73+
\usepackage{pdfpages} % To include a pdf file
74+
\usepackage{afterpage}
75+
\usepackage{lipsum} % DUMMY PACKAGE
76+
\usepackage{fancyhdr} % For the headers
77+
\usepackage{verbatim}
78+
\usepackage[dvipsnames]{xcolor}
79+
\usepackage{listings}
80+
\fancyhf{}
81+
82+
% Input of configuration file. Do not change config.tex file unless you really know what you are doing.
83+
\input{./Configuration_Files/config}
84+
85+
%----------------------------------------------------------------------------
86+
% BEGIN OF DOCUMENT
87+
%----------------------------------------------------------------------------
88+
89+
\begin{document}
90+
91+
% \fancypagestyle{plain}{%
92+
% \fancyhf{} % Clear all header and footer fields
93+
% % \fancyhead[RO,RE]{\thepage} %RO=right odd, RE=right even
94+
% \renewcommand{\headrulewidth}{0pt}
95+
% \renewcommand{\footrulewidth}{0pt}}
96+
97+
%----------------------------------------------------------------------------
98+
% TITLE PAGE
99+
%----------------------------------------------------------------------------
100+
101+
\pagestyle{empty} % No page numbers
102+
\frontmatter % Use roman page numbering style (i, ii, iii, iv...) for the preamble pages
103+
104+
\puttitle{
105+
title=Acceptance Testing Document, % Title
106+
course=Software Engineering II, %
107+
project=Best Bike Paths, % Project
108+
authors={Ianosel Bianca Roberta, Gholami Vajihe, Errigo Simone}, %
109+
version=1.0, %
110+
date=08.02.2026, %
111+
link=\href{https://github.com/BIA3IA/Errigo-Gholami-Ianosel.git}{Errigo-Gholami-Ianosel (github.com)} ,
112+
} % These info will be put into your Title page
113+
114+
%----------------------------------------------------------------------------
115+
% PREAMBLE PAGES: ABSTRACT, EXECUTIVE SUMMARY
116+
%----------------------------------------------------------------------------
117+
\startpreamble
118+
\setcounter{page}{1} % Set page counter to 1
119+
120+
%----------------------------------------------------------------------------
121+
% LIST OF CONTENTS/FIGURES/TABLES/SYMBOLS
122+
%----------------------------------------------------------------------------
123+
124+
% TABLE OF CONTENTS
125+
\thispagestyle{empty}
126+
\tableofcontents % Table of contents
127+
\thispagestyle{empty}
128+
% \cleardoublepage
129+
130+
%-------------------------------------------------------------------------
131+
% MAIN TEXT
132+
%-------------------------------------------------------------------------
133+
134+
\addtocontents{toc}{\vspace{2em}} % Add a gap in the Contents, for aesthetics
135+
\mainmatter % Begin numeric (1,2,3...) page numbering
136+
137+
\chapter{Introduction}
138+
\input{Files/introduction}
139+
\label{ch:introduction}%
140+
141+
\chapter{Installation}
142+
\input{Files/installation}
143+
\label{ch:installation}%
144+
145+
\chapter{Testing}
146+
\input{Files/testing}
147+
\label{ch:testing}%
148+
149+
\chapter{Conclusions}
150+
\input{Files/conclusions}
151+
\label{ch:conclusions}%
152+
153+
\chapter{References}
154+
\input{Files/references.tex}
155+
\label{ch:references}%
156+
157+
\chapter{Effort Spent}
158+
\input{Files/effort_spent}
159+
\label{ch:effort_spent} %
160+
161+
%-------------------------------------------------------------------------
162+
% BIBLIOGRAPHY
163+
%-------------------------------------------------------------------------
164+
165+
\addtocontents{toc}{\vspace{2em}} % Add a gap in the Contents, for aesthetics
166+
\bibliography{bibliography} % The references information are stored in the file named "bibliography.bib"
167+
168+
%-------------------------------------------------------------------------
169+
% APPENDICES
170+
%-------------------------------------------------------------------------
171+
172+
% \cleardoublepage
173+
\addtocontents{toc}{\vspace{2em}}
174+
175+
% LIST OF FIGURES
176+
% \listoffigures
177+
178+
% LIST OF TABLES
179+
\listoftables
180+
181+
% \cleardoublepage
182+
\end{document}

‎ATD/Configuration_Files/PoliMi3i.cls‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
% A LaTeX template for MSc Thesis submissions to
2+
% Politecnico di Milano (PoliMi) - School of Industrial and Information Engineering
3+
%
4+
% Copyright 2021 Politecnico di Milano, Italy. Inc. All rights reserved
5+
6+
\NeedsTeXFormat{LaTeX2e}
7+
\ProvidesClass{./Configuration_Files/PoliMi3i}[2021/6/30 PoliMi3i thesis submission class]
8+
\ProcessOptions\relax
9+
10+
%--------------------------------------------------------------------------
11+
% HANDLING THE STYLE OF THE DOCUMENT
12+
%--------------------------------------------------------------------------
13+
\LoadClass[12pt, oneside]{book} % 12 pt font, two-sided book style
14+
\RequirePackage[a4paper, includehead, headheight=0.6cm, inner=3.0cm ,outer=2.0cm, top=2.5cm, bottom=2.5cm]{geometry}
15+
16+
\RequirePackage[bf, font=onehalfspacing]{caption} % caption: FIG in bold, 1.5 line spacing in figure and table captions
17+
\newcommand{\thesisspacing}{\onehalfspacing}
18+
19+
% Define new command: numbered and un-numbered chapter in Polimi style.
20+
21+
\let\latexchapter\chapter
22+
\renewcommand{\chapter}{\@ifstar{\polimichapterstar}{\polimichapter}}
23+
24+
\newcommand{\polimichapter}[1]{
25+
\cleardoublepage % To make sure the previous headers are passed
26+
\phantomsection % To help hyperref link to the right page
27+
\latexchapter{#1}
28+
\renewcommand{\headrulewidth}{0pt} %removing the horizontal line in the header
29+
%\addcontentsline{toc}{chapter}{#1} % Also adds the chapter name to the Contents
30+
% \fancyhead[LO, RE]{ \textbf{\textcolor{bluepoli}\thechapter\hsp\textcolor{bluepoli}{| }\hsp \leftmark}}% Header
31+
% \fancyhead[LE, RO]{\thepage}
32+
\vspace{-1cm}
33+
}
34+
35+
\newcommand{\polimichapterstar}[1]{
36+
\cleardoublepage % To make sure the previous headers are passed
37+
\phantomsection % To help hyperref link to the right page
38+
\latexchapter*{#1}
39+
\renewcommand{\headrulewidth}{0pt} %removing the horizontal line in the header
40+
\addcontentsline{toc}{chapter}{#1} % Also adds the chapter name to the Contents
41+
% \fancyhead[LO, RE]{ \bfseries \textcolor{bluepoli}{| } #1} % Header \textbf{\leftmark} \hspace{1mm}}
42+
% \fancyhead[LE, RO]{\thepage}
43+
\vspace{-1cm}
44+
}
45+
46+
% Define new command: start preamble
47+
\newcommand{\startpreamble}{
48+
\pagestyle{fancy} % Change the header style
49+
\fancyhf{}% Clear header and footer
50+
\renewcommand{\chaptermark}[1]{\markboth{##1}{}} % Getting the chapter name right
51+
\rhead{\thepage} % Page number at the right of the header
52+
\frontmatter % Use roman page numbering style (i, ii, iii, iv...) for the preamble pages
53+
\thesisspacing % Double or single spacing
54+
}
55+
56+
%------------------------------------------------------------------------
57+
% BUILDING THE TITLE PAGE
58+
%------------------------------------------------------------------------
59+
60+
% Define new command: adding background picture (halo) on bottom left (used for empty pages)
61+
\newcommand\BackgroundPic{
62+
\put(-150,-200){%
63+
\parbox[b][\paperheight]{\paperwidth}{%
64+
\vfill
65+
\centering
66+
\transparent{0.4}
67+
\includegraphics[width=0.85\paperwidth]{./raggiera_polimi.eps}
68+
\vfill
69+
}}}
70+
71+
% Define new command: adding background picture (halo) on top right (used for cover page)
72+
\newcommand\BackgroundPicTR{% Adding background picture on top right
73+
\put(200,330){%
74+
\parbox[b][\paperheight]{\paperwidth}{%
75+
\vfill
76+
\centering
77+
\transparent{0.4}
78+
\includegraphics[width=0.70\paperwidth]{./raggiera_polimi.eps}
79+
\vfill
80+
}}}
81+
82+
\RequirePackage{xkeyval} % Handling keyword options.
83+
84+
% Define keys for title pages
85+
\newif\if@cosupervisorexist\@cosupervisorexistfalse
86+
\define@key[OIST]{title}{title}{\def\doctitle{#1}}
87+
\define@key[OIST]{title}{course}{\def\course{#1}}
88+
\define@key[OIST]{title}{project}{\def\project{#1}}
89+
\define@key[OIST]{title}{authors}{\def\authors{#1}\@cosupervisorexisttrue}
90+
\define@key[OIST]{title}{version}{\def\version{#1}}
91+
\define@key[OIST]{title}{date}{\def\date{#1}}
92+
\define@key[OIST]{title}{link}{\def\link{#1}}
93+
94+
\providecommand{\puttitle}{}
95+
\renewcommand{\puttitle}[1]{
96+
\@puttitle{}{#1}
97+
}
98+
99+
\providecommand{\@puttitle}{}
100+
\renewcommand{\@puttitle}[2]{%
101+
\setkeys[OIST]{title}{#2}
102+
103+
\begin{titlepage}
104+
\AddToShipoutPicture*{\BackgroundPicTR}
105+
\vfill
106+
%\begin{minipage}{0.95\textwidth}
107+
\begin{minipage}{0.95\textwidth}
108+
\includegraphics[trim={1.2cm 0 0 0},clip, width=0.7\textwidth] {Images/02_ING_IND_INFORMAZIONE_COL_POSITIVO.eps}
109+
\hfill
110+
\\
111+
\vspace{2.5cm}
112+
113+
{{\color{bluepoli} \singlespacing \large \bfseries \course \par}}
114+
{{\color{bluepoli} \singlespacing \huge \bfseries \doctitle \par}}
115+
\vspace{1.5cm}
116+
117+
\vspace{1.5cm}
118+
{\color{bluepoli} \bfseries \large{\textsc{Project: \project}}\par}
119+
\vspace{1.5 cm}
120+
\end{minipage}
121+
\\
122+
\vspace*{\fill}
123+
\\
124+
\begin{minipage}{0.85\textwidth}
125+
\normalsize{
126+
Authors: {\authors}
127+
\\
128+
Version: {\version}
129+
\\
130+
Date: {\date}
131+
\\
132+
Project Link: {\link}
133+
}
134+
\end{minipage}
135+
\end{titlepage}
136+
}
137+
138+
\newcommand\blankpage{%
139+
\null
140+
\AddToShipoutPicture*{\BackgroundPic}
141+
\thispagestyle{empty}%
142+
\addtocounter{page}{-1}%
143+
\newpage
144+
}

0 commit comments

Comments
 (0)