Commit 6484f136 authored by Etienne Chognard's avatar Etienne Chognard
Browse files

Update Readme

parent 3752b98d
...@@ -16,7 +16,7 @@ http://www.gnu.org/licenses/gpl-3.0.txt ...@@ -16,7 +16,7 @@ http://www.gnu.org/licenses/gpl-3.0.txt
- Fecherolle Cécile - Fecherolle Cécile
## Presentation ## Presentation
This module is able to convert several [etherpad](http://etherpad.org/) files (exported as html files) to the hdoc format. This module is able to convert several [framad](https://framapad.org/) files (exported as html files) to the hdoc format.
## User documentation ## User documentation
...@@ -24,8 +24,8 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e ...@@ -24,8 +24,8 @@ This module is able to convert several [etherpad](http://etherpad.org/) files (e
Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avoir travaillé sur votre pad, vous souhaitez transformer ce document en un autre format que vous pourrez utiliser dans un nouveau contexte de travail. Pour ce faire, vous exportez le framapad au format HTML grâce au bouton « Import/Export ». Vous récupérez ensuite les fichiers nécessaires à la transformation framapad to hdoc sur le répertoire git du projet hdoc (voir http://hdoc.crzt.fr/). Il ne vous reste alors plus qu'à placer le fichier html précédemment récupéré dans le dossier « input » du dossier framapad_to_hdoc et à exécuter le /run.bat si vous êtes sur Windows ou le /run.sh si vous êtes sur Linux/Mac. Cela produira une archive .hdoc dont l'intérêt est de servir de format de passage pour une transformation d'un format à un autre, et ce pour une grande variété de format. Il vous restera ensuite à déterminer le nouveau format dans lequel vous voulez transformer votre hdoc et utiliser le convertisseur approprié s'il existe. Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avoir travaillé sur votre pad, vous souhaitez transformer ce document en un autre format que vous pourrez utiliser dans un nouveau contexte de travail. Pour ce faire, vous exportez le framapad au format HTML grâce au bouton « Import/Export ». Vous récupérez ensuite les fichiers nécessaires à la transformation framapad to hdoc sur le répertoire git du projet hdoc (voir http://hdoc.crzt.fr/). Il ne vous reste alors plus qu'à placer le fichier html précédemment récupéré dans le dossier « input » du dossier framapad_to_hdoc et à exécuter le /run.bat si vous êtes sur Windows ou le /run.sh si vous êtes sur Linux/Mac. Cela produira une archive .hdoc dont l'intérêt est de servir de format de passage pour une transformation d'un format à un autre, et ce pour une grande variété de format. Il vous restera ensuite à déterminer le nouveau format dans lequel vous voulez transformer votre hdoc et utiliser le convertisseur approprié s'il existe.
## Running etherpad_to_hdoc.ant ## Running framapad_to_hdoc.ant
1. Create an etherpad document and export it as an html file. 1. Create a framapad document and export it as an html file.
2. please place your html files in the `/input` folder 2. please place your html files in the `/input` folder
3. run the `run.[bat|sh]` script of your choice depending on your OS 3. run the `run.[bat|sh]` script of your choice depending on your OS
4. and retrieve the hdoc outputs in the `/output` folder 4. and retrieve the hdoc outputs in the `/output` folder
......
# Etherpad2Opale -- HDOC CONVERTER PROJECT # framapad2opale -- HDOC CONVERTER PROJECT
## License ## License
[GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt) [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt)
## Credits ## Credits
- Boucaud Fabien
- Chognard Etienne
- Rit Gabrielle - Rit Gabrielle
- Vintache Jean - Vintache Jean
- Douteau Jean-Come - Douteau Jean-Come
- Fecherolle Cecile (2014) - Fecherolle Cecile (2014)
## Presentation ## Presentation
How to transform an etherpad document in opale document. How to transform an framapad document in opale document.
Filepaths in this document are relative to this readme file. Filepaths in this document are relative to this readme file.
## Dependence ## Dependence
- Etherpad2Hdoc - framapad2Hdoc
- Hdoc2Opale - Hdoc2Opale
## User Documentation ## User Documentation
1. Download an etherpad document in html format. 1. Download a framapad 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). 1. Create or join a framapad 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` 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. *If the `/input` directory contains multiple files, they will be all treated.
3. Open the document with Opale 3. Open the document with Opale
1. Open Scenari, and choose "UTC-etu_opale" as distant depot. 1. Open Scenari, and choose "UTC-etu_opale" as distant depot.
2. Go in the directory `sandBox/etherpad-to-opale.` 2. Go in the sandbox.
3. Import your `.scar` file in the directory. 3. Import your `.scar` file in the directory.
4. Open the file Main.xml created. 4. Open the file Main.xml created.
...@@ -52,7 +54,7 @@ Here's an example : ...@@ -52,7 +54,7 @@ Here's an example :
- Correct nested lists - Correct nested lists
## Technical notes ## Technical notes
### Description of etherpad_to_hdoc.ant ### Description of framapad_to_hdoc.ant
#### Prelude #### Prelude
- Importation of necessary classes (antlib, htmlcleaner, jing) - Importation of necessary classes (antlib, htmlcleaner, jing)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment