Accès à la documentation

La documentation sera accessible depuis la perspective "Sysdoc".
Le sommaire des documents sera affichée dans un TreeView qui sera la vue centrale de la perspective Sysdoc
Il sera possible de rechercher un document via une zone de texte. Cette zone de recherche sera une vue persistée de la perspective Sysdoc.
L'affichage de la documentation sera effectuée dans la vue persistée "Visualisation documentation". Par définition, cette vue est détachable.

Accès en mode administration à la perspective Sysdoc

Un menu d'administration sera disponible afin de valider et d'indexer la documentation. Ces actions d'administration ne seront disponibles que si l'application a été lancée avec une option particulière ( à définir), afin d'éviter les erreurs de manipulation.

Le dossier Sysdoc

Le dossier Sysdoc est localisé à la racine du répertoire de la configuration Site. Il est donc commun à toutes les versions des cœurs.

configSite

   |- fudaacrue.clusters ( configuration interne de Fudaa-Crue)
   |- fudaacrue.conf ( configuration interne de Fudaa-Crue)
   |- FudaaCrue_Site.xml ( configuration site)
   +- coeurs
   |    +- coeur-1
   |    |    |- CrueConfigMetier.xml
   |    |    +- exe
   |    |    +- fichiers_vierges
   |    |    +- msg
   |    |    |   |-fr_FR.msg.xml
   |    |    |   |-en_EN.msg.xml
   |    |    +- xsd
   |    +- coeur-2
   +- Sysdoc

Les documents sont réunions par langue:

Sysdoc
   +-fr_FR dossier contenant tous les documents pour la langue fr
   +-en_EN dossier contenant tous les documents pour la langue en

La liste des localisations, soit langue_PAYS, est listée dans la configuration Site.

Contenu de la documentation

La documentation sera fournie au format html et sera visible sans plugin ( flash, applet) particulier. La documentation pourra être issue d'un export de document OpenOffice, Word,...

Arborescence d'un dossier de documentation

Ce paragraphe décrit l'organisation d'un dossier associé à une langue (fr_FR, en_EN).

L'outil de visualisation de la documentation aura besoin d'un dossier "privé" afin d'ajouter l'indexation des pages.

fr_FR
 |-- .sysdoc  dossier contenant des ressources internes nécessaires à la visualisation de la documentation
 |      
 |-01-doc1.html ( la documentation de niveau 1)
 |-02-doc2.html ( la documentation de niveau 1)
 |
 +-dossier-1
     |-index.properties: donne le titre du dossier-1. Si non présent, le nom du dossier sera repris. L'encodage est UTF8 avec BOM
     |-01-doc3.html ( la documentation de niveau 2)

Le sommaire de la documentation sera construit à partir de cette arborescence.
L'ordre naturel des noms de fichiers/dossiers sera utilisé pour ordonner les documents dans le TreeView.

Encodage des fichiers html et des fichiers index.properties

les fichiers html seront encodés par défaut au format UTF-8. L'outil sysdoc pourra toutefois scanner l'entête du fichier html pour récupérer l'encodage du fichier dans une balise META:

<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">

les fichiers index.properties seront encodés au format UTF-8 avec BOM, encodage utilisé pour les fichiers xml.

Récupération de l'information "description" d'une page html

Il est possible d'ajouter une meta-information aux pages html comme la description ( OpenOffice le permet dans les propriétés du document). Cette information sera utilisé par Sysdoc pour afficher une info-bulle sur le document et lors de la recherche de documents. La description est également définie dans une balise META du fichier html:

<META NAME="DESCRIPTION" CONTENT="commentaire du document">

Construction / Indexation des pages

Cette action pourra être disponible depuis la perspective Sysdoc en mode administration. Elle permettra de (re)générer l'indexation des pages.

Validation de la documentation

De même, cette action sera disponible en mode administration. Elle permettra de:

valider les liens issus des fichiers de messages localisés
comparer entre localisation les contenus des dossiers de documentation: vérifier si le contenu de en_EN est identique au contenu de référence fr_FR.

A vérifier: peut-on vérifier qu'un signet ( fichier.html#signet) est bien présent dans un fichier html ?

Documentation pour les EMHs

Dans la perspective modélisation, un bouton d'aide est disponible dans l'éditeur d'EMH. Ce bouton d'aide ouvre Sysdoc et une règle doit déterminer quel fichier doit être ouvert.

Une proposition: le dossier d'aide pourrait contenir un dossier emh qui contiendrait l'aide pour chaque type d'EMH. Ainsi l'arborescence serait:

fr_FR
 |-- .sysdoc
 |  
 +-EMH
     |-index.properties: 
     |-EMHBrancheBarrageFilEau.html

     |-EMHBrancheBarrageGenerique.html

     |-etc

Browser not supported