Commit 1adb5795 authored by Hachem Rihab's avatar Hachem Rihab

[opale_to_optim] update README

parent 5291cb88
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.
The purpose of this converter is to obtain an Optim document (paper, slideshow, website or webpage) from a HTML file that respects the HDOC schema.
License GPL3.0
......@@ -35,7 +35,7 @@ There are two different ways to use the converter hdoc_to_optim: by running a sc
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.
2. Add your source file to the Input folder. It has to be a .hdoc 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.
......@@ -46,7 +46,7 @@ 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).
By using the terminal you can specify some parameters to the conversion : the source file, or the output type (either a paper, a slideshow, a website or a webpage).
1. Download hdoc_converter.zip and unzip it.
2. Open your terminal and go into the folder hdoc_to_optim.
......@@ -56,27 +56,33 @@ By using the terminal you can specify some parameters to the conversion : the so
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".
Use -DDocType to specify if it's a "paper", a "slideshow", a "website" or a "webpage".
Exemple:
"ant -buildfile hdoc_to_optim.ant -DDocType slideshow -DInputFile sample.hdoc"
"ant -buildfile hdoc_to_optim.ant -DDocType website"
Both parameters are optional. Your file has been converted, you can open your paper with OptimOffice.
Both parameters are optional. Your file has been converted, you can open your document with OptimOffice.
Unsupported
-----------
#### In paper and slideshow:
#### In paper, slideshow, website and webpage:
* Inline: Superscript, Subscript
* SpanType : Latex, Syntax
#### In slideshow:
#### In slideshow, website and webpage:
* Metadata : Description, Keywords
#### In webpage:
* All metadata (however, if it's only a webpage, is it really useful ? The metadata should appear on the website information, not each webpage ? )
Known bugs
----------
......@@ -87,8 +93,9 @@ 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.
* Offer the possibility of integrating the sections into a webmedia application.
* Find a better way to transform the metadata (description and keywords) information.
* Factorise the code (put all transformations in one file for example).
* Integrate Concept trees.
......@@ -112,6 +119,12 @@ This XSLT program runs through the content file of hdoc and convert each hdoc ta
* 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.
* transfo3.xsl (website) :
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 website.
* transfo4.xsl (webpage) :
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 webpage.
* .wspmeta :
This file contains Optim metadata informations, it must be placed in the result of the conversion
......
Converter opale_to_optim
-----------------------
The purpose of this converter is to obtain an Optim document (paper or slideshow) from a Opale document.
The purpose of this converter is to obtain an Optim document (paper, slideshow, website or webpage) 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.
......@@ -41,10 +41,20 @@ There are two different ways to use the converter opale_to_optim: by running a s
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.
2. Add your source file to the Input folder. It has to be a .scar file.
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
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.
......@@ -52,7 +62,7 @@ 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).
By using the terminal you can specify some parameters to the conversion : the source file, or the output type (either a paper, a slideshow, a website or a webpage).
1. Download hdoc_converter.zip and unzip it.
2. Open your terminal and go into the folder opale_to_optim.
......@@ -62,13 +72,15 @@ By using the terminal you can specify some parameters to the conversion : the so
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:
Use -DDocType to specify if it's a "paper", a "slideshow", a "website" or a "webpage".
Exemples:
"ant -buildfile opale_to_optim.ant -DDocType slideshow -DSource sample.scar"
"ant -buildfile opale_to_optim.ant -DDocType website"
Both parameters are optional. Your file has been converted, you can open your paper with OptimOffice.
Both parameters are optional. Your file has been converted, you can open your document with OptimOffice.
Unsupported
......
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