README.txt 3.46 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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.