diff options
Diffstat (limited to 'DOCS/xml/README')
| -rw-r--r-- | DOCS/xml/README | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/DOCS/xml/README b/DOCS/xml/README index 1897dd53eb..f05432aaa2 100644 --- a/DOCS/xml/README +++ b/DOCS/xml/README @@ -73,6 +73,28 @@ to see all available build targets and make your choice. If something goes wrong, check the Configuration section of the toplevel Makefile and adjust the variables. +The documentation and its translations reside in subdirectories. +When building the documentation, the generated HTML files are +placed in subdirectories of the 'HTML' directory. + +IMPORTANT: Do NOT place sensitive files under 'HTML'! + It is for generated documentation only. + The whole directory tree is wiped out by the Makefile + when running 'make distclean' or 'make clean'. + + +Adding new translations +~~~~~~~~~~~~~~~~~~~~~~~ + +1) Create a new subdirectory and copy the XML files there. main.xml must not be + copied, it is autogenerated. + +2) In each translated file after the <?xml ... ?> tag you must put a note + like <!-- synced with r2 -->, where 2 is the revision of corresponding + English file (see comment at the top of file). + +That's all, in theory. + A few words about SGML catalog files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |