[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

02/03: doc: Add more recommandations for package descriptions.

From: Mathieu Lirzin
Subject: 02/03: doc: Add more recommandations for package descriptions.
Date: Sun, 27 Sep 2015 22:28:01 +0000

mthl pushed a commit to branch master
in repository guix.

commit ba7d6c763c6adac4cf26fef656c7f98296601d0b
Author: Mathieu Lirzin <address@hidden>
Date:   Sun Sep 27 01:18:07 2015 +0200

    doc: Add more recommandations for package descriptions.
    * doc/guix.texi (Synopses and Descriptions): Warn about special
      characters in Texinfo.  Indicate how to help the translators.
 doc/guix.texi |   20 ++++++++++++++++----
 1 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 8608e7a..dfd054e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7294,9 +7294,12 @@ Descriptions should take between five and ten lines.  
Use full
 sentences, and avoid using acronyms without first introducing them.
 Descriptions can include Texinfo markup, which is useful to introduce
 ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or
-hyperlinks (@pxref{Overview, overview of Texinfo,, texinfo, GNU
-Texinfo}).  User interfaces such as @command{guix package --show} take
-care of rendering it appropriately.
+hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}).  However you
+should be careful when using some characters for example @samp{@@} and
+curly braces which are the basic special characters in Texinfo
+(@pxref{Special Characters,,, texinfo, GNU Texinfo}).  User interfaces
+such as @command{guix package --show} take care of rendering it
 Synopses and descriptions are translated by volunteers
 @uref{, at the
@@ -7306,7 +7309,16 @@ the language specified by the current locale.
 Translation is a lot of work so, as a packager, please pay even more
 attention to your synopses and descriptions as every change may entail
-additional work for translators.
+additional work for translators.  In order to help them, it is possible
+to make recommandations or instructions visible to them by inserting
+special comments like this (@pxref{xgettext Invocation,,, gettext, GNU
+;; TRANSLATORS: "X11 resize-and-rotate" should not be translated.
+(description "ARandR is designed to provide a simple visual front end
+for the X11 resize-and-rotate (RandR) extension. @dots{}")
address@hidden example
 @node Python Modules

reply via email to

[Prev in Thread] Current Thread [Next in Thread]