Commit de68c417 authored by Antoine's avatar Antoine

README changed

parent 32eb6299
...@@ -11,21 +11,21 @@ Marouane Hammi ...@@ -11,21 +11,21 @@ Marouane Hammi
Install Install
In order to use this converter, follow those steps : 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 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 current path as the dictionnary (input) 2. Copy the referenciated definitions in the same folder than the dictionnary (input)
3. Your input folder must contains the dictionnary (dictionnaire.xml) and the lexique definition (**.term). 3. Your input folder must contain the dictionnary (dictionnaire.xml) and the lexique definitions (**.term).
4. Execute the run that correspond to your OS. (run.sh for linux, run.bat for ubuntu) 4. Execute the run that corresponds to your OS. (run.sh for Linux, run.bat for Windows)
5. You will find the result into the output directory: it is named "content.xml". 5. You will find the result into the output directory: it is named "content.xml".
Dependances Dependances
none. none.
User documentation User documentation
You will find a "help" directory taht contains: You will find a "help" directory that contains:
- A saple of dictionnary that you neef to write and call "dictionnaire.xml". - A sample of dictionnary that you need to write and call "dictionnaire.xml".
- the lexique definition that you can choose to put into your hdoc (help/available_definition folder). - 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. The generated folder is a .xml . If you desire to see the output in you browser, you need to rename it as a .html.
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. 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.
Unsupported Unsupported
Audio and video transformation Audio and video transformation
...@@ -34,11 +34,11 @@ Known bugs ...@@ -34,11 +34,11 @@ Known bugs
TODO TODO
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 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.
Create a transformation which allows every audio resources to be seen in the hdoc. Create a transformation which allows every audio resources to be seen in the hdoc.
Technical notes Technical notes
If folders names are changed, you will need to change the tasks of the ANT file. If folders' names are changed, you will need to change the tasks of the ANT file.
Capitalisation Capitalisation
......
...@@ -11,21 +11,21 @@ Marouane Hammi ...@@ -11,21 +11,21 @@ Marouane Hammi
Install Install
In order to use this converter, follow those steps : 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 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 current path as the dictionnary (input) 2. Copy the referenciated definitions in the same folder than the dictionnary (input)
3. Copy your ressources in a folder named "&", placed in the same current path as the dictionnary (input) 3. Your input folder must contain the dictionnary (dictionnaire.xml) and the lexique definitions (**.term).
4. Your input folder must contains the dictionnary (dictionnaire.xml), the lexique definition (**.term), and the ressources folder(&). 4. Execute the run that corresponds to your OS. (run.sh for Linux, run.bat for Windows)
5. 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".
3. You will find the result into the output directory.
Dependance Dependances
none.
User documentation User documentation
You will find a "help" directory taht contains: You will find a "help" directory that contains:
- A saple of dictionnary that you neef to write and call "dictionnaire.xml". - A sample of dictionnary that you need to write and call "dictionnaire.xml".
- the lexique definition that you can choose to put into your hdoc (help/available_definition folder). - the lexique definition that you can choose to put into your hdoc (help/available_definition folder).
- a sample of the "&" folder that you need to copy in the input directory. At the moment the only 2 resources referenciated in all the definitions are there, so you can simply copy-paste this directory to the input directory.
The generated folder is a .xml . If you desire to see the output in you browser, you need to rename it as a .html. The generated folder is a .xml . If you desire to see the output in you browser, you need to rename it as a .html.
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.
Unsupported Unsupported
Audio and video transformation Audio and video transformation
...@@ -34,11 +34,12 @@ Known bugs ...@@ -34,11 +34,12 @@ Known bugs
TODO TODO
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 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.
Create a transformation which allows every audio resources to be seen in the hdoc. Create a transformation which allows every audio resources to be seen in the hdoc.
Technical notes Technical notes
If folders names are changed, you will need to change the tasks of the ANT file. If folders' names are changed, you will need to change the tasks of the ANT file.
Capitalisation Capitalisation
...@@ -15,7 +15,7 @@ Install ...@@ -15,7 +15,7 @@ Install
In order to use this converter, follow those steps : In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory. 1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS. 2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed. 3. You will find the result into the output directory. The name of the output files depends on the hour it was processed.
Dependance Dependance
......
...@@ -14,7 +14,7 @@ Install ...@@ -14,7 +14,7 @@ Install
In order to use this converter, follow those steps : In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory. 1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS. 2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed. 3. You will find the result into the output directory. The name of the output files depends on the hour it was processed.
Dependance Dependance
......
...@@ -12,7 +12,7 @@ Install ...@@ -12,7 +12,7 @@ Install
In order to use this converter, follow those steps : In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory. 1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS. 2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed. 3. You will find the result into the output directory. The name of the output files depends on the hour it was processed.
Dependance Dependance
......
...@@ -10,7 +10,7 @@ Florian Arend, Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi ...@@ -10,7 +10,7 @@ Florian Arend, Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi
In order to use this converter, follow those steps : In order to use this converter, follow those steps :
1. Copy your Opale file(s) (.scar or .zip) into the input directory. 1. Copy your Opale file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS. 2. Execute the run that correspond to your OS.
3. You will find the result into the output directory.The name of the output files depends of the hour it was processed. 3. You will find the result into the output directory.The name of the output files depends on the hour it was processed.
##User documentation ##User documentation
Because the Opale definitions are much less structured that Lexique definitions, only the text content of the definition will be fill out in the Lexique definition. Be free to add other information or organize differently the resulting text. Because the Opale definitions are much less structured that Lexique definitions, only the text content of the definition will be fill out in the Lexique definition. Be free to add other information or organize differently the resulting text.
......
...@@ -14,7 +14,7 @@ Install ...@@ -14,7 +14,7 @@ Install
In order to use this converter, follow those steps : In order to use this converter, follow those steps :
1. Copy your Optim file(s) (.scar or .zip) into the input directory. 1. Copy your Optim file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS. 2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed. 3. You will find the result into the output directory. The name of the output files depends on the hour it was processed.
Dependance Dependance
......
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