README 7.33 KB
Newer Older
1 2 3
Usage
-----

Ivan D'halluin's avatar
Ivan D'halluin committed
4
Put `.scar` files in the input folder, run `run.bat` or `run.sh` and get results in output folder (one folder and a .hdoc per .scar).
5 6


Ivan D'halluin's avatar
Ivan D'halluin committed
7 8
Todo list
---------
9

10
- tests more files
Ivan D'halluin's avatar
Ivan D'halluin committed
11 12
- clean output of optim source files
- resolve bugs
Ivan D'halluin's avatar
Ivan D'halluin committed
13
- test the entier process from optim to opale
Ivan D'halluin's avatar
Ivan D'halluin committed
14
- 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.
15

Ivan D'halluin's avatar
Ivan D'halluin committed
16 17
Bugs
----
18

19 20
- references of sections or fragments inside a paragraphe
- can create divs with only h6
21 22


Ivan D'halluin's avatar
Ivan D'halluin committed
23 24
Transformation
--------------
25

Ivan D'halluin's avatar
Ivan D'halluin committed
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
| 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>                                |                                             |