README.md~ 1.99 KB
Newer Older
1 2 3
README.md
# Converter lexique_to_hdoc

edepuiff's avatar
edepuiff committed
4
#License GPL.3.0
5 6
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
In order to use this converter, follow those steps :
Antoine's avatar
Antoine committed
14 15 16 17
1. Create a dictionnary "dictionnaire.xml" which referenciate every definition you want to put in your hdoc. This dictionnary must respect the "dictionnaire.rng" schema
2. Copy the referenciated definitions in the same folder than the dictionnary (input)
3. Your input folder must contain the dictionnary (dictionnaire.xml) and the lexique definitions (**.term).
4.  Execute the run that corresponds to your OS. (run.sh for Linux, run.bat for Windows) 
edepuiff's avatar
edepuiff committed
18
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
User documentation
Antoine's avatar
Antoine committed
25 26
You will find a "help" directory that contains: 
- A sample of dictionnary that you need to write and call "dictionnaire.xml".
27 28
- 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.
Antoine's avatar
Antoine committed
29
If you want to create more definitions with images and tables, you will need to put this ressources in the folder named "&". It contains all the ressources which are copy-pasted in the output folder so they can e seen in the hdoc.
30

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

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

edepuiff's avatar
edepuiff committed
37
#TODO
Antoine's avatar
Antoine committed
38
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 to match the ressources in every definitions, and to call an Ant which automatically copy the ressources needed in this folder.
39
Create a transformation which allows every audio resources to be seen in the hdoc.
edepuiff's avatar
edepuiff committed
40
create the Ant transformation which copies the sources folder so that the source link is not empty.
41

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

edepuiff's avatar
edepuiff committed
45
#Capitalisation