From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mathieu Lirzin Subject: Re: [PATCH] gnu packages: Clean up synopses and descriptions. Date: Thu, 16 Jul 2015 23:33:06 +0200 Message-ID: <87r3o7pz3h.fsf@openmailbox.org> References: <87wpy0nygt.fsf@gmail.com> <87y4ige2ux.fsf@openmailbox.org> <87wpy0t83c.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:42385) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZFqo4-00057u-VR for guix-devel@gnu.org; Thu, 16 Jul 2015 17:35:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZFqny-0007o0-QK for guix-devel@gnu.org; Thu, 16 Jul 2015 17:35:04 -0400 Received: from smtp11.openmailbox.org ([62.4.1.45]:60470) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZFqny-0007nb-HE for guix-devel@gnu.org; Thu, 16 Jul 2015 17:34:58 -0400 In-Reply-To: <87wpy0t83c.fsf@gnu.org> ("Ludovic \=\?utf-8\?Q\?Court\=C3\=A8s\=22'\?\= \=\?utf-8\?Q\?s\?\= message of "Thu, 16 Jul 2015 17:50:31 +0200") List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org To: Ludovic =?utf-8?Q?Court=C3=A8s?= Cc: guix-devel@gnu.org, Alex Kost ludo@gnu.org (Ludovic Court=C3=A8s) writes: > What are your concerns and what would you prefer? (I was left with the > impression that there was a rough consensus in the other thread, but > surely there=E2=80=99s a bias.) > > In Emacs it=E2=80=99s quite easily typed (C-x 8 RET etc.), and at worst p= eople > can copy/paste it. My concerns are about the translators, who will have to care about more formatting (formatted variables are enough :)) and about my impression that keeping unformatted text can be more easily rendered in different contexts (guix package, guix web, guix.el and beyond!) but maybe I'm wrong. The first (probably stupid) idea that comes to my mind is to transform the description field into a list of multiple (unformatted) strings and sexps, where the responsability of the formatting is delegated to the program that actually displays the descriptions. For the translator, the description will appear as 4 independent strings with no special formatting to take care. --8<---------------cut here---------------start------------->8--- (description "XKBUtils is a collection of small utilities for X Keyboard (XKB) extension to the X11 protocol. It includes:" '(unordered-list ; Or a better symbol "xkbbell: generate XKB bell events;" "xkbvleds: display the state of LEDs on an XKB keyboard in a wind= ow;" "xkbwatch: reports changes in the XKB keyboard state.")) --8<---------------cut here---------------end--------------->8--- or with just nested lists --8<---------------cut here---------------start------------->8--- (description "XKBUtils is a collection of small utilities for X Keyboard (XKB) extension to the X11 protocol. It includes:" '("xkbbell: generate XKB bell events;" "xkbvleds: display the state of LEDs on an XKB keyboard in a wind= ow;" "xkbwatch: reports changes in the XKB keyboard state.")) --8<---------------cut here---------------end--------------->8--- I let more experienced schemers interpret this idea ;). -- Mathieu Lirzin