diff options
| author | diego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2> | 2010-05-11 21:25:12 +0000 |
|---|---|---|
| committer | diego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2> | 2010-05-11 21:25:12 +0000 |
| commit | 5082b8de29a2e8e2cab9be3d54e813b9c29631c1 (patch) | |
| tree | 82e91f9d063de9f1ef2d3176acd3676d8966d1e9 /DOCS | |
| parent | f7d7d2db33d527caea2cde299427ea2323e73bad (diff) | |
| download | mpv-5082b8de29a2e8e2cab9be3d54e813b9c29631c1.tar.bz2 mpv-5082b8de29a2e8e2cab9be3d54e813b9c29631c1.tar.xz | |
Merge both XML documentation README files into one.
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@31165 b3059339-0415-0410-9bf9-f77b7e298cf2
Diffstat (limited to 'DOCS')
| -rw-r--r-- | DOCS/xml/README | 22 | ||||
| -rw-r--r-- | DOCS/xml/README.maintainers | 21 |
2 files changed, 22 insertions, 21 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/DOCS/xml/README.maintainers b/DOCS/xml/README.maintainers deleted file mode 100644 index bd3fb0c13a..0000000000 --- a/DOCS/xml/README.maintainers +++ /dev/null @@ -1,21 +0,0 @@ -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. |