doc/userguide.txt

   1 =================================================================
   2 User's guide, for developpers and users
   3 =================================================================
   4
   5 *html version of this document is produced with docutils*::
   6
   7   rst2html < doc.txt > doc.html
   8
   9 *This document corresponds to SALOME2 3.2.0 (beta version)*
  10
  11 .. contents::
  12 .. sectnum::
  13
  14 +-------------------------------------------+
  15 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  16 +-------------------------------------------+
  17
  18 -------------------------------------------------------------------------------
  19
  20 This guide provides you with some basic concepts for developing and
  21 using the SALOME platform. You will find some information on the
  22 general technical architecture ...
  23
  24 Introduction
  25 ============
  26
  27 General information
  28 -------------------
  29
  30 This document has been initialized by collecting and updating an existing
  31 documentation. The restructured text format has been selected for
  32 writing. This format can be read with a basic editor except for
  33 pictures and some hypertext links. You can build the html pages using
  34 the docutils scripts provided with python packages on most platform.
  35
  36 Definitions
  37 -----------
  38
  39 ``WORK IN PROGRESS``
  40
  41 Module
  42    definition of a module and/or link to the definition
  43
  44 Container
  45    definition of a container
  46
  47
  48 General concepts
  49 ================
  50 modules et dépendances (s'inspirer de PYHELLO)
  51
  52
  53 Filesystem organisation
  54 ========================
  55
  56 Voir doc de JR "Organisation de la plate-forme"
  57
  58 A typical source working directory
  59 ----------------------------------
  60 organisation type des sources d'un module standard (spécifications techniques)
  61
  62 A typical installation directory
  63 --------------------------------
  64 organisation type des produits installés
  65
  66
  67 Building process
  68 ================
  69 Procédures de compilation (renvoie au install.sh)
  70
  71
  72 Developer's guide - basic concepts
  73 =========================================
  74
  75 Guide du développeur: éléments de conception
  76   - zoom sur certains éléments techniques bons à connaitre pour faire
  77     évoluer le KERNEL sans tout casser.
  78   - les ressources du kernel:
  79     - trace, debug, exception (cf. kernel_ressources.tex)
  80     - classes batch (présentation puis renvoi à la doc d'Ivan)
  81   - développement de tests unitaires
  82
  83 Developer's guide - managing the development space
  84 ==================================================
  85
  86 - Guide du développeur: gestion de l'espace de développement
  87   - principe de mise en oeuvre (rôle des étapes: build_configure, ...)
  88   - description des fichiers m4 et du principe de mise en oeuvre
  89   - les Makefile.in, ... (cf. doc guide du développeur).
  90   - évolution des procédures de construction
  91   - personalisation des procédures de construction
  92
  93 Developer' guide - integration tools
  94 ====================================
  95 - Guide de l'intégrateur (développeur de nouveaux modules)
  96 (on lui montre ici le principe de construction et les ressources à
  97 disposition pour faire le travail)
  98   - création d'un modules
  99   - intégration code boîte noire (perfect, solver)
 100   - intégration bibliothèque de fonctions (hxx2salome, voir avec
 101     N.Crouzet)
 102   - intégration de modèles de données (xdata)
 103
 104
 105 End user's guide
 106 ================
 107 - Guide de l'utilisateur
 108   - concept d'application (renvoie doc Paul)
 109   - commandes avancées (showNS, exemple de contact de la
 110     session, d'un engine, utilisation du lifeCycle, du module salome,
 111     des modules geompy et smesh)
 112   - utilisation en mode distribué (doc de B. Sechet)
 113   - GUI and TUI documentation
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129 RST Exemples
 130 ============
 131
 132 See INSTALL_ for general information on required configuration and
 133 prerequisites, compilation procedure, setting environment principles.
 134
 135 .. _INSTALL: ./INSTALL.html
 136
 137
 138 -------------------------------------------------------------------------------
 139
 140 +----------------------------------+------------------------------------------+
 141 | `General KERNEL documentation`_  | `End User KERNEL Doxygen documentation`_ |
 142 +----------------------------------+------------------------------------------+
 143
 144 .. _`General KERNEL documentation`:           ./index.html
 145 .. _`End User KERNEL Doxygen documentation`:  ./tui/KERNEL/index.html