From mboxrd@z Thu Jan  1 00:00:00 1970
From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=)
Subject: Re: [bug-womb] Texinfo markup in package blurbs
Date: Wed, 11 Nov 2015 22:52:50 +0100
Message-ID: <87ziyk8aq5.fsf@gnu.org>
References: <87r3k01abt.fsf@gnu.org> <1447061931.17414.6.camel@invergo.net>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:49927)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <ludo@gnu.org>) id 1ZwdK6-0005Ns-EV
	for guix-devel@gnu.org; Wed, 11 Nov 2015 16:52:59 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <ludo@gnu.org>) id 1ZwdK3-0006F7-8D
	for guix-devel@gnu.org; Wed, 11 Nov 2015 16:52:58 -0500
In-Reply-To: <1447061931.17414.6.camel@invergo.net> (Brandon Invergo's message
	of "Mon, 09 Nov 2015 09:38:51 +0000")
List-Id: "Development of GNU Guix and the GNU System distribution."
	<guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/guix-devel>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=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: Brandon Invergo <brandon@invergo.net>
Cc: guix-devel <guix-devel@gnu.org>, bug-womb@gnu.org

Hey Brandon,

Brandon Invergo <brandon@invergo.net> skribis:

>> Guix has gained the possibility to have Texinfo markup in package
>> descriptions=C2=B9, which is properly rendered by user interfaces and at
>> <https://www.gnu.org/software/guix/packages/>.=C2=A0=C2=A0Often we just =
limit
>> ourselves to ornaments such as @dfn, @code, or @uref.
>>=20
>> Perhaps we could consider using it in pkgblurbs.txt if the needed for
>> enriched text arises?
>
> pkgblurbs.txt is also used in GSRC and for generating
> https://gnu.org/manual/blurbs.html and the "featured package" blurb on
> the gnu.org front page.=C2=A0=C2=A0So with Make, we would have to strip t=
he markup
> while for the web we would have to convert it to HTML.=C2=A0=C2=A0I guess=
 we could
> do an intermediate solution, like some m4 macros, to output the desired
> format for each target, but that might be a bit over-engineered.=C2=A0=C2=
=A0Ideas?

ISTR that Karl had implemented a script that converts sequences like:

  `[^ ]+'

to:

  <code>\1</code>

for the HTML output.

You could do something like that for =E2=80=9C@code{foo}=E2=80=9D.  However=
, that
wouldn=E2=80=99t scale well to other tags.

So I would suggest using Guile as well, along the lines of:

  http://git.savannah.gnu.org/cgit/guix.git/tree/guix/ui.scm#n816

and with =E2=80=98recutils->alist=E2=80=99 to extract the text from pkgblur=
bs.txt:

  http://git.savannah.gnu.org/cgit/guix.git/tree/guix/records.scm#n328

Now, I would understand if you think this is going too far in the Guile
direction, however pleasing that may be.  ;-)

> A more pertinent question: are there any blurbs in particular that you
> think should have some text marked up?

No, no particular example in mind, rather forward-looking.  I guess
those that use the `foo' sequences could be changed to @code{foo} to
begin with.

Cheers,
Ludo=E2=80=99.