comparison DOCS/xml/README.maintainers @ 11199:b61680a0b29a

Add some whitespace for readability + some wording improvements.

11198:1d753b45e42e

Adding new translations
~~~~~~~~~~~~~~~~~~~~~~~

1) Create a new subdirectory and copy the XML files there.
2) Make sure to create a 'Makefile' for the translation -- you can
   use 'en/Makefile' as an example.
3) Set <book lang="XX"> to your language code if the DocBook XSL
   stylesheets support it.
4) If you want to use a customized XSL stylesheet, create one and name it
   'html-common.xsl'. Also create two additional XSL stylesheets ('html.xsl'
   and 'html-chunk.xsl', with such content:

   html.xsl:

   <?xml version="1.0" encoding="ISO-8859-1"?>
   <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

   Note: You mustn't xsl:include or xsl:import chunk.xsl directly!
   Including it can (and will) break building of documentation if chunk.xsl
   is installed at a nonstandard location.
5) If you wish to change output encoding of generated files, create
   html-common.xsl as suggested in step 4) and add such strings somewhere
   between <xsl:stylesheet ...> and </xsl:stylesheet> tags
   (please, pay attention to quotes):

      <xsl:param name="chunker.output.encoding" select="'your_encoding'"/>
      <xsl:output encoding="your_encoding"/>

   Use ru/html-common.xsl as example.
6) If you are using your own HTML stylesheet, edit your Makefile and set
   the HTML_STYLESHEET variable to its name. Please, don't give name
   'default.css' to your HTML stylesheet.
7) In each translated file after the <?xml ... ?> tag you must put a note
   like <!-- synced with 1.2 -->, where 1.2 is the revision of corresponding
   English file (see comment at the top of file).
8) While your translation isn't finished, you can change USE_SYMLINKS
   to "yes" in your Makefile. This will help you testing your translation:
   english files will be used instead of untranslated ones, when generating
   HTML docs.

11199:b61680a0b29a

Adding new translations
~~~~~~~~~~~~~~~~~~~~~~~

1) Create a new subdirectory and copy the XML files there.

2) Make sure to create a 'Makefile' for the translation -- you can
   use 'en/Makefile' as an example.

3) Set <book lang="XX"> to your language code if the DocBook XSL
   stylesheets support it.

4) If you want to use a customized XSL stylesheet, create one and name it
   'html-common.xsl'. Also create two additional XSL stylesheets ('html.xsl'
   and 'html-chunk.xsl', with content such as this:

   html.xsl:

   <?xml version="1.0" encoding="ISO-8859-1"?>
   <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

   Note: You mustn't xsl:include or xsl:import chunk.xsl directly!
   Including it can (and will) break building of documentation if chunk.xsl
   is installed at a nonstandard location.

5) If you wish to change the output encoding of generated files, create
   html-common.xsl as suggested in step 4) and add strings such as these
   somewhere between the <xsl:stylesheet ...> and </xsl:stylesheet> tags
   (please, pay attention to quotes):

      <xsl:param name="chunker.output.encoding" select="'your_encoding'"/>
      <xsl:output encoding="your_encoding"/>

   Use ru/html-common.xsl as example.

6) If you are using your own HTML stylesheet, edit your Makefile and set
   the HTML_STYLESHEET variable to its name. Please, don't call your HTML
   stylesheet 'default.css'.

7) In each translated file after the <?xml ... ?> tag you must put a note
   like <!-- synced with 1.2 -->, where 1.2 is the revision of corresponding
   English file (see comment at the top of file).

8) While your translation isn't finished, you can change USE_SYMLINKS
   to "yes" in your Makefile. This will help you testing your translation:
   english files will be used instead of untranslated ones, when generating
   HTML docs.