2003-03-23 23:26:55 +00:00
|
|
|
The documentation and its translations reside in subdirectories.
|
|
|
|
|
When building the documentation, the toplevel Makefile goes into
|
|
|
|
|
the subdirectories listed in the SUBDIRS variable and executes make
|
|
|
|
|
in each of those directories to create the HTML documentation
|
2009-12-13 22:43:37 +00:00
|
|
|
in subdirectories of the 'HTML' directory.
|
2003-03-23 23:26:55 +00:00
|
|
|
|
2009-12-13 22:43:37 +00:00
|
|
|
IMPORTANT: Do NOT place sensitive files under 'HTML'!
|
2003-03-23 23:26:55 +00:00
|
|
|
It is for generated documentation only.
|
|
|
|
|
The whole directory tree is wiped out by the Makefile
|
2003-10-21 10:26:00 +00:00
|
|
|
when running 'make distclean' or 'make clean'.
|
2003-03-23 23:26:55 +00:00
|
|
|
|
|
|
|
|
Each subdirectory must have a Makefile. Its purpose is to include
|
|
|
|
|
the toplevel Makefile.inc file (with the rules to build the docs)
|
|
|
|
|
and add dependency information to the main target, $(HTMLDIR)/index.html.
|
2009-12-14 02:01:50 +00:00
|
|
|
The main target usually depends on all the XML files in the subdirectory.
|
2003-03-23 23:26:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Adding new translations
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
2006-05-09 13:49:15 +00:00
|
|
|
1) Create a new subdirectory and copy the XML files there. main.xml must not be
|
|
|
|
|
copied, it is autogenerated.
|
2003-10-21 01:32:34 +00:00
|
|
|
|
2003-03-23 23:26:55 +00:00
|
|
|
2) Make sure to create a 'Makefile' for the translation -- you can
|
|
|
|
|
use 'en/Makefile' as an example.
|
2003-10-21 01:32:34 +00:00
|
|
|
|
2009-12-14 02:01:50 +00:00
|
|
|
3) In each translated file after the <?xml ... ?> tag you must put a note
|
2006-12-17 08:42:37 +00:00
|
|
|
like <!-- synced with r2 -->, where 2 is the revision of corresponding
|
2003-09-22 08:24:37 +00:00
|
|
|
English file (see comment at the top of file).
|
2003-10-21 01:32:34 +00:00
|
|
|
|
2003-03-23 23:26:55 +00:00
|
|
|
That's all, in theory.
|
