Those tools are mandatory to create the HTML documentation. .gitignore file is modifi...

[bacula/docs] / docs / tools / README

diff --git a/docs/tools/README b/docs/tools/README
new file mode 100644 (file)
index 0000000..5d2982e
--- /dev/null
+++ b/docs/tools/README
@@ -0,0 +1,25 @@
+Why those tools?
+HTML documentation was rewritten and provide a unique menu on each page.
+For a specific manual, the menu is the same, whatever the page is.
+
+htmls.sh
+--------
+For each manual, the htmls.sh script is designed to achieve those steps:
+a) Build and isolates the menu
+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})
+
+
+translatedoc.pl
+---------------
+This script is called for each HTML file, read the it and convert it:
+- removes the specific menu
+- includes the whole menu file
+- add some "class=" and "<div>" ... tags
+- do some comestics stuff.
+
+TODO:
+-----
+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.
+
+b) Cosmetic
+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.