Merge branch 'master' of gitlab.utc.fr:crozatst/hdoc

README.md

@@ -2,9 +2,7 @@
 
 ## What is Hdoc ?
 
-Please refer to the [Hdoc converter project website](http://hdoc.crzt.fr/co/hdocConverter.html)
-
-*Extract*
+Please refer to the [Hdoc converter project website](http://hdoc.crzt.fr/www/co/hdocConverter.html)
 >The aim of the project is to propose:
 >- a generic XML schema based on XHTML5 for documentary purpose (Hdoc format);
 >- a set of converters to transform document formats from and to Hdoc;

etherpad_to_hdoc/README.md

-# HDOC CONVERTER PROJECT 
\ No newline at end of file
+# Etherpad to Hdoc -- HDOC CONVERTER PROJECT
+## [TL;DR](http://i.imgur.com/18B7f07.jpg)
+- This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format.
+- To do so :
+    1. please place your html files in the `/input` folder
+    2. run the `run.[bat|sh]` script of your choice depending on your OS
+    3. and retrieve the hdoc outputs in the `/output` folder

etherpad_to_lexique/DocumentationEtherpadToLexique.txt

-Documentation Etherpad To lexique
-Comment récupérer un document de type Etherpad et le transformer en document lexique.
-1ère Etape : Télécharger un document Etherpad en format HTML
-•	Créer ou rejoindre un document etherpad (exemple : https://public.etherpad-mozilla.org/p/NF29_HdocEtherpad) puis exporter sous un format html. 
-•	Enregistrer le document html sous le nom de pad.html dans le dossier hdoc\etherpad_to_lexique\antce\input  (Si le dossier n'existe pas, le créer)
-NB : Pour l'instant, il doit y avoir un seul fichier de type Html nommé pad.html
-
-2ème étape : Lancer le fichier de commande run.bat dans le dossier hdoc/etherpad_to_lexique
--> un fichier output.scar est crée dans le dossier hdoc/etherpad_to_lexique/output
-
-2ème étape : Ouvrir le document avec lexique
-•	Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_lexique.
-•	Aller dans le dossier sandBox/etherpad-to-lexique. A cet endroit.
-•	Réaliser un cliquer glisser avec output.scar dans le dossier ou bien faire un clic droit sur le dossier puis Importer pour aller chercher le fichier output.scar.
-•	Ouvrir le fichier Main.xml nouvellement crée pour l'afficher.

etherpad_to_lexique/README.md

+# Etherpad To Lexique -- HDOC CONVERTER PROJECT
+Comment récupérer un document de type Etherpad et le transformer en document lexique.
+
+*les chemins d'accès indiqués sont relatifs à ce fichier readme*
+
+1. Télécharger un document Etherpad en format HTML
+    1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`)
+    2. **Enregistrer le document sous le nom `pad.html`** dans le dossier `/input` (si le dossier n'existe pas, le créer)
+    NB: il ne doit pour le moment n'y avoir qu'un seul fichier nommé de cette façon.
+2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output`
+3. Ouvrir le document produit avec lexique
+    1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_lexique.
+    2. Aller dans le dossier sandBox/etherpad-to-lexique.
+    3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer.
+    4. Ouvrir le fichier Main.xml nouvellement créé.
\ No newline at end of file

etherpad_to_opale/DocumentationEtherpadToOpale.txt

-Documentation Etherpad To Opale
-Comment récupérer un document de type Etherpad et le transformer en document opale.
-1ère Etape : Télécharger un document Etherpad en format HTML
-•	Créer ou rejoindre un document etherpad (exemple : https://public.etherpad-mozilla.org/p/NF29_HdocEtherpad) puis exporter sous un format html. 
-•	Enregistrer le document html sous le nom de pad.html dans le dossier hdoc\etherpad_to_opale\antce\input  (Si le dossier n'existe pas, le créer)
-NB : Pour l'instant, il doit y avoir un seul fichier de type Html nommé pad.html
-
-2ème étape : Lancer le fichier de commande run.bat dans le dossier hdoc/etherpad_to_opale
--> un fichier output.scar est crée dans le dossier hdoc/etherpad_to_opale/output
-
-2ème étape : Ouvrir le document avec opale
-•	Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_opale.
-•	Aller dans le dossier sandBox/etherpad-to-opale. A cet endroit.
-•	Réaliser un cliquer glisser avec output.scar dans le dossier ou bien faire un clic droit sur le dossier puis Importer pour aller chercher le fichier output.scar.
-•	Ouvrir le fichier Main.xml nouvellement crée pour l'afficher.

etherpad_to_opale/README.md

+# Etherpad To Opale -- HDOC CONVERTER PROJECT
+Comment récupérer un document de type Etherpad et le transformer en document opale.
+
+*les chemins d'accès indiqués sont relatifs à ce fichier readme*
+
+1. Télécharger un document Etherpad en format HTML
+    1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`) dans le dossier `/input` (si le dossier n'existe pas, le créer)
+2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output`
+*si le dossier `/input` contient plusieurs fichiers html, ils sont tous traités*
+3. Ouvrir le document produit avec opale
+    1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_opale.
+    2. Aller dans le dossier sandBox/etherpad-to-opale.
+    3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer.
+    4. Ouvrir le fichier Main.xml nouvellement créé.

etherpad_to_optim/DocumentationEtherpadToOptim.txt

-Documentation Etherpad To Optim
-Comment récupérer un document de type Etherpad et le transformer en document optim.
-1ère Etape : Télécharger un document Etherpad en format HTML
-•	Créer ou rejoindre un document etherpad (exemple : https://public.etherpad-mozilla.org/p/NF29_HdocEtherpad) puis exporter sous un format html. 
-•	Enregistrer le document html sous le nom de pad.html dans le dossier hdoc\etherpad_to_optim\antce\input  (Si le dossier n'existe pas, le créer)
-NB : Pour l'instant, il doit y avoir un seul fichier de type Html nommé pad.html
-
-2ème étape : Lancer le fichier de commande run.bat dans le dossier hdoc/etherpad_to_optim
--> un fichier output.scar est crée dans le dossier hdoc/etherpad_to_optim/output
-
-2ème étape : Ouvrir le document avec optim
-•	Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_optim.
-•	Aller dans le dossier sandBox/etherpad-to-optim. A cet endroit.
-•	Réaliser un cliquer glisser avec output.scar dans le dossier ou bien faire un clic droit sur le dossier puis Importer pour aller chercher le fichier output.scar.
-•	Ouvrir le fichier Main.xml nouvellement crée pour l'afficher.

etherpad_to_optim/README.md

+# Etherpad To Optim -- HDOC CONVERTER PROJECT
+Comment récupérer un document de type Etherpad et le transformer en document optim.
+
+*les chemins d'accès indiqués sont relatifs à ce fichier readme*
+
+1. Télécharger un document Etherpad en format HTML
+    1. Créer ou rejoindre un document etherpad puis l'exporter sous un format html (bouton `Importer/Exporter`)
+    2. **Enregistrer le document sous le nom `pad.html`** dans le dossier `/input` (si le dossier n'existe pas, le créer)
+    NB: il ne doit pour le moment n'y avoir qu'un seul fichier nommé de cette façon.
+2. Exécuter le fichier `/run.bat` ou `/run.sh` selon l'OS ; un fichier `.scar` est créé dans le dossier `/output`
+3. Ouvrir le document produit avec optim
+    1. Ouvrir Scenari, ouvrir la liste des entrepôts distants et choisir UTC-etu_optim.
+    2. Aller dans le dossier sandBox/etherpad-to-optim.
+    3. Réaliser un cliquer glisser avec votre fichier `.scar` dans le dossier ou bien faire un clic droit sur le dossier puis Importer.
+    4. Ouvrir le fichier Main.xml nouvellement créé.