...
L'outil de visualisation de la documentation aura besoin d'un dossier "privé" afin d'ajouter l'indexation des pages.
fr_FR
|-- .privatesysdoc 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
|-dossier-1index.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:
| Code Block | ||
|---|---|---|
| ||
<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:
| Code Block | ||
|---|---|---|
| ||
<META NAME="DESCRIPTION" CONTENT="commentaire du document"> |
Construction / Indexation des pages
...
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