README.md 1.25 KB
Newer Older
Antoine's avatar
Antoine committed
1 2
# Converter hdoc_to_lexique

Mar60's avatar
Mar60 committed
3 4 5
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt

Mar60's avatar
Mar60 committed
6
## Crédits
Mar60's avatar
Mar60 committed
7 8
Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi 

Mar60's avatar
Mar60 committed
9
## Install
Antoine's avatar
Antoine committed
10
In order to use this converter, follow those steps :
11
1. Copy your hdoc file (.scar or .zip) into the input directory. Do not put more than one file into the input directory.
Antoine's avatar
Antoine committed
12
2. Execute the run that correspond to your OS.
Mar60's avatar
Mar60 committed
13 14
3. You will find the result into the output directory.

Mar60's avatar
Mar60 committed
15
## User documentation
16
For each definition in the content.xml a .term is generated and for each source that is referenced in a definition the image associated (with its meta and props files) is copied into the output file with the definition.
Mar60's avatar
Mar60 committed
17

Mar60's avatar
Mar60 committed
18
## Known bugs
Mar60's avatar
Mar60 committed
19 20
>- Cannot put multiple input files

Mar60's avatar
Mar60 committed
21
## TODO
22
>- Change the name of the file (.term) to have a name without special character
Mar60's avatar
Mar60 committed
23 24 25 26 27 28 29 30
>- Manage multiple input files (e.g. see lexique_to_opale) 
>- list of element to convert :
>>- src url
>>- image
>>- pronounciation
>>- type (female, male,...) and (abbreviation, expanded,...)
>>- array
>>- multimedia
31
>-Do not generate the content.term or use it to generate an index instead (currently content.term is generated but useless)
Mar60's avatar
Mar60 committed
32

Mar60's avatar
Mar60 committed
33
## Technical notes
Mar60's avatar
Mar60 committed
34 35
>- The converter have to respect the same schema as the lexique_to_hdoc converter for the xslt