diff --git a/README.md b/README.md
index 8a7c60a1674c3e76982c645f88266cfa01814251..a7c558e40638d5c8b8a7dead949d85cc39d8de61 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,23 @@
-# HDOC CONVERTER PROJECT
+# Hdoc Converter Projet
+
+License GPL3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+Credits :
+Université de Technologie de Compiègne (http://www.utc.fr)
+NF29 students (http://www4.utc.fr/~nf29)
## What is Hdoc ?
-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;
->- a web site to manage the converters (Hdoc Converter Portal).
+Please refer to the Hdoc Converter Project website:
+
+http://hdoc.crzt.fr
## What is this repository ?
+This repository gathers some of the Hdoc converters, if not all of them.
+
+Project URL : https://gitlab.utc.fr/crozatst/hdoc.git
+
+## How to use Hdoc Converters ?
-This repository gathers some of the Hdoc converters, if not all of them.
\ No newline at end of file
+In order to use a converter, choose the corresponding folder and consult README.md for instructions.
diff --git a/etherpad_to_hdoc/README.md b/etherpad_to_hdoc/README.md
old mode 100644
new mode 100755
index b1549b2f19ac8e3d69bdb5bf55cf77d9771db029..8db8aae613ea34c7fc0cd7dc668cc66f929f0087
--- a/etherpad_to_hdoc/README.md
+++ b/etherpad_to_hdoc/README.md
@@ -1,7 +1,76 @@
-# 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
+# Converter etherpad_to_hdoc
+
+## License
+License GPL3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+## Crédits
+- 2015
+ - Jean-Côme Douteau
+ - Gabrielle Rit
+ - Jean Vintache
+- 2014
+ - Fecherolle Cécile
+
+## Presentation
+This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format.
+
+## User documentation
+
+### Running etherpad_to_hdoc.ant
+ 1. Create an etherpad document and export it as an html file.
+ 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
+
+## Unsupported
+ - Markdown
+ - Author paternity
+ - Etherpad timeline
+ - Chat
+
+## Known bugs
+- Nested lists in lists are not supported
+Example :
+`
+ -
+
+ -
+ Never gonna give you up.
+
+
+
+`
+- As a consequence, etherpad indentation is not supported because it is coded as nested lists.
+## TODO
+ - Markdown
+
+## Technical notes
+### Description of etherpad_to_hdoc.ant
+
+#### Prelude
+ - Importation of necessary classes (antlib, htmlcleaner, jing)
+ - Creation of directories architecture tree
+
+#### Transformations
+ - Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
+ - Apply html2xhtml.xsl : this xsl extracts the content into tags
+ - Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
+ - Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
+ - Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
+ - Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
+
+#### Post-transformations actions
+ - Build hdoc structure
+ - Jing checks if the output file is validated with the right rng schema
+ - Zip the directory into hdoc archive
+
+### Supported tags
+html tags -> hdoc tags
+ - u, s, em, strong -> em
+ - li -> li
+ - ol -> ol
+ - br -> p
+
+## Capitalisation
+We learned how to use xsl sheets with text file as an input : we had to use regular expressions to extract content.
\ No newline at end of file
diff --git a/etherpad_to_lexique/README.md b/etherpad_to_lexique/README.md
index 28b41e087a855b6f413ecb16706fc614d5665d0b..4845fcd1699ac2810c80cfa6da65c61921cb76e0 100644
--- a/etherpad_to_lexique/README.md
+++ b/etherpad_to_lexique/README.md
@@ -1,15 +1,71 @@
-# 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
+# Etherpad2Lexique -- HDOC CONVERTER PROJECT
+## License
+[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
+## Credits
+- Rit Gabrielle
+- Vintache Jean
+- Douteau Jean-Côme
+- Fecherolle Cécile (2014)
+##Presentation
+How to transform an etherpad document in lexique document.
+Filepath in this document are relative to this file readme.
+## Dependence
+- Etherpad2Hdoc
+- Hdoc2Lexique
+## User Documentation
+1. Download an etherpad document in html format.
+ 1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
+ 2. Name it pad.html
+2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
+*If the `/input` directory contains multiple files, they won't be all treated.
+3. Open the document with Scenari
+ 1. Open Scenari, and choose "UTC-etu_lexique" as distant depot.
+ 2. Go in the directory `sandBox/etherpad-to-lexique.`
+ 3. Import your `.scar` file in the directory.
+ 4. Open the file Main.xml created.
+##Unsupported
+- MarkDown
+- Timeline and author paternity
+- Chat
+##Known bugs
+Nested lists in lists are not supported
+example :
+`
+ -
+
+ -
+ Never gonna let you down.
+
+
+
+`
+
+## TODO
+- Work with markdown
+- Correct nested lists
+## Technical notes
+### Description of etherpad_to_hdoc.ant
+
+#### Prelude
+ - Importation of necessary classes (antlib, htmlcleaner, jing)
+ - Creation of directories architecture tree
+
+#### Transformations
+ - Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
+ - Apply html2xhtml.xsl : this xsl extracts the content into tags
+ - Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
+ - Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
+ - Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
+ - Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
+
+#### Post-transformations actions
+ - Build hdoc structure
+ - Jing checks if the output file is validated with the right rng schema
+ - Zip the directory into hdoc archive
+
+## Capitalisation
+
+
+
+
+
diff --git a/etherpad_to_opale/README.md b/etherpad_to_opale/README.md
index 0d1fffddc78a26e66d1e2dd858fe3f740bd4aa9d..38074fdec4c502ad88e18fd2b4fb7ab08d9e0a1f 100644
--- a/etherpad_to_opale/README.md
+++ b/etherpad_to_opale/README.md
@@ -1,14 +1,70 @@
-# 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éé.
+# Etherpad2Opale -- HDOC CONVERTER PROJECT
+## License
+[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
+## Credits
+- Rit Gabrielle
+- Vintache Jean
+- Douteau Jean-Côme
+- Fecherolle Cécile (2014)
+##Presentation
+How to transform an etherpad document in opale document.
+Filepath in this document are relative to this file readme.
+## Dependence
+- Etherpad2Hdoc
+- Hdoc2Opale
+## User Documentation
+1. Download an etherpad document in html format.
+ 1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
+2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
+*If the `/input` directory contains multiple files, they will be all treated.
+3. Open the document with Opale
+ 1. Open Scenari, and choose "UTC-etu_opale" as distant depot.
+ 2. Go in the directory `sandBox/etherpad-to-opale.`
+ 3. Import your `.scar` file in the directory.
+ 4. Open the file Main.xml created.
+##Unsupported
+- MarkDown
+- Timeline and author paternity
+- Chat
+##Known bugs
+Nested lists in lists are not supported
+example :
+`
+ -
+
+ -
+ Never gonna give you up.
+
+
+
+`
+
+## TODO
+- Work with markdown
+- Correct nested lists
+## Technical notes
+### Description of etherpad_to_hdoc.ant
+
+#### Prelude
+ - Importation of necessary classes (antlib, htmlcleaner, jing)
+ - Creation of directories architecture tree
+
+#### Transformations
+ - Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
+ - Apply html2xhtml.xsl : this xsl extracts the content into tags
+ - Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
+ - Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
+ - Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
+ - Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
+
+#### Post-transformations actions
+ - Build hdoc structure
+ - Jing checks if the output file is validated with the right rng schema
+ - Zip the directory into hdoc archive
+
+## Capitalisation
+
+
+
+
+
diff --git a/etherpad_to_optim/README.md b/etherpad_to_optim/README.md
index 8b46270784057dbe4328617a4258c156212ae38b..6c3751356a78be79904e05735e1e2f351d12cf04 100644
--- a/etherpad_to_optim/README.md
+++ b/etherpad_to_optim/README.md
@@ -1,15 +1,71 @@
-# 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éé.
+# Etherpad2Optim -- HDOC CONVERTER PROJECT
+## License
+[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
+## Credits
+- Rit Gabrielle
+- Vintache Jean
+- Douteau Jean-Côme
+- Fecherolle Cécile (2014)
+##Presentation
+How to transform an etherpad document in optim document.
+Filepath in this document are relative to this file readme.
+## Dependence
+- Etherpad2Hdoc
+- Hdoc2Optim
+## User Documentation
+1. Download an etherpad document in html format.
+ 1. Create or join an etherpad document then export it in html format (Import/Export Button) in the `/input` directory (if the directory does not exists, you have to create it).
+ 2. Name it pad.html
+2. Execute the file `/run.bat` or `/run.sh` depending on the OS. A `.scar` file is created in the directory `/output`
+*If the `/input` directory contains multiple files, they won't be all treated.
+3. Open the document with Scenari
+ 1. Open Scenari, and choose "UTC-etu_optim" as distant depot.
+ 2. Go in the directory `sandBox/etherpad-to-otpim.`
+ 3. Import your `.scar` file in the directory.
+ 4. Open the file Main.xml created.
+##Unsupported
+- MarkDown
+- Timeline and author paternity
+- Chat
+##Known bugs
+Nested lists in lists are not supported
+example :
+`
+ -
+
+ -
+ Never gonna let you down.
+
+
+
+`
+
+## TODO
+- Work with markdown
+- Correct nested lists
+## Technical notes
+### Description of etherpad_to_hdoc.ant
+
+#### Prelude
+ - Importation of necessary classes (antlib, htmlcleaner, jing)
+ - Creation of directories architecture tree
+
+#### Transformations
+ - Use of htmlcleaner to transform the input file from html to xhtml. For more info, see http://htmlcleaner.sourceforge.net/index.php.
+ - Apply html2xhtml.xsl : this xsl extracts the content into tags
+ - Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
+ - Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
+ - Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
+ - Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure
+
+#### Post-transformations actions
+ - Build hdoc structure
+ - Jing checks if the output file is validated with the right rng schema
+ - Zip the directory into hdoc archive
+
+## Capitalisation
+
+
+
+
+
diff --git a/hdoc_to_opale/input/sample.hdoc b/hdoc_to_opale/input/sample.hdoc
index 90c078ac0e8c94614d14901ab9318075c7597dce..094c7bf9cb2f84ec9e753ab34562e5035da2c7f7 100644
Binary files a/hdoc_to_opale/input/sample.hdoc and b/hdoc_to_opale/input/sample.hdoc differ
diff --git a/hdoc_to_opale/xsl/moveRessourceFiles.xsl b/hdoc_to_opale/xsl/moveRessourceFiles.xsl
index 54ae92b8fb964d8561ec2badd607e69e0370ccc5..68c70307464572277319b7338c99201151fb0c78 100644
--- a/hdoc_to_opale/xsl/moveRessourceFiles.xsl
+++ b/hdoc_to_opale/xsl/moveRessourceFiles.xsl
@@ -5,14 +5,14 @@
>
-
+
-
+
@@ -32,16 +32,16 @@
-
+
-
+
-
+
-
+
diff --git a/hdoc_to_opale/xsl/prepareCourseUcCopies.xsl b/hdoc_to_opale/xsl/prepareCourseUcCopies.xsl
index a89dd43457f77698ea29f204b57688aaf21d5bed..933d47d06765d0a78850d87a82b8ba5d469f1b8a 100644
--- a/hdoc_to_opale/xsl/prepareCourseUcCopies.xsl
+++ b/hdoc_to_opale/xsl/prepareCourseUcCopies.xsl
@@ -18,7 +18,7 @@
-
+
diff --git a/hdoc_to_opale/xsl/transformation0.xsl b/hdoc_to_opale/xsl/transformation0.xsl
index c6ddb6f8fe2cb59e2d0a351c7ae586a022966563..55e8568ece91f70ed8c63057d3dd16a5def43518 100644
--- a/hdoc_to_opale/xsl/transformation0.xsl
+++ b/hdoc_to_opale/xsl/transformation0.xsl
@@ -36,7 +36,7 @@
style="${{xsl}}/moveRessourceFiles.xsl"
processor="org.apache.tools.ant.taskdefs.optional.TraXLiaison"
>
-
+
' (ex : 'sh run.sh -DinputPath input/')
-#2 : You want to convert ONE specific freemindFile in Hdoc
-- Put your file in a folder mindmapping_to_hdoc/input
-- Enter the command line corresponding to your OS :
-- On Linux : sh run.sh -DinputPath input/
-- On Windows : run.bat -DinputPath input/
+*You will find the result of the conversion in the folder mindmapping_to_hdoc/output*
+*You can find a sample file il the folder /samples.*
-You will find the result in the folder mindmapping_to_hdoc/result
+You can use the converter mindmapping_to_opale in order to create Opale contents.
Unsupported
-----------
* Convert color
-* Convert icon into summary elements.
-* headers (especially keywords) are partially supported.
+* Convert icon into summary elements
Known bugs
----------
@@ -53,9 +50,8 @@ Known bugs
Todo
----
-* Get mindmap from Framamind
-* Mindmap to lexique conversion
-* Mindmap to optim conversion
+* Mindmap to Lexique conversion
+* Mindmap to Optim conversion
Technical notes
---------------
@@ -66,9 +62,6 @@ You can comment the part of code where temp directory is deleted in order to vie
What is META-INF folder ?
This is a simple folder with a xml file named 'content.xml' that contains useful information for Opale. Every .scar archives must contain this file, what it exactly does is not the purpose of this project.
-Freemind / HDOC
-
--- INSERT doc_language.md --
Capitalisation
--------------
diff --git a/mindmapping_to_opale/README.md b/mindmapping_to_opale/README.md
index eaa109c39a783fd38b104c19863792e9b244795c..e9e1c4f8dc115910558b6661a04f8effb34c21c7 100644
--- a/mindmapping_to_opale/README.md
+++ b/mindmapping_to_opale/README.md
@@ -1,46 +1,108 @@
-Mindmapping to HDOC
-===================
+Mindmapping to Opale
+=================
-Conversion of Freemind file(s) (.mm) to Opale
+Conversion of Freemind file(s) (.mm) to Opale (.scar)
-# How to use the converter
+## Licence
+-------------------------------
+http://www.gnu.org/licenses/gpl-3.0.txt
-Use a terminal and go to the root of the folder (mindmapping_to_opale).
+## Credits
+-------------------------------
+This section has been written by
-#1 : You want to convert SEVERAL Freemind files in Opale
-- Put your files in a folder mindmapping_to_opale/input
-- Enter the command line corresponding to your OS :
-- On Linux : sh run.sh
-- On Windows : run.bat
+* Thibault BROCHETON
+* Bastien FREMONDIERE
+* Amélie PERDRIAUD
-#2 : You want to convert ONE specific freemindFile in Opale
-- Put your file in a folder mindmapping_to_opale/input
-- Enter the command line corresponding to your OS :
-- On Linux : sh run.sh -DinputPath input/
-- On Windows : run.bat -DinputPath input/
+It is based on the work of Guillaume GOMEZ in 2014.
-You will find the result in the folder mindmapping_to_opale/output
+## Presentation
+The project aims at converting Freemind files in Opale files.
-IMPORTANT
-=========
+## Dependence
+-------------------------------
+In dependence with mindmapping_to_hdoc and hdoc_to_opale
+
+## User documentation
+-------------------------------
+
+* Use a terminal and go to the root of the folder (mindmapping_to_opale).
+* Please refer to the part *Rules to follow* to understand the rules that can help you to personalize the output
+* Put your files in a folder 'mindmapping_to_opale/input'
+* Enter the command line corresponding to your OS :
+ * On Linux : 'sh run.sh'
+ * On Windows : 'run.bat'
+If you want to convert one specific file that is in the input folder, use the parameters ' -DinputPath input/' (ex : 'sh run.sh -DinputPath input/')
+
+*You will find the result of the conversion in the folder mindmapping_to_opale/output*
+*You can find a sample file il the folder /samples.*
+
+### Rules to follow
You can use special rules in Freemind to personnalize your Scenari Module :
-- By default, a "Division" is created with the name of the main node of your MindMap
-- Then :
- A node without children is transformed in grain content
- A node with children is transformed in division
-- You can add introduction and conclusion using the hashtag #intro and #conclu on all the node that has no child
-- You can use #p to create a paragraph, and #a to create a link
-- You can use the hashtag :
- #rmk : a remark
- #adv : an advice
- #emph : an emphasis
- #compl : a complement
- #wrng : a warning
- #ex : an example
- #def : a definition
- Then you can add some #p inside these node to create the content
-- You can arrange the order of the node usine the hashtag #1, #2, #3 etc.
+* By default, a "Division" is created with the name of the main node of your MindMap
+* Then :
+ * A node without children is transformed in **grain content**
+ * A node with children is transformed in **division**
+* You can add introduction and conclusion using the hashtag **#intro** and **#conclu** on all the node that has no child
+* You can use **#p** to create a paragraph, and **#a** to create a link
+* You can use some hashtags to create specific contents :
+ * **#rmk** : a remark
+ * **#adv** : an advice
+ * **#emph** : an emphasis
+ * **#compl** : a complement
+ * **#wrng** : a warning
+ * **#ex** : an example
+ * **#def** : a definition
+ * *Then you can add some **#p** inside these node to create the content*
+- You can arrange the order of the node usine the hashtag **#1, #2, #3** etc.
+
+## Unsupported
+
+* Convert colors
+* Convert icon into summary elements
+* HTML node
+
+## Known bugs
+
+## TODO
+
+* Develop new hashtags to create other type of Opale contents (such as QCM, self-evaluation etc.)
+
+## Technicals notes
+
+### Preamble
+This subsection will explain precisely how the conversion process works. If you are reading this, we assume you are familiar with XML technologies seen in NF29 (i.e. ANT scripts, XSL-XSLT transformations and Hdoc format). We also recommend you to open sources files and read the comments.
+Besides, the converter have been tested on recent ANT versions (> 1.7.0) only. It depends on hdoc_to_opale module.
+
+### How does the converter works
+This converter is using standard NF29 conversion project structure : a main ANT file (mindmapping_to_opale.ant), which handles routine tasks (zipping archives, copying files, order tasks), XSL-XSLT transformation scripts calls. This main ANT file is composed of several targets, and supports both Windows or Linux platforms.
+This ant file is called by a script (run.sh or run.bat), with ou without parameters.
+
+### Hdoc files
+During the conversion process, the converter is using the converter mindmapping_to_hodc. The result of this conversion is also available in the folder output.
+
+### What does the main ANT file do ?
+
+* Delete and create folder temp, output, output/hdoc and output/scar
+* Check if the OS is Windows or Mac, and call the appropriate target
+* If there is no input path in parameters, it converts all the files present in the input folder
+* It calls the converter mindmapping_to_hdoc to convert .mm files in .hdoc files.
+* Copy the results of the conversion in the folder /output/hdoc
+* It calls the converter hdoc_to_opale to convert .hdoc files in .scar files
+* Copy the results of the conversion in the folder /output/scar
+* Finally, clean temporary files
+
+## Capitalization
+
+### New technologies/languages discovered
+* ANT
+* XPath
+* XSL-XSLT
+### New IDEs/frameworks discovered
+* Oxygen XML editor
+* Scenario chain (Opale advanced)
\ No newline at end of file
diff --git a/mindmapping_to_opale/mindmapping_to_opale.ant b/mindmapping_to_opale/mindmapping_to_opale.ant
index 0aef2955a075f5534748c9e8d491c6111d9c791a..da182def7cd70e050e1aa5b44c7aca13ec9978c9 100755
--- a/mindmapping_to_opale/mindmapping_to_opale.ant
+++ b/mindmapping_to_opale/mindmapping_to_opale.ant
@@ -166,9 +166,6 @@
-
-
Setting up the conversion
@@ -182,25 +179,4 @@
--- End ----
-
-
- Begin data conversion
-
-
-
-
-
-
-
-
-
-
-
-
- end data conversion
-
-
diff --git a/optim_to_hdoc/README.MD b/optim_to_hdoc/README.MD
index b4ba5b631dd111695a2d6464afc7737f8c4271be..ac5d72cfdad69a1795653ab566a1eaa21471977d 100644
--- a/optim_to_hdoc/README.MD
+++ b/optim_to_hdoc/README.MD
@@ -4,8 +4,7 @@ Optim to Hdoc
Licence
-------
-License GPL3.0
-http://www.gnu.org/licenses/gpl-3.0.txt
+This project is under [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt).
Credits
@@ -18,6 +17,7 @@ User documentation
------------------
Use the project as describe in the root README. You can convert multiple files by putting all `.scar` in the input folder.
+You can convert paper, section, website, slideshow and webpage.
Known bugs
diff --git a/optim_to_opale/input/sample.scar b/optim_to_opale/input/sample.scar
index d3a713bdae118d7a5ed454e08f2443d917380ff1..5cebe57f9ab0bc0b2675e2b86f7ecd82e9c11a45 100644
Binary files a/optim_to_opale/input/sample.scar and b/optim_to_opale/input/sample.scar differ
diff --git a/optim_to_opale/readme.md b/optim_to_opale/readme.md
index d1b72681a4f06cdf4813910281ed2a9cbce11b7f..08b62f4a3885ae0dd14496c00813905024130240 100644
--- a/optim_to_opale/readme.md
+++ b/optim_to_opale/readme.md
@@ -11,12 +11,12 @@ Credits
### Autumn 2015
* Ivan D'HALLUIN
-* JEFFREY DECORDE
+* Jeffrey DECORDE
* Jean-Baptiste MARTIN
Presentation
------------
-`optim_to_opale` is an ANT script that converts a file from Optim format to Opale format. It simply calls `optim_to_hdoc`and `hdoc_to_opale`scripts.
+`optim_to_opale` is an ANT script that converts a file from Optim format to Opale format. It simply calls `optim_to_hdoc` and `hdoc_to_opale` scripts.
Dependencies
------------
@@ -30,25 +30,28 @@ User Documentation
### Running the script
1. Put the file you want to convert into the `input` directory
-2. Run the `run.sh`file on a Unix system (Linux, Mac OS, etc.) or the `run.bat`on Windows
-3. Your converted file is placed into the `output` directory (a log file is also placed into the `log`directory)
+2. Run the `run.sh` file on a Unix system (Linux, Mac OS, etc.) or the `run.bat` on Windows
+3. Your converted file is placed into the `output` directory (a log file is also placed into the `log` directory)
4. Enjoy!
### How is this script working
1. The script first determines what OS you are using so it then can call the right scripts
-2. It cleans the `log`, `tmp`and `output`directories
-3. It copies the files that are inside the `input`directory to the `input` directory of `optim_to_hdoc`
-4. It calls `optim_to_hdoc`run script (`.bat` on windows, `.sh`on Unix)
-5. It copies the files that are inside the `output`directory of `optim_to_hdoc` to the `input` directory of `hdoc_to_opale`
-6. It calls `hdoc_to_opale`run script (`.bat` on windows, `.sh`on Unix)
-7. It copies the files that are inside the `output`directory of `hdoc_to_opale` to the `output` directory of `optim_to_opale`
+2. It cleans the `log`, `tmp` and `output` directories
+3. It copies the files that are inside the `input` directory to the `input` directory of `optim_to_hdoc`
+4. It calls `optim_to_hdoc` run script (`.bat` on windows, `.sh` on Unix)
+5. It copies the files that are inside the `output` directory of `optim_to_hdoc` to the `input` directory of `hdoc_to_opale`
+6. It calls `hdoc_to_opale` run script (`.bat` on windows, `.sh` on Unix)
+7. It copies the files that are inside the `output` directory of `hdoc_to_opale` to the `output` directory of `optim_to_opale`
During all the process it also prints some basic information both on screen and in the log file.
Unsupported
-----------
-* The script currently doesn't support any paramater to specify the file to convert. If multiple files are in the `input`directory, the script will convert all these files.
+
+### Single file conversion with parameter
+
+The script currently doesn't support any paramater to specify the file to convert. If multiple files are in the `input` directory, the script will convert all these files.
Known bugs
----------
@@ -57,9 +60,19 @@ N/A for now.
Todo
----
+### Single file conversion with parameter
+
+This feature requires that the same feature has been implementing in `optim_to_hdoc` and `hdoc_to_opale` first.
+
+1. Add a parameter to the `ant` script and to both the `.bat` and `.sh` scripts to accept a filename (refering to a file placed into the `input` directory) to convert only one file
+2. Don't clean `optim_to_hdoc` and `hdoc_to_opale` `input` directories: simply remove the lines in the `clean` target
+3. Call `optim_to_hdoc` and `hdoc_to_opale` scripts by passing a parameter with the filename (this feature first needs to be implementing in `optim_to_hdoc` and `hdoc_to_opale`
+
Technical notes
---------------
Capitalization
--------------
+While working on this project, we have learned more about ANT scripting (more specifically bulding an multi-os script and running scripts by detecting the OS) and about problem solving in general (how to go from one specific need to a result).
+
diff --git a/wikipedia_to_hdoc/README.md b/wikipedia_to_hdoc/README.md
index 8cfee5772752dd61148f6de8a2480d4a65251b7f..329ce105e252ca1ca866d0353a095143631b5468 100644
--- a/wikipedia_to_hdoc/README.md
+++ b/wikipedia_to_hdoc/README.md
@@ -1,5 +1,5 @@
Converter : Wikipedia_to_Hdoc
----------------
+===============
Licence :
---------------
@@ -17,8 +17,11 @@ Lhomme Nicolas
Previous developers
+Presentation
+---------------
+This converter transforms a wkipedia page (from a link or a saved page) to a Hdoc document.
-Getting started
+User Documentation
---------------
Use a terminal and go to the root of the folder (Wikipedia_to_hdoc).
@@ -84,7 +87,11 @@ Concerning tables :
3 - Display complex tables as tables in Opale (not as extern files)
-
+Technical notes
+---------------
+For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml. Read the commentary and it will help you
+to finish the to do task regarding images. These files are included just for the seek of Capitalization.
+
Be aware of the following things
---------------------------------------------------------
1 - Not all images have a metadata information (only the ones who )
diff --git a/wikipedia_to_hdoc/xslt/get-ressources-with-meta.xsl b/wikipedia_to_hdoc/xslt/get-ressources-with-meta.xsl
new file mode 100644
index 0000000000000000000000000000000000000000..0ee5eeab8ab278866f7adf13316651425ac8385d
--- /dev/null
+++ b/wikipedia_to_hdoc/xslt/get-ressources-with-meta.xsl
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+
+
+ ${hdocResultPath}/ressources
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ${hdocResultPath}/ressources/
+ ${hdocResultPath}/ressources//
+
+ ${hdocResultPath}/ressources//meta.xml
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/wikipedia_to_hdoc/xslt/official-meta.xml b/wikipedia_to_hdoc/xslt/official-meta.xml
new file mode 100644
index 0000000000000000000000000000000000000000..0fe592258771cf06805539bf9b58ecc016036a35
--- /dev/null
+++ b/wikipedia_to_hdoc/xslt/official-meta.xml
@@ -0,0 +1,21 @@
+
+
+
+ Principal title
+
+
+ zero
+ 2.5
+
+
+
+ info
+ remplacement text
+
+
+ Complete description
+
+
+
+
+
\ No newline at end of file
diff --git a/wikipedia_to_opale/README.md b/wikipedia_to_opale/README.md
index 6a245117a4a1d9703875fe5a468876c898d8ba39..3a8958751de9f411d1e3fc6b0be72e43ae5833e8 100644
--- a/wikipedia_to_opale/README.md
+++ b/wikipedia_to_opale/README.md
@@ -1,7 +1,37 @@
-Getting started
+Converter : Wikipedia To Opale
+==============================
+
+Licence :
+---------------
+GPL 3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+
+Credits :
---------------
+Carrel Billiard Harold
+
+Harriga Merouane
+
+Lhomme Nicolas
+
+Previous developers
+
+
+Presentation
+------------
+
+Wikipedia to Opale is a converter that tronsform wikipedia pagaes to opale.
+
-Use a terminal and go to the root of the folder (Wikipedia_to_opale).
+Dependece
+---------
+- Wikipedia To Hdoc Converter
+- Hdoc to Opale Converter
+
+
+User Documentation
+------------------
Generating .hdoc of a Wikipedia article with an URL
---------------------------------------------------
@@ -42,4 +72,24 @@ Generating .hdoc of a Wikipedia article with a local file
BUG
---
-1 - Linux sh files doesn't work with UTC proxy but works outside UTC
\ No newline at end of file
+1 - Linux sh files doesn't work with UTC proxy but works outside UTC
+
+Unsupported
+-----------
+
+1 Images:
+ - images inside text are not supported because of schema validation.
+
+Known Bugs
+----------
+
+To do
+-----
+
+
+Technical notes
+---------------
+
+
+Capitalisation
+--------------