summaryrefslogtreecommitdiffstats
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
authorTon Voon <tonvoon@users.sourceforge.net>2005-12-02 22:28:06 (GMT)
committerTon Voon <tonvoon@users.sourceforge.net>2005-12-02 22:28:06 (GMT)
commitec6d0db61c33e65a1c3e414b07638a55022dfbf6 (patch)
tree7c9d092636a8d76fb422392870e99860569717e3 /doc/developer-guidelines.sgml
parent01886efb2bc2500e4cd441d7d18f74cb817efd0c (diff)
downloadmonitoring-plugins-ec6d0db61c33e65a1c3e414b07638a55022dfbf6.tar.gz
Support for Nagios 1 and Nagios 2 status files (Gerhard Lausser - 1296242)
git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1294 f882894a-f735-0410-b71e-b25c423dba1c
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml30
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 193bc9b..433a302 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -86,7 +86,7 @@
86 86
87 <para>Output should be in the format:</para> 87 <para>Output should be in the format:</para>
88 <literallayout> 88 <literallayout>
89 METRIC STATUS: Information text 89 SERVICE STATUS: Information text
90 </literallayout> 90 </literallayout>
91 <para>However, note that this is not a requirement of the API, so you cannot depend on this 91 <para>However, note that this is not a requirement of the API, so you cannot depend on this
92 being an accurate reflection of the status of the service - the status should always 92 being an accurate reflection of the status of the service - the status should always
@@ -289,15 +289,10 @@
289 </section> 289 </section>
290 290
291 <section><title>Translations</title> 291 <section><title>Translations</title>
292 <para>If possible, use translation tools for all output. Currently, most of the core C plugins 292 <para>If possible, use translation tools for all output to respect the user's language
293 use gettext for translation. General guidelines are:</para> 293 settings. See <xref linkend="translations_developers"> for guidelines
294 294 for the core plugins.
295 <orderedlist> 295 </para>
296 <listitem><para>short help is not translated</para></listitem>
297 <listitem><para>long help has options in English language, but text translated</para></listitem>
298 <listitem><para>"Copyright" kept in English</para></listitem>
299 <listitem><para>copyright holder names kept in original text</para></listitem>
300 </orderedlist>
301 </section> 296 </section>
302</section> 297</section>
303 298
@@ -611,17 +606,24 @@
611update the THANKS.in file.</para> 606update the THANKS.in file.</para>
612 </section> 607 </section>
613 608
614 <section><title>Translations for developers</title> 609 <section id="translations_developers"><title>Translations for developers</title>
615 <para>To make the job easier for translators please follow these guidelines:</para> 610 <para>To make the job easier for translators, please follow these guidelines:</para>
616 <orderedlist> 611 <orderedlist>
617 <listitem><para> 612 <listitem><para>
618 before creating new strings, check the po/de.po file to see if a similar string 613 Before creating new strings, check the po/nagios-plugins.pot file to
614 see if a similar string
619 already exists 615 already exists
620 </para></listitem> 616 </para></listitem>
621 <listitem><para> 617 <listitem><para>
622 for help texts, break into individual options so that these can be reused 618 For help texts, break into individual options so that these can be reused
623 between plugins 619 between plugins
624 </para></listitem> 620 </para></listitem>
621 <listitem><para>Try to avoid linefeeds unless you are working on a block of text</para></listitem>
622 <listitem><para>Short help is not translated</para></listitem>
623 <listitem><para>Long help has options in English language, but text translated</para></listitem>
624 <listitem><para>"Copyright" kept in English</para></listitem>
625 <listitem><para>Copyright holder names kept in original text</para></listitem>
626 <listitem><para>Debugging output does not need to be translated</para></listitem>
625 </orderedlist> 627 </orderedlist>
626 </section> 628 </section>
627 629