diff DOCS/xml/README @ 31108:20cee5a646b3

Merge both XML documentation README files into one.
author diego
date Tue, 11 May 2010 21:25:12 +0000
parents 0ad2da052b2e
children 7c10f547ce96
line wrap: on
line diff
--- a/DOCS/xml/README	Tue May 11 21:21:45 2010 +0000
+++ b/DOCS/xml/README	Tue May 11 21:25:12 2010 +0000
@@ -73,6 +73,28 @@
 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~