Contents of /trunk/manual/build/lang-options/README

INSTRUCTIONS FOR USING OPTIONAL PARAGRAPHS
==========================================

In some places in the manual paragraphs have been included that are not
included in the generated English version of the manual. They can however
be included _optionally_ in translations.

To include an optional paragraph for your translation, you need to "enable"
it:
- creating a file in this directory with your language code as its name
- add a singe line in this file containing:
     optional_paras="condition(s)"
- if you want to enable more than one optional paragraph, separate their
  conditions by a semicolon (without a space)

example
-------
optional_paras="about-langteam;gpl-unofficial"


       *** PLEASE CHECK THE RESULT AFTER THE MANUAL HAS BEEN BUILT ***


TRANSLATING AN OPTIONAL PARAGRAPH
=================================
In some cases you should replace the full text of the paragraph with your own.
In other cases you may need to translate the English text included in the
paragraph.

If comments are included in the paragraph (to help translation), these should
be deleted.


LIST OF DEFINED OPTIONAL PARAGRAPHS
===================================
Currently the following optional paragraphs have been defined (the first term
is the name of the condition used to activate it):
* about-langteam (en/administrativa/administrativa.xml
  Allows to add some info about the translator or translation team, and how
  to contact the translator(s).
* translation-status (en/bookinfo.xml)
  Allows to add information about the status of the translation and maybe to
  request reviews.
* gpl-unofficial (en/appendix/gpl.xml)
  *Must* be included if the GPL itself is translated; should *not* be included
  if the appendix contains the original (untranslated) English text of the GPL.
  Consists of two paragraphs of which the first *should remain in English*.
  See http://www.gnu.org/licenses/translations.html for additional information.
1	fjp	36880	INSTRUCTIONS FOR USING OPTIONAL PARAGRAPHS
2			==========================================
3
4			In some places in the manual paragraphs have been included that are not
5			included in the generated English version of the manual. They can however
6			be included _optionally_ in translations.
7
8			To include an optional paragraph for your translation, you need to "enable"
9			it:
10			- creating a file in this directory with your language code as its name
11			- add a singe line in this file containing:
12			optional_paras="condition(s)"
13			- if you want to enable more than one optional paragraph, separate their
14			conditions by a semicolon (without a space)
15
16			example
17			-------
18	fjp	38900	optional_paras="about-langteam;gpl-unofficial"
19	fjp	36880
20
21			* PLEASE CHECK THE RESULT AFTER THE MANUAL HAS BEEN BUILT *
22
23
24			TRANSLATING AN OPTIONAL PARAGRAPH
25			=================================
26			In some cases you should replace the full text of the paragraph with your own.
27			In other cases you may need to translate the English text included in the
28			paragraph.
29
30			If comments are included in the paragraph (to help translation), these should
31			be deleted.
32
33
34			LIST OF DEFINED OPTIONAL PARAGRAPHS
35			===================================
36			Currently the following optional paragraphs have been defined (the first term
37			is the name of the condition used to activate it):
38	fjp	38900	* about-langteam (en/administrativa/administrativa.xml
39			Allows to add some info about the translator or translation team, and how
40			to contact the translator(s).
41			* translation-status (en/bookinfo.xml)
42			Allows to add information about the status of the translation and maybe to
43			request reviews.
44	fjp	36880	* gpl-unofficial (en/appendix/gpl.xml)
45			Must be included if the GPL itself is translated; should not be included
46			if the appendix contains the original (untranslated) English text of the GPL.
47			Consists of two paragraphs of which the first should remain in English.
48			See http://www.gnu.org/licenses/translations.html for additional information.