1Locale::Po4a::Sgml(3) User Contributed Perl DocumentationLocale::Po4a::Sgml(3)
2
6 Locale::Po4a::Sgml - convert SGML documents from/to PO files
7
9 The po4a (PO for anything) project goal is to ease translations (and
10 more interestingly, the maintenance of translations) using gettext
11 tools on areas where they were not expected like documentation.
12 Locale::Po4a::Sgml is a module to help the translation of documentation
14 in the SGML format into other [human] languages.
15 This module uses nsgmls to parse the SGML files. Make sure it is
17 installed. Also make sure that the DTD of the SGML files are installed
18 in the system.
19
21 debug
22 Space separated list of keywords indicating which part you want to
23 debug. Possible values are: tag, generic, entities and refs.
24 verbose
26 Give more information about what's going on.
27 translate
29 Space separated list of extra tags (beside the DTD provided ones)
30 whose content should form an extra msgid.
31 section
33 Space separated list of extra tags (beside the DTD provided ones)
34 containing other tags, some of them being of category translate.
35 indent
37 Space separated list of tags which increase the indentation level.
38 verbatim
40 The layout within those tags should not be changed. The paragraph
41 won't get wrapped, and no extra indentation space or new line will
42 be added for cosmetic purpose.
43 empty
45 Tags not needing to be closed.
46 ignore
48 Tags ignored and considered as plain char data by po4a. That is to
49 say that they can be part of an msgid. For example, <b> is a good
50 candidate for this category since putting it in the translate
51 section would create msgids not being whole sentences, which is
52 bad.
53 attributes
55 A space separated list of attributes that need to be translated.
56 You can specify the attributes by their name (for example, "lang"),
57 but you can also prefix it with a tag hierarchy, to specify that
58 this attribute will only be translated when it is into the
59 specified tag. For example: <bbb><aaa>lang specifies that the lang
60 attribute will only be translated if it is in an <aaa> tag, which
61 is in a <bbb> tag. The tag names are actually regular expressions
62 so you can also write things like <aaa|bbbb>lang to only translate
63 lang attributes that are in an <aaa> or a <bbb> tag.
64 qualify
66 A space separated list of attributes for which the translation must
67 be qualified by the attribute name. Note that this setting
68 automatically adds the given attribute into the 'attributes' list
69 too.
70 force
72 Proceed even if the DTD is unknown or if nsgmls finds errors in the
73 input file.
74 include-all
76 By default, msgids containing only one entity (like '&version;')
77 are skipped for the translator comfort. Activating this option
78 prevents this optimisation. It can be useful if the document
79 contains a construction like "<title>Á</title>", even if I
80 doubt such things to ever happen...
81 ignore-inclusion
83 Space separated list of entities that won't be inlined. Use this
84 option with caution: it may cause nsgmls (used internally) to add
85 tags and render the output document invalid.
86
88 The result is perfect. I.e., the generated documents are exactly the
89 same. But there are still some problems:
90 · The error output of nsgmls is redirected to /dev/null, which is
92 clearly bad. I don't know how to avoid that.
93 The problem is that I have to "protect" the conditional inclusions
95 (i.e. the "<! [ %foo [" and "]]>" stuff) from nsgmls. Otherwise
96 nsgmls eats them, and I don't know how to restore them in the final
97 document. To prevent that, I rewrite them to "{PO4A-beg-foo}" and
98 "{PO4A-end}".
99 The problem with this is that the "{PO4A-end}" and such I add are
101 valid in the document (not in a <p> tag or so).
102 Everything works well with nsgmls's output redirected that way, but
104 it will prevent us from detecting that the document is badly
105 formatted.
106 · It does work only with the DebianDoc and DocBook DTD. Adding support
108 for a new DTD should be very easy. The mechanism is the same for
109 every DTD, you just have to give a list of the existing tags and some
110 of their characteristics.
111 I agree, this needs some more documentation, but it is still
113 considered as beta, and I hate to document stuff which may/will
114 change.
115 · Warning, support for DTDs is quite experimental. I did not read any
117 reference manual to find the definition of every tag. I did add tag
118 definition to the module 'till it works for some documents I found on
119 the net. If your document use more tags than mine, it won't work. But
120 as I said above, fixing that should be quite easy.
121 I did test DocBook against the SAG (System Administrator Guide) only,
123 but this document is quite big, and should use most of the DocBook
124 specificities.
125 For DebianDoc, I tested some of the manuals from the DDP, but not all
127 yet.
128 · In case of file inclusion, string reference of messages in PO files
130 (i.e. lines like "#: en/titletoc.sgml:9460") will be wrong.
131 This is because I preprocess the file to protect the conditional
133 inclusion (i.e. the "<! [ %foo [" and "]]>" stuff) and some entities
134 (like &version;) from nsgmls because I want them verbatim to the
135 generated document. For that, I make a temp copy of the input file
136 and do all the changes I want to this before passing it to nsgmls for
137 parsing.
138 So that it works, I replace the entities asking for a file inclusion
140 by the content of the given file (so that I can protect what needs to
141 be in a subfile also). But nothing is done so far to correct the
142 references (i.e., filename and line number) afterward. I'm not sure
143 what the best thing to do is.
144
146 This module is an adapted version of sgmlspl (SGML postprocessor for
147 the SGMLS and NSGMLS parsers) which was:
148 Copyright (c) 1995 by David Megginson <dmeggins@aix1.uottawa.ca>
150 The adaptation for po4a was done by:
152 Denis Barbier <barbier@linuxfr.org>
154 Martin Quinson (mquinson#debian.org)
155
157 Copyright (c) 1995 by David Megginson <dmeggins@aix1.uottawa.ca>
158 Copyright 2002, 2003, 2004, 2005 by SPI, inc.
159 This program is free software; you may redistribute it and/or modify it
161 under the terms of GPL (see the COPYING file).
162perl v5.16.3 2014-06-10 Locale::Po4a::Sgml(3)