Commit ffad1c99 authored by Jean Vintache's avatar Jean Vintache

Merge branch 'master' of gitlab.utc.fr:crozatst/hdoc

parents 200a4aaf d5e91783
# Converter hdoc_to_lexique
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
##Crédits
Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi
##Install
In order to use this converter, follow those steps :
1. Copy your hdoc file (.scar or .zip) into the input directory. Do not put more than one file into the input directory.
2. Execute the run that correspond to your OS.
3. You will find the result into the output directory.
\ No newline at end of file
3. You will find the result into the output directory.
##User documentation
##Known bugs
>- Cannot put multiple input files
##TODO
>- Change the name of the file (.term) to the definition associated
>- 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
##Technical notes
>- The converter have to respect the same schema as the lexique_to_hdoc converter for the xslt
##Capitalisation
Ce convertisseur permet de convertir des fichiers du format Hdoc (.hdoc) en contenus Optim de type papier (.paper) ou diaporama (.slideshow)
Il y a deux façons de réaliser votre conversion:
- Lancer le script run. Dans ce cas vous devez ajouter votre fichier .hdoc dans le dossier input. Veillez à ne placer qu'un seul fichier dans ce dossier. Le format par défaut utilisé pour le fichier cible est le type papier.
- En ligne de commande:
ant -buildfile hdoc_to_optim.ant
Vous pouvez spécifier le fichier input, avec le paramètre -DInputFile, et le format de sortie avec le paramètre -DDocType (paper ou slideshow). Les deux paramètres sont optionnels.
Exemple:
ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc
\ No newline at end of file
Converter hdoc_to_optim
-----------------------
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a html file that complies the hdoc schema.
License GPL3.0
--------------
http://www.gnu.org/licenses/gpl-3.0.txt
Credits
-------
Rihab HACHEM, Perrine RAVAUD (2014).
Dependance
----------
No dependance needed.
User documentation
------------------
There are two different ways to use the converter hdoc_to_optim: by running a script run.bat/run.sh or by command line using a terminal.
--- Running the script run.bat/run.sh:
Use this method if you do not want to use a terminal. D1. Download hdoc_converter.zip and unzip it.2. Add your source file to the Input folder.
3. Place only one file in that folder.
4. If you are using Linux, run the script run.sh. If you are using Windows, run the script run.bat.
5. Your file has been converted, the result is in the Output folder.
6. You can now open it with OptimOffice.
The default output document type used by this script is an Optim paper.
--- Terminal:
By using the terminal you can specify some parameters to the conversion : the source file, or the output type (either a paper or a slideshow).
1. Download hdoc_converter.zip and unzip it.
2. Open your terminal and go into the folder hdoc_to_optim.
3. Run the following command:
"ant -buildfile hdoc_to_optim.ant"
You can specify the source file, and the output document type by adding parameters to that command.
Use -DInputFile to specify the source file.
Use -DDocType to specify if it's a paper or a slideshow.
Exemple :"ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc"
Both parameters are optional.Your file has been converted, you can open your paper with OptimOffice.
Unsupported
-----------
- In paper and slideshow :
Inline : Superscript, Subscript
SpanType : Latex , Syntax- In slideshow :
Metadata : Description, Keywords
Known bugs
----------
No known bugs now.
Todo
----
- Offer the possibility of creating a website, or a webmedia document.
- For the slideshow, find a way to transform the metadata information (description, keywords) into something similar.- Integrate Concept trees.
Technical notes
---------------
The converter contains 5 files:
- hdoc_to_optim.ant :
When you launch the Converter (whether through the script or a terminal) it's the file hdoc_to_optim.ant that is launched, and executes the following files.
- find_content.xsl :
This XSLT program runs through the hdoc file container.xml to retrieve the path of the file to convert and creates a ANT script get_content.ant.
- find_ressources.xsl :
This XSLT program runs through the content file of hdoc to retrieve the path of each audio files, images and objects used in it and creates a ANT script get_ressources.ant.
- transfo.xsl (paper) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a paper.
- transfo2.xsl (slideshow) :
This XSLT program runs through the content file of hdoc and convert each hdoc tag in Optim tags if possible. It converts it to a slideshow.
- .wspmeta :
This file contains Optim metadata informations, it must be placed in the result of the conversion
Capitalisation
--------------
Thanks to this project I deepened my knowledge in XSLT, ANT, RelaxNG Schema, and HTML.
I learned how to use OptimOffice.
......
# Converter lexique_to_opale
Converter lexique_to_opale
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Crédits
Florian Arend
Estelle de Magondeaux
Marouane Hammi
Antoine Aufrechter
Install
In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The names of the output are linked to the hour it was processed.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed.
Dependance
User documentation
Unsupported
Type of term
Equivalent term
Pronunciation
In the definition(s)
Text content
Links to other terms
Spreadsheets
Images (informative and decorative)
Animations
Inline images
Known bugs
TODO
Work to handle the above unsupported items.
capitalisation
# Converter lexique_to_optim
Converter lexique_to_optim
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Crédits
Florian Arend
Estelle de Magondeaux
Marouane Hammi
Antoine Aufrechter
Install
In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
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.
Dependance
User documentation
Unsupported
Type of term
Equivalent term
Pronunciation
In the definition(s)
Text content
Links to other terms
Spreadsheets
Images (informative and decorative)
Animations
Known bugs
TODO
Work on the support of unsupported elements above.
Capitalisation
# Converter lexique_to_opale
Converter lexique_to_rdf
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Crédits
Estelle de Magondeaux
Marouane Hammi
Antoine Aufrechter
Install
In order to use this converter, follow those steps :
1. Copy your Lexique file(s) (.scar or .zip) into the input directory.
2. Execute the run that correspond to your OS.
3. You will find the result into the output directory. The names of the output are linked to the hour it was processed.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed.
Dependance
User documentation
Unsupported
Known bugs
TODO
An onthology has to be created to fit the needs of this conversion.
A file which includes all the .rdf between rdf:RDF tag has to be created.
AVterm have to be handled
Capitalisation
RDF files are interesting because they can be used to create maps of datas. Here are any links to intersting applications using RDF.
http://www.visualdataweb.org/relfinder/relfinder.php
http://simile.mit.edu/welkin/
# Converter opale_to_lexique
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
##Crédits
Florian Arend, Antoine Aufrechter, Estelle de Magondeaux, Marouane Hammi
##Install
In order to use this converter, follow those steps :
1. Copy your Opale file(s) (.scar or .zip) into the input directory.
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.
##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.
# Converter optim_to_lexique
Converter optim_to_lexique
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Crédits
Florian Arend
Estelle de Magondeaux
Marouane Hammi
Antoine Aufrechter
Install
In order to use this converter, follow those steps :
1. Copy your Optim files (.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.
3. You will find the result into the output directory. The name of the output files depends of the hour it was processed.
Dependance
User documentation
Unsupported
Known bugs
TODO
Capitalisation
......@@ -4,7 +4,7 @@ Last edit: January 4, 2016
License
-------
This project is under [GPL 3.0 licence](http://www.gnu.org/licenses/gpl-3.0.txt).
This project is under [GPL 3.0 license](http://www.gnu.org/licenses/gpl-3.0.txt).
Credits
-------
......
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