README.md~ 1.88 KB
Newer Older
1 2 3 4 5 6
README.md
# Converter lexique_to_hdoc

License GPL.3.0
http://www.gnu.org/licenses/gpl-3.0.txt

edepuiff's avatar
edepuiff committed
7
#Crédits
8 9 10 11
Estelle de Magondeaux
Antoine Aufrechter
Marouane Hammi

edepuiff's avatar
edepuiff committed
12
#Install
13 14 15
In order to use this converter, follow those steps :
1. Create a dictionnary "dictionnaire.xml" which referenciate every definition you want to put ini your hdoc. This dictionnary must respect the "dictionnaire.rng" schema
2. Copy the referenciated definitions in the same current path as the dictionnary (input)
edepuiff's avatar
edepuiff committed
16 17 18
3. Your input folder must contains the dictionnary (dictionnaire.xml) and the lexique definition (**.term).
4.  Execute the run that correspond to your OS. (run.sh for linux, run.bat for ubuntu) 
5.  You will find the result into the output directory: it is named "content.xml".
19

edepuiff's avatar
edepuiff committed
20 21
#Dependances
none.
22

edepuiff's avatar
edepuiff committed
23
#User documentation
24 25 26 27
You will find a "help" directory taht contains: 
- A saple of dictionnary that you neef to write and call "dictionnaire.xml".
- the lexique definition that you can choose to put into your hdoc (help/available_definition folder).
The generated folder is a .xml . If you desire to see the output in you browser, you need to rename it as a .html.
edepuiff's avatar
edepuiff committed
28
If you want to create more definitions with images and tables, you will need to put this ressources in the folder naed "&". It contains all the ressources which are copy-pasted in the output folder so they can de seen in the hdoc.
29

edepuiff's avatar
edepuiff committed
30
#Unsupported
31 32
Audio and video transformation

edepuiff's avatar
edepuiff committed
33 34
#Known bugs
none
35

edepuiff's avatar
edepuiff committed
36
#TODO
37 38 39
create a better transformation for the ressources. At the moment the user needs to copy the ressources in a folder named "&". The best would be tomatch the ressources in every definitions, and to call an aNT which automatically copy the ressources needed in this folder.
Create a transformation which allows every audio resources to be seen in the hdoc.

edepuiff's avatar
edepuiff committed
40
#Technical notes
41 42
If folders names are changed, you will need to change the tasks of the ANT file.

edepuiff's avatar
edepuiff committed
43
#Capitalisation