RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2025-02-18 13:47:04 +00:00
Code Issues Releases Wiki Activity

Merge both XML documentation README files into one.

Browse Source 
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@31165 b3059339-0415-0410-9bf9-f77b7e298cf2
This commit is contained in:
diego 2010-05-11 21:25:12 +00:00
parent f7d7d2db33
commit 5082b8de29
2 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
DOCS/xml/README
View File

@ -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 wrong, check the Configuration section of the toplevel Makefile and adjust
the variables. 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 A few words about SGML catalog files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

21
DOCS/xml/README.maintainers
View File

@ -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.