%
%     This file is part of the Code_Saturne Preprocessor, element of the
%     Code_Saturne CFD tool.
%
%     Copyright (C) 1998-2007 EDF S.A., France
%
%     contact: saturne-support@edf.fr
%
%     The Code_Saturne Preprocessor is free software; you can redistribute it
%     and/or modify it under the terms of the GNU General Public License
%     as published by the Free Software Foundation; either version 2 of
%     the License, or (at your option) any later version.
%
%     The Code_Saturne Preprocessor is distributed in the hope that it will be
%     useful, but WITHOUT ANY WARRANTY; without even the implied warranty
%     of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%     GNU General Public License for more details.
%
%     You should have received a copy of the GNU General Public License
%     along with the Code_Saturne Preprocessor; if not, write to the
%     Free Software Foundation, Inc.,
%     51 Franklin St, Fifth Floor,
%     Boston, MA  02110-1301  USA
%
%---------------------------------------------------------------------
%
% Auteur  : 
% Date    : 
% Numéro  : 
% Version :
%
%---------------------------------------------------------------------

%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% SYNTHÈSE
\vspace*{0.1cm}
\begin{center}
\textbf{\large \titreCS}\\
\medskip
\textit{SYNTH\`ESE}
\end{center}
\vspace*{1cm}
\pdfbookmark[1]{Synthèse}{synthese}

Ce document a été conçu comme un manuel pour développeur~:
il a pour objectif de permettre à un développeur
de trouver certaines informations particulières
et d'aider un futur développeur à pénétrer le code.

Cependant, on ne trouvera rien dans ce document de ce qui pourrait être obtenu
par un utilitaire de documentation automatique
(comme une référence de fonctions par exemple).\\
Les essais de documentation automatique, qui ont précédé
l'écriture de ce document, se sont avérés positifs~:
avec des utilitaires, on peut générer des documents exploitables\footnote{%
Avec l'utilitaire Doxygen, on obtient une documentation au format HTML
très complète avec la prise en compte de certains commentaires des sources.
L'utilitaire cxref permet de produire une documentation plus compacte qui peut
être sortie sur papier.}
qui contiennent tout ce qui serait pénible
à transcrire sous traitement de texte, plus ou moins manuellement.
L'utilité de ce qui est produit est par contre assez limitée pour
un développeur qui a de toutes façons accès à l'ensemble des sources,
et qui utilise un environnement de développement performant
permettant notamment de suivre les appels de fonctions dans les sources.

Au contraire, ce document comporte, soit des informations
synthétiques sur la structure du code,
soit des informations précises
sur des points particuliers de programmation.

Les deux premiers chapitres donnent une description
du contexte dans lequel s'inscrit le \pcs
ainsi qu'un aperçu global des fonctionnalités associées.\\
Les trois chapitres suivants exposent la manière dont le \pcs a été
structuré et les principes qui ont été à la base de son architecture.\\
Les quatre derniers chapitres intéresseront au premier chef les programmeurs,
directement concernés par les outils mis en place dans le \pcs,
permettant d'intégrer de nouvelles fonctionnalités.

\vspace{1truecm plus 1truecm minus 1truecm}

\underline{Conventions typographiques}

Les conventions typographiques suivantes sont utilisées
dans le \pcs~:

\begin{liste}
\item le vocabulaire propre au \pcs est écrit
  dans \fenv{la police de caractères penchée}
  (exemples~: \entite, \champ).\\
  Les mots dans cette police sont automatiquement référencés
  dans l'index en fin de document.
\item le vocabulaire relatif à l'approche \og objet \fg ou au langage \uml
  est dans \fobj{la police de caractères italique}
  (exemples~: \classe, \paquet).\\
  Ces mots sont automatiquement référencés
  dans l'index.
\item les noms des catégories \og objet \fg propres au \pcs sont dans
  \fcla{la police de caractères \og sans sérif \fg}
  (exemples~: \Entite, \Champ).\\
  Ces mots sont automatiquement référencés
  dans l'index.
\item \fc{la police de caractères \og courrier \fg} est réservée
    à la transcription du code en langage~C ou des instructions UNIX.\\
    Certains noms de types définis, de fichiers ou de fonctions sont
    référencés dans l'index.
\end{liste}

%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% EXECUTIVE SUMMARY
%\passepage
%\vspace*{0.1cm}
%\begin{center}
%\textbf{\large \titreang}\\
%\medskip
%\textit{EXECUTIVE SUMMARY}
%\end{center}
%\vspace*{1cm}
%\pdfbookmark[1]{Excutive summary}{executive summary}
%
%This is the executive summary of the report.
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%%% Local Variables: 
%%% mode: latex
%%% TeX-master: "rapport"
%%% End: 
