@@ -358,11 +373,9 @@
-
+
-
-
@@ -387,6 +400,14 @@
+
+
+
+
+
+
+
+
diff --git a/opale_to_lexique/README.md b/opale_to_lexique/README.md
index fa858bd6cb0c9dbd8488fd7bce247b14e400f251..1211c5c9c5362223ed2297cad59e6cb9d1208625 100644
--- a/opale_to_lexique/README.md
+++ b/opale_to_lexique/README.md
@@ -1,6 +1,17 @@
# Converter opale_to_lexique
+License GPL3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+##Crédits
+Florian Arend, Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi
+
+##Install
In order to use this converter, follow those steps :
1. Copy your Opale file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS.
3. You will find the result into the output directory.The name of the output files depends of the hour it was processed.
+
+##User documentation
+Because the Opale definitions are much less structured that Lexique definitions, only the text content of the definition will be fill out in the Lexique definition. Be free to add other information or organize differently the resulting text.
+
diff --git a/opale_to_lexique/samples/buc1-Buckland-WhatIsA(Digital)Document_2015-12-13.scar b/opale_to_lexique/samples/buc1-Buckland-WhatIsA(Digital)Document_2015-12-13.scar
deleted file mode 100644
index d3392e33c9ebf669073f668afeb188f93faf3536..0000000000000000000000000000000000000000
Binary files a/opale_to_lexique/samples/buc1-Buckland-WhatIsA(Digital)Document_2015-12-13.scar and /dev/null differ
diff --git a/opale_to_optim/README.txt b/opale_to_optim/README.txt
index 6cda21a5a9b26bd74bced4501d291da4fbad3ede..ed9c0d108c9b3dd7deb4dc6c3a9bc00e14b43ea4 100644
--- a/opale_to_optim/README.txt
+++ b/opale_to_optim/README.txt
@@ -1,4 +1,17 @@
-Pour réaliser votre conversion vous devez ajouter votre fichier .scar dans le dossier input.
-Veillez à n'en placer qu'un seul dedans.
-Ensuite il suffit d'appeler le script (.bat ou .sh).
-!!Attention!! Ce script efface tous les input et output préalablement contenus dans les deux conversions.
\ No newline at end of file
+Ce convertisseur permet de convertir des fichiers du format Opale (.scar) en contenus Optim de type papier (.paper) ou diaporama (.slideshow)
+
+Il y a deux façons de réaliser votre conversion:
+
+
+- Lancer le script run. Dans ce cas vous devez ajouter votre fichier .scar dans le dossier input. Veillez à ne placer qu'un seul fichier dans ce dossier. Le format par défaut utilisé pour le fichier cible est le type papier.
+
+
+- En ligne de commande:
+
+ant -buildfile opale_to_optim.ant
+
+Vous pouvez spécifier le fichier input, avec le paramètre -DSource, et le format de sortie avec le paramètre -DDocType (paper ou slideshow). Les deux paramètres sont optionnels.
+
+Exemple:
+
+ant -buildfile opale_to_optim.ant -DDocType slideshow -DSource sample.scar
\ No newline at end of file
diff --git a/opale_to_optim/opale_to_optim.ant b/opale_to_optim/opale_to_optim.ant
index 042487abbd65ecea77486c8ec726886eecaa27af..3c01323cdf7dd564e2ab04a9e3d9a060ff7ce801 100644
--- a/opale_to_optim/opale_to_optim.ant
+++ b/opale_to_optim/opale_to_optim.ant
@@ -1,5 +1,16 @@
+
+
+
+
+
+
+
+
+
+
+
@@ -16,13 +27,43 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
diff --git a/optim_to_hdoc/README b/optim_to_hdoc/README.MD
similarity index 93%
rename from optim_to_hdoc/README
rename to optim_to_hdoc/README.MD
index ba8a5ec20bc7b3c3477f999c5d0e6929ca3b9a31..ac5d72cfdad69a1795653ab566a1eaa21471977d 100644
--- a/optim_to_hdoc/README
+++ b/optim_to_hdoc/README.MD
@@ -1,27 +1,43 @@
-Usage
------
+Optim to Hdoc
+=============
-Put `.scar` files in the input folder, run `run.bat` or `run.sh` and get results in output folder (one folder and a .hdoc per .scar).
+Licence
+-------
+This project is under [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt).
-Todo list
----------
-- tests more files
-- clean output of optim source files
-- resolve bugs
-- test the entier process from optim to opale
-- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project.
+Credits
+-------
-Bugs
-----
+Ivan D'halluin, Sylvain Lagache, Frédéric Le Feurmou.
+
+
+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
+----------
- references of sections or fragments inside a paragraphe
- can create divs with only h6
-Transformation
---------------
+Todo
+----
+
+- tests more files
+- clean output of optim source files
+- resolve bugs
+- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project.
+
+
+Technicals notes
+----------------
| Optim start tag (or structures) | HDOC end tag | Note |
|---------------------------------|-------------------------------------|---------------------------------------------|
@@ -79,4 +95,5 @@ Transformation
| tree | | The structure of trees cannot be converted |
| | | and the result is a list a blocks |
|---------------------------------|-------------------------------------|---------------------------------------------|
-| title | | |
\ No newline at end of file
+| title | | |
+
diff --git a/optim_to_lexique/README.md b/optim_to_lexique/README.md
index 8c0819dabb5e9d880de63f093e6a9f20683835c9..20bc5a343ece63ed22651f00da9e04c2de065b16 100644
--- a/optim_to_lexique/README.md
+++ b/optim_to_lexique/README.md
@@ -1,6 +1,30 @@
# Converter optim_to_lexique
+Converter optim_to_lexique
+License GPL3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+Crédits
+Florian Arend
+Estelle de Magondeaux
+Marouane Hammi
+Antoine Aufrechter
+
+Install
In order to use this converter, follow those steps :
-1. Copy your Optim files (.scar or .zip) into the input directory.
+1. Copy your Optim file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed.
+
+Dependance
+
+User documentation
+
+Unsupported
+
+Known bugs
+
+TODO
+
+Capitalisation
+
diff --git a/optim_to_lexique/samples/nf29a012optim_2015-12-13.scar b/optim_to_lexique/samples/nf29a012optim_2015-12-13.scar
deleted file mode 100644
index 8330b155ccd377c4bdc6f391c8c4a858081dbb2e..0000000000000000000000000000000000000000
Binary files a/optim_to_lexique/samples/nf29a012optim_2015-12-13.scar and /dev/null differ
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/optim_to_opale.ant b/optim_to_opale/optim_to_opale.ant
index c2b365b0445fcb16e0d01aff624bbfdb8b29329f..d66f9332e45ed1aac29a25ce06c88ec06a3940ab 100644
--- a/optim_to_opale/optim_to_opale.ant
+++ b/optim_to_opale/optim_to_opale.ant
@@ -198,6 +198,11 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/optim_to_opale/readme.md b/optim_to_opale/readme.md
index 39d5179e790db77968c6ede8ce8a83ac0d855ee7..00c34d6170251fd756c32e2ecc229f32f33e8c71 100644
--- a/optim_to_opale/readme.md
+++ b/optim_to_opale/readme.md
@@ -1,34 +1,78 @@
-Optim to Opale (optim_to_opale)
--------------------------------
+Optim to Opale (`optim_to_opale`)
+===============================
+Last edit: January 4, 2016
-Last edit: December 17, 2015
+License
+-------
+This project is under [GPL 3.0 license](http://www.gnu.org/licenses/gpl-3.0.txt).
-# Purpose
+Credits
+-------
+### Autumn 2015
-`optim_to_opale` is an ANT script to convert a file from Optim format to Opale format.
+* Ivan D'HALLUIN
+* Jeffrey DECORDE
+* Jean-Baptiste MARTIN
-# Dependencies
+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.
+Dependencies
+------------
In order to work properly this script needs
-1. `optim_to_hdoc` (Optim to HDoc conversion)
-2. `hdoc_to_opale` (HDoc to Opale conversion)
+1. [`optim_to_hdoc`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/optim_to_hdoc) (Optim to HDoc conversion)
+2. [`hdoc_to_opale`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_opale) (HDoc to Opale conversion)
-# Running the script
+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
+### 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
+-----------
+
+### 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
+----------
+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 27da2df2448e9a873e361e3608af6d5bad321e29..329ce105e252ca1ca866d0353a095143631b5468 100644
--- a/wikipedia_to_hdoc/README.md
+++ b/wikipedia_to_hdoc/README.md
@@ -1,4 +1,27 @@
-Getting started
+Converter : Wikipedia_to_Hdoc
+===============
+
+Licence :
+---------------
+GPL 3.0
+http://www.gnu.org/licenses/gpl-3.0.txt
+
+
+Credits :
+---------------
+Carrel Billiard Harold
+
+Harriga Merouane
+
+Lhomme Nicolas
+
+Previous developers
+
+Presentation
+---------------
+This converter transforms a wkipedia page (from a link or a saved page) to a Hdoc document.
+
+User Documentation
---------------
Use a terminal and go to the root of the folder (Wikipedia_to_hdoc).
@@ -45,13 +68,30 @@ To do
Concerning images :
1 - Extract the metadata information from the meta.xml file for each image. You can do that by creating an XSL file that will be called from the ant task generated by xslt/get_ressources_urls.xsl. In that file you have the hand on each meta.xml File.
+
2 - Verify that images are well zipped to avoid any problem while testing in Opale
+
3 - Images inside paragraphs break the validation of the hdoc schema, do a preposition to change the schema and handle that.
+
Concerning listings :
1 - Succeed in finding the language of the part of code of the wikipedia article
+
+Concerning tables :
+
+1 - Solve the encoding problem,
+
+2 - Change Hdoc Scheme in order to accept images in 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 )
@@ -59,4 +99,11 @@ Be aware of the following things
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 of UTC.
+
+2 - Random errors might occur
+Wikipedia is a great tool : everyone can participe. However, it does not provide contributors with best practices that everyone follows. The result is a lot of different ways to write articles. This is why this converter might not handle some situations (even if all files I have tried worked), and it might not be able to output some Wikipedia articles at its current state.
+
+3 - Small issues with Opale
+Links can be invisible if you use an old version of Opale. This is not a problem coming from the Wikipedia to Hdoc converter. Make sure you use an updated version of Opale to test your scar archives.
+Another thing is that Opale might indicate that the scar file contains errors once imported. Actually, these "errors" are warnings. The archives work, as they were validated when making the scar file. These warnings come from Opale, but you can ignore them.
\ No newline at end of file
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
+--------------