README.txt 4.58 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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
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.





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.