Commit d96c3960 authored by Hachem Rihab's avatar Hachem Rihab

[opale_to_optim] update README.md

parent 71781931
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 hdoc_to_optim
-----------------------
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a HTML file that respects 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 (allows the user to specify some parameters like the document type).
#### Running the script run.bat/run.sh:
Use this method if you do not want to use a terminal.
1. 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.
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
--------------
N/A
Converter opale_to_hdoc
-----------------------
The purpose of this converter is to obtain an HDOC file from an Opale document.
License GPL3.0
--------------
http://www.gnu.org/licenses/gpl-3.0.txt
Credits
-------
* Thibault Drain
* Christophe Virot
* Pierre Lemaire
Dependance
----------
This project can be used alone if you only want to convert an Opale .scar into an HDOC file.
User documentation
------------------
You have to respect the following steps :
1. First, if you want to transform your Opale publication to a Hdoc format,
you have to export a module file as a scar.
Extract a module file from your Opale workspace. You can't export directly a web, paper or slide show support. You must extract a scar module. Moreover, when you extract a module, keep the default configuration :
* "Include descendant network" input : checked
* "keep workspaces" : unchecked
2. Then you just have to put your scar in the input directory inside the project opale_to_hdoc.
3. Finally, you can either launch the bash, the bat or start the ant by
typing the following instruction :
ant -buildfile opale_to_hdoc
Unsupported
-----------
* Module
* Titre court
* Références générales
* Activité d'auto évaluation
* Exercice rédactionnel
* Exercice QCM
* Exercice QCM graphique
* Exercice QCU
* Exercice QCU graphique
* Exercice catégorisation
* Exercice ordonnancement
* Exercice texte à trous
* Exercice question à réponse courte
* Liste d'exercice
* Activité d'apprentissage
* Titre court
* Exercice rédactionnel
* Exercice QCU
* Exercice QCU graphique
* Exercice QCM
* Exercice QCM graphique
* Exercice catégorisation
* Exercice ordonnancement
* Exercice texte à trous
* Exercice question à réponse courte
* Liste d'exercice
* Grain de contenu
* Titre court
* Blocs
* All bloc types are supported
* Types de texte
* Ressources (ressources de type animation non supporté)
* Fichier en téléchargement
* Éléments présents dans un texte
* Formule mathématique
* Abréviation
* Glossaire
* Références
* Lien vers un document
* Renvoi vers une ressource
* Renvoi vers un grain de contenu
* Animation
Known bugs
----------
All the ressources are not managed yet. Thus, sometimes the markup sp:res is not visited by the program and it ends up with blank divs inside the result.hdoc which prevents it from being valid. Moreover, we're not 100% sure that there always will be a markup sp:index to define the type of the ressource. However, now the index is used to determine wether the target hdoc markup has to be a img or object (video, audio remain in development).
Todo
----
* Listings are simply put inside p markups and should be externalized as pictures (ressources) in order to maintain the indent.
* Externalized opale UC and UA files are full of relative path that point multiple kinds of references. Our ant program begins by merging all these files into the root opale file. Thus the relative paths become wrong. Next group could look at what has been done with ressources (sp:res) in order to handle references the same way.
* Presently, you cannot select one scar file inside the input repository. It could be useful to define an InputPath parameter that would either have the value of the only file set in input or would have the value of a submissed relative path.
* The next group should manage the version of hdoc.
Technical notes
---------------
The zip file includes 7 files :
* opale_to_hdoc.ant : which executes instructions (unzips compressed files, calls xsl, etc.)
* opale_to_hdoc.properties : linked to the ANT file (may contain ant properties)
* opale_to_hdoc_regle1.xsl : which creates an only XML source file
* opale_to_hdoc_regle2.xsl : which converts the XML source file to a hdoc file
* container.xsl : which changes the container's schemas to hdoc schemas
* find_ressources.xsl : which creates an ant file to move all resource files from the original scar directory to the output hdoc directory
* saxon9he.jar : Stored in the lib folder, this file allows the project to use the same xsl processor oxygen uses.
The sample is a Opale scar (an exported module). You can use it to test the converter. It contains several elements which are currently supported by the converter.
Capitalisation
--------------
During this semester, several converters have been realized. The goal is to transform different formats (mainly scenari formats) into others.
The opale_to_hdoc converter transcribes an Opale publication to a hdoc format. Opale has many elements and all are not supported by the converter yet. Currently, it can handle the majority of "Modules", "Activités d'apprentissage" and "Grains de contenu".
The source code converter is available and can be completed in order to
improve it and manage more Opale elements.
Converter
---------
Opale2Hdoc
License
-------
GPL 3.0
Credits
-------
Thibault Drain
Christophe Virot
Pierre Lemaire
Dependance
----------
This project can be used alone if you only want to convert a opale .scar
into a hdoc file.
User Documentation
------------------
OPALE
You have to respect the following steps :
Extract a module file from your Opale workspace
You can't export directly a web, paper or slide show support. You must extract
a module scar.
Moreover, when you extract a module, keep the default configuration :
"Include descendant network" input : checked
"keep workspaces" : unchecked
1. First, if you want to transform your
Opale publication to a Hdoc format,
you have to export a module file as a scar.
2. Then you just have to put your scar in the repository input inside the project
opale_to_hdoc.
3.
Finally, you can either launch the bash, the bat or start the ant by
taping the following instruction : ant -buildfile opale_to_hdoc
Unsupported
----------
-
- Module
Titre court
Références générales
Activité d'auto évaluation
Exercice rédactionnel
Exercice QCM
Exercice QCM graphique
Exercice QCU
Exercice QCU graphique
Exercice catégorisation
Exercice ordonnancement
Exercice texte à trous
Exercice question à réponse courte
Liste d'exercice
- Activité d'apprentissage
Titre court
Exercice rédactionnel
Exercice QCU
Exercice QCU graphique
Exercice QCM
Exercice QCM graphique
Exercice catégorisation
Exercice ordonnancement
Exercice texte à trous
Exercice question à réponse courte
Liste d'exercice
- Grain de contenu
Titre court
- Blocs
All bloc types are supported
- Types de texte
Ressources (ressources de type animation non supporté)
Fichier en téléchargement
- Éléments présents dans un texte
Formule mathématique
Abréviation
Glossaire
Références
Lien vers un document
Renvoi vers une ressource
Renvoi vers un grain de contenu
Animation
Known bugs
----------
All the ressources are not managed yet. Thus, sometimes the markup sp:res is
not visited by the program and it ends up with blank divs inside the
result.hdoc witch prevent it
from being valid. More over, we're not 100% sure
that there always will be a markup sp:index to define the type of the
ressource. However, now the index is used to determine
wether the target
hdoc markup has to be a img or object (video, audio remain in development).
TODOs
-----
- Listings are simply put inside p markups and should be externalized as pictures (ressources) in order to maintain the indent.
- Externalized opale UC and UA files are full of relative path that point
multiple kinds of references. Our ant program begins by merging all these
files into the root opale file.
Thus the relative paths become wrong.
Next group could look at what have been done with ressources (sp:res)
in order
to handle references the same way.
- Presently, you cannot select one scar file inside the input repository.
It could be useful to define an InputPath parameter that
would either
have the value of the only file set in input or would have the
value of a submissed relative path.
- The next group should manage the version of hdoc.
Technical notes
---------------
The zip file includes 7 files :
opale_to_hdoc.ant : which executes instructions (unzips compressed files,
calls xsl, etc.)
opale_to_hdoc.properties : linked to the ANT file (may contain ant
properties)
opale_to_hdoc_regle1.xsl : which creates an only XML source file
opale_to_hdoc_regle2.xsl : which converts the XML source file to a hdoc file
container.xsl : which changes the container's schemas to hdoc schemas
find_ressources.xsl : which creates an ant file to move all resource files
from the original scar directory to the output hdoc directory
saxon9he.jar : Stored in the lib folder, this file allows the project to
use the same xsl processor oxygen uses
The sample is a Opale scar (an exported module). You can use it to test
the converter.
It contains several elements which are currently supported by the converter.
Capitalization
--------------
During this semester, several converters have been realized. The goal is
to transform different formats (mainly scenari formats) into others.
The opale_to_hdoc converter
transcribes an opal publication to a hdoc
format. Opal has many elements and all are not supported by the converter
yet. Currently, it can handle the majority of "Modules",
"Activités
d'apprentissage" and "Grains de contenu".
The source code converter is available and can be completed in order to
improve it and manage more Opale elements.
\ No newline at end of file
Converter opale_to_optim
-----------------------
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a Opale document.
The Hdoc pivot format is used to convert one format to another, losing the least amount of information. It is based on HTML.
License GPL3.0
--------------
http://www.gnu.org/licenses/gpl-3.0.txt
Credits
-------
* Thibault DRAIN
* Rihab HACHEM
* Perrine RAVAUD (2014)
* Christophe Virot (2014)
* Pierre Lemaire (2014)
Dependance
----------
This converter is based on two converters :
* Opale to Hdoc
* Hdoc to Optim
User documentation
------------------
There are two different ways to use the converter opale_to_optim: by running a script run.bat/run.sh or by using a terminal (allows the user to specify some parameters like the document type).
#### Running the script run.bat/run.sh:
Use this method if you do not want to use a terminal.
1. Download hdoc_converter.zip and unzip it.
2. Add your source file to the Input folder. It has to be a .scar file.
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 opale_to_optim.
3. Run the following command:
"ant -buildfile opale_to_optim.ant"
You can specify the source file, and the output document type by adding parameters.
Use -DSource to specify the source file.
Use -DDocType to specify if it's a "paper" or a "slideshow".
Exemple:
"ant -buildfile opale_to_optim.ant -DDocType slideshow -DSource sample.scar"
Both parameters are optional. Your file has been converted, you can open your paper with OptimOffice.
Unsupported
-----------
Refer to the unsupported elements in Opale to Hdoc and in Hdoc to Optim.
Known bugs
----------
Refer to the known bugs in Opale to Hdoc and in Hdoc to Optim.
Todo
----
Refer to the Todos in Opale to Hdoc and in Hdoc to Optim.
Technical notes
---------------
The converter contains 1 file:
* opale_to_optim.ant
It checks wether or not the user specified the parameters and performs the following :
* Copy the input file in the opale_to_hdoc directory.
* Perform the opale_to_hdoc transformation.
* Copy the result in the hdoc_to_optim directory.
* Perform the hdoc_to_optim transformation.
* Copy the result in the opale_to_optim directory.
Capitalisation
--------------
N/A