2
0
Fork 0
Verif_Herezh/Doc/doc_developpeur.tex

200 lines
5.2 KiB
TeX

\documentclass[a4paper,12pt]{scrartcl}
%\usepackage{isolatin1}
\usepackage[latin1]{inputenc}
\usepackage[francais]{babel}
\usepackage{epsfig,color}
\usepackage{graphicx}
\usepackage{hyperref}
\usepackage{fancybox}
\usepackage{wrapfig}
%\usepackage{pslatex}
\usepackage{amsmath}
\usepackage{subfigure}
%\usepackage{/Users/troufflard/LATEX/BIBLIOTHEQUE/macro_figure}
%\usepackage{eurosym}
\usepackage{calc}
%\usepackage{t1enc}
\usepackage{ifthen}
\usepackage{lscape}
\usepackage{float} % paquet pour placer les images correctement avec \begin{figure}[H]
\usepackage{enumitem}%package pour gérer la puce avec \begin{enumerate}[label={blabla-\arabic*}] (ce qui donne comme puces : blabla-1, blabla-2, etc...)
\usepackage{tabularx}
\usepackage{multirow}
\usepackage{colortbl}
%\newcolumntype{M}[1]{>{\raggedright}m{#1}}
\usepackage{tikz}
\usetikzlibrary{trees}
\addto\captionsfrench{\def\figurename{Figure}}
\addto\captionsfrench{\def\tablename{Tableau}}
%\usepackage{hangcaption}
\oddsidemargin 0.1cm
\evensidemargin -0.9cm
\topmargin -1cm
\headsep 1cm
\textwidth 17cm
\textheight 24cm
\parindent 0.5cm
\raggedbottom
\sloppy
\usepackage{hyperref}
\hypersetup{
colorlinks=true, %colorise les liens
breaklinks=true, %permet le retour à la ligne dans les liens trop longs
urlcolor= blue, %couleur des hyperliens
linkcolor= blue, %couleur des liens internes
citecolor= green %couleur citation biblio
}
%creation d une longueur egale a \baselineskip pour l utiliser dans les tabular (car un bug incroyable fait que \baselineskip est egal a 0 dans les tabular!!!!)
\newlength{\savebaselineskip}
\setlength{\savebaselineskip}{\baselineskip}
\newcommand{\ligne}[1]{
%on change l'unité de longueur "\unitlength" liée à l'environnement "picture"
%\baselineskip = distance entre la base d'une ligne et la base de la ligne suivante
%
% pour info, on a : 1cm = 3\baselineskip (sous réserve d'un changement de la valeur de \baselineskip)
%
\setlength{\unitlength}{\baselineskip}
%on declare un dessin de dimension #1 et de hauteur 0
\begin{picture}(#1,0.)
%on fait une ligne d'origine (0,0.25\baselineskip), dans la direction (1,0) et de longueur #1 (egale a la taille du dessin)
\put(0,0.25){\line(1,0){#1}}
\end{picture}
%Rq : on utilise 0.25\baselineskip pour l'origine afin d'avoir une ligne "centrée" en hauteur, ce qui permet de faire des trucs du genre :
%-------------------
%texte bla bla
%-------------------
%
%au lieu de :
%_____________
%texte bla bla
%_____________
}
\definecolor{greenOK}{RGB}{15 , 185 , 15}
%
% titre, auteur, date
%
\title{Documentation développeur}
\author{Rédacteur principal: Julien Troufflard}
\date{\today}
%\pagestyle{arabic}
\pagenumbering{arabic}
\begin{document}
\maketitle
\tableofcontents
\clearpage
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Introduction}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Ce document s'adresse plus particulièrement aux personnes autorisées à modifier le fonctionnement de la procédure de vérification (membres du projet figurant dans la liste en section \ref{section_personnes_referentes}).\\
Ce document détaille le fonctionnement des scripts et toutes les informations nécessaires pour les faire évoluer.
Concernant l'organisation générale du projet et l'évolution des mises à jour, la documentation utilisateur est pour l'instant suffisante (voir sections 3, 4, 5 et 8 du document \verb|doc_procedure_verification.pdf|).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Personnes référentes}\label{section_personnes_referentes}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Liste des personnes référentes à contacter pour toute question/problème :
\begin{itemize}
\item[\textbullet] Gérard Rio (développeur \verb|Herezh++|)\\
\hspace*{1cm} mail : {\color{blue} gerard.rio@univ-ubs.fr}
\item[\textbullet] Julien Troufflard (développeur scripts procédure de vérification)\\
\hspace*{1cm} mail : {\color{blue} troufflard@univ-ubs.fr}
\end{itemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Scripts du répertoire \texttt{Perl}}\label{section_scripts_repertoire_Perl}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{\texttt{<< nom du script >>}} \label{section_nom_du_script}
\noindent \bf But :\rm
bla bla bla concernant le but
~\\
\noindent \bf Algorithme :\rm
(voir algorithme figure \ref{})
bla bla bla concernant l'algo
~\\
\noindent \bf Variables importantes :\rm
\begin{itemize}[label=-]
\item \verb|nom variable| : bla bla bla
\item ...
\end{itemize}
%%
\clearpage
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Évolution des mises à jour}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{itemize}
\item[$\bullet$] 2015-09-26 (Julien Troufflard) :
\begin{itemize}
\item[-] création de ce document
\end{itemize}%tiret
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%template d ajout d une nouvelle mise à jour (composé d'une puce "bullet" avec Date et auteur de la modif, suivie d une série de puce "-"
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\item[$\bullet$] AAAA-MM-JJ (Prénom Nom) :
%\begin{itemize}
%\item[-] blabla 1
%\item[-] blabla 2
%.
%.
%.
%\item[-] blabla N
%\end{itemize}%tiret
%~\\
\end{itemize}%bullet
\end{document}