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 : +`