Commit a98e8e51 authored by Ivan D'halluin's avatar Ivan D'halluin

clean README

parent c332b236
...@@ -3,41 +3,80 @@ Usage ...@@ -3,41 +3,80 @@ Usage
Put `.scar` files in the input folder, run `run.bat` or `run.sh` and get results in output folder (one folder and zip per .scar). Put `.scar` files in the input folder, run `run.bat` or `run.sh` and get results in output folder (one folder and zip per .scar).
Suppported
----------
- sections, blocks, paragraphs Todo list
- inline tags (quote, emphasis, url, definition, inlineImg) ---------
- ordered/unordered lists
- images
- audio
- tables
- OpenDocument .ods, .odg files
- event list
- concept tree
Unsupported
-----------
The Hdoc format create some limitations with the conversion and some points cannot be converted for the moment:
- references of sections or fragments inside a paragraphe - tests more files (with As We May)
- add schema validation
- clean output of optim source files
- resolve bugs
- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project.
Known bugs
----------
Because of the small amount of tested file this list of know bugs could increase in a near futur: Bugs
----
- references of sections or fragments inside a paragraphe ; - references of sections or fragments inside a paragraphe ;
- images and ressources sometimes need to be reselected after the conversion to opale (images are shown in the editor but fail to be loaded when publishing) ;
- links to ressources sometimes doesn't appears after the conversion to opale (links are still in the text view but not in the editor) ;
- Références à des fragments et des sections à l'intérieur de paragraphes non converti ;
- Les images doivent parfois être sélectionnés à nouveau ;
- Les liens n'apparaissent pas parfois mais sont bien présent en mode édition de texte ;
Todo list
---------
There is some points that still need to be tested. Actually I don't have enough Optim files to be sure that everything works fine (does every optim item is converted properly). In the same way I've only tested the conversion with a few publication items (webpage, paper) and I need to test it with the other forms of publication items allowed in Optim. Transformation
--------------
Another point is that for the moment the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project. | Optim start tag (or structures) | HDOC end tag | Note |
\ No newline at end of file |---------------------------------|-------------------------------------|---------------------------------------------|
| section | <section> | A section can contains other sections |
| | | (after the header tag) or several blocks. |
| | <h1> (title) | |
| | <div> (meta) | |
| | </header> | |
| | ... | |
| | </section> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| block | <div> | A block can contains several paragraphes. |
| | <h6/> (title) | |
| | <p/> (content) | |
| | </div> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| extra (block) | <div data-hdoc-type=\"complement\"> | |
| | <h6/> (title) | |
| | <p/> (content) | |
| | </div> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| emphasis (block) | <div data-hdoc-type=\"emphasis\"> | |
| | <h6/> (title) | |
| | <p/> (content) | |
| | </div> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| para | <p/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| emphasis | <em/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| special | <em/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| url | <a/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| quote | <q/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| image | <img/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| audio | <audio/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| odg | <object/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| ods | <object/> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| itemizedList | <ul><li/>...</ul> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| orderedList | <ol><li/>...</ol> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| table | <tr><td/>...</tr> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| def | <p><em>term</em>Â : definition </p> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| event | <div><h6/><p/></div> | |
|---------------------------------|-------------------------------------|---------------------------------------------|
| tree | <div><h6/><p/></div> | The structure of trees cannot be converted |
| | | and the result is a list a blocks |
|---------------------------------|-------------------------------------|---------------------------------------------|
| title | <h6> | |
\ No newline at end of file
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