From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id EGlOBnG9jF/DXwAA0tVLHw (envelope-from ) for ; Sun, 18 Oct 2020 22:10:57 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id 8AYWAnG9jF/3AgAAB5/wlQ (envelope-from ) for ; Sun, 18 Oct 2020 22:10:57 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 860BB9402A7 for ; Sun, 18 Oct 2020 22:10:56 +0000 (UTC) Received: from localhost ([::1]:50050 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kUGtD-0003Dk-8I for larch@yhetil.org; Sun, 18 Oct 2020 18:10:55 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53440) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kUGsv-0003Dd-A1 for guix-devel@gnu.org; Sun, 18 Oct 2020 18:10:37 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:50729) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kUGsv-0003vL-0N for guix-devel@gnu.org; Sun, 18 Oct 2020 18:10:37 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=43316 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1kUGst-00077a-TN for guix-devel@gnu.org; Sun, 18 Oct 2020 18:10:36 -0400 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: guix-devel Subject: More links in the HTML manual X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 27 =?utf-8?Q?Vend=C3=A9miaire?= an 229 de la =?utf-8?Q?R=C3=A9volution?= X-PGP-Key-ID: 0x090B11993D9AEBB5 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 3CE4 6455 8A84 FDC6 9DB4 0CFB 090B 1199 3D9A EBB5 X-OS: x86_64-pc-linux-gnu Date: Mon, 19 Oct 2020 00:10:34 +0200 Message-ID: <87k0vn2nj9.fsf@inria.fr> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list 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+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Spam-Score: -1.51 X-TUID: GiBxdkeS0jrj Hi Guix! I pushed the following changes to the post-processing code for the on-line HTML copies of the manual: --8<---------------cut here---------------start------------->8--- f54149062e doc: cookbook: Balance parens in custom kernel examples. 97ce30cc1b doc: Generate cross-references in code snippets to the Guile man= ual. db1d445357 doc: Allow code snippets in the cookbook to link to the manual. 0f7d0743ed doc: Move manual index creation to a separate derivation. --8<---------------cut here---------------end--------------->8--- This improves links for identifiers that appear in code snippets in two ways: 1. The cookbook now has links in its code snippets too (previously only the manual had that those). 2. Both the manual and cookbook link to the Guile manual. For instance, you can click on =E2=80=98cons=E2=80=99, =E2=80=98string-app= end=E2=80=99, etc. and that will lead you to their reference in the manual. Examples: https://guix.gnu.org/cookbook/de/html_node/Ein-Hallo_002dWelt_002dPaket.h= tml https://guix.gnu.org/manual/devel/en/html_node/Build-Utilities.html https://guix.gnu.org/manual/devel/fr/html_node/Utiliser-le-systeme-de-con= figuration.html Note that the link remain honor the current language and mono/split-node mode. Since this matches by string, there are a few false positives: =E2=80=98ver= sion=E2=80=99 links to the =E2=80=98version=E2=80=99 procedure (even though it=E2=80=99s = the name of the field), =E2=80=98method=E2=80=99 links to a section about GOOPS, = =E2=80=98bind=E2=80=99 links to the =E2=80=98bind=E2=80=99 procedure (in an example where it refers to t= he package), the identifier =E2=80=98system=E2=80=99 in (use-modules (gnu system)) links= to the =E2=80=98system=E2=80=99 procedure, and so on. To improve on that, we=E2=80=99d need to hook into psyntax or something and we=E2=80=99re very far from that. :-) But I think it=E2=80=99s acceptable, and probably helpful to newcomers. Wh= at would be problematic is if =E2=80=98remove=E2=80=99 would point to =E2=80= =98remove=E2=80=99 in the =E2=80=9Crnrs base=E2=80=9D section of the Guile manual, for example, but it seems we don= =E2=80=99t have anything like that. Now we need more examples in the manual! Ludo=E2=80=99.