| 1 |
Why those tools? |
| 2 |
HTML documentation was rewritten and provide a unique menu on each page. |
| 3 |
For a specific manual, the menu is the same, whatever the page is. |
| 4 |
|
| 5 |
htmls.sh |
| 6 |
-------- |
| 7 |
For each manual, the htmls.sh script is designed to achieve those steps: |
| 8 |
a) Build and isolates the menu |
| 9 |
b) Interpret the latex2html HTML files located into docs/manuals/en/www-{manual} and rewrite all HTML files for the manual and put them to the expected directory (docs/manuals/en/{manual}/{manual}) |
| 10 |
c) Find and note all the <a name="..."> tags into a file named list-of-anchors |
| 11 |
|
| 12 |
|
| 13 |
translatedoc.pl |
| 14 |
--------------- |
| 15 |
This script is called for each HTML file, read it and convert it: |
| 16 |
- removes the specific menu |
| 17 |
- includes the whole menu file |
| 18 |
- add some "class=" and "<div>" ... tags |
| 19 |
- do some comestics stuff. |
| 20 |
- note all anchors defined into the HTML files. |
| 21 |
|
| 22 |
|
| 23 |
handle-xr-references.pl |
| 24 |
----------------------- |
| 25 |
This script is designed to read the anchors found when reading original HTML files (see above) |
| 26 |
and then replace all the __XRANCHOR_ built during the latex2html process (see docs/README.pct) |
| 27 |
into <a href...> tag. |
| 28 |
|
| 29 |
TODO: |
| 30 |
----- |
| 31 |
a) Important: Manage the language into htmls.sh. Currently only the manuals/en manuals are managed. I would suggest to pass the language value and manage it into the "SOURCEDIRHEAD" variable. |
| 32 |
|
| 33 |
b) Cosmetic |
| 34 |
We should add some treatments in the translatedoc.pl script to replace anchor with some more readable labels. The one generated by latex2html are way too complex in my opinion. |
| 35 |
|
| 36 |
|
| 37 |
index.pl |
| 38 |
-------- |
| 39 |
This script will generate a JSON file with all \label{} references of all html files. |
| 40 |
It is used by bweb to find the right page with a label. |
| 41 |
|
| 42 |
|
| 43 |
index.html |
| 44 |
---------- |
| 45 |
This page should redirect to the right documentation page, it is using js/index.js |
| 46 |
|
| 47 |
ex: <li><a href="javascript:get_doc('6.6', 'main', 'RestoreChapter')">More...(Restore Chapter)</a></li> |
| 48 |
|