Optim to Hdoc
=============

Licence
-------

This project is under [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.txt).


Credits
-------

Ivan D'halluin, Sylvain Lagache, Frédéric Le Feurmou.


User documentation
------------------

Use the project as describe in the root README. You can convert multiple files by putting all `.scar` in the input folder.
You can convert paper, section, website, slideshow and webpage.


Known bugs
----------

- references of sections or fragments inside a paragraphe
- can create divs with only h6


Todo
----

- tests more files
- clean output of optim source files
- resolve bugs
- qualify supported version of Optim
- 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
  - maybe define it from the opale root file (paper, section, website, slideshow and webpage)
  - and/or define it from the command line
  - and/or choose it terms of heuristic (size of content, number of imbricated parts...)
  - and/or generate different hdoc version


Technicals notes
----------------

| Optim start tag (or structures) | HDOC end tag                        | Note                                        |
|---------------------------------|-------------------------------------|---------------------------------------------|
| 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>                                |                                             |