[MPlayer-DOCS] r31165 - in trunk/DOCS/xml: README README.maintainers

diego subversion at mplayerhq.hu
Tue May 11 23:25:12 CEST 2010


Author: diego
Date: Tue May 11 23:25:12 2010
New Revision: 31165

Log:
Merge both XML documentation README files into one.

Deleted:
   trunk/DOCS/xml/README.maintainers
Modified:
   trunk/DOCS/xml/README

Modified: trunk/DOCS/xml/README
==============================================================================
--- trunk/DOCS/xml/README	Tue May 11 23:21:45 2010	(r31164)
+++ trunk/DOCS/xml/README	Tue May 11 23:25:12 2010	(r31165)
@@ -73,6 +73,28 @@ to see all available build targets and m
 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


More information about the MPlayer-DOCS mailing list