all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: Christian Miller <christian.miller@dadoes.de>
Cc: guix-devel@gnu.org
Subject: Re: Add anchors in HTML documentation
Date: Wed, 22 Nov 2023 22:30:04 +0100	[thread overview]
Message-ID: <87bkbliihv.fsf@gnu.org> (raw)
In-Reply-To: <87bkbtv42g.fsf@dadoes.de> (Christian Miller's message of "Thu, 16 Nov 2023 21:25:11 +0100")

Hi,

Christian Miller <christian.miller@dadoes.de> skribis:

> it would be a nice feature to have actual anchors in the HTML
> documentation.  I mean with that, that there is an anchor symbol which
> upon clicking, copies the exact URL to this section in the HTML
> documentation.
>
> This is useful, since currently I always need to go to the top of the
> documentation (Table of Contents) to grab the URL that jumps to the
> corresponding section, which I paste in the #Guix IRC channel as
> pointer on how to do specifc things.
>
> Can we maybe even do this not only for whole sections, but also for
> things like "console-font-service-type".  For example if someone asks
> how to install TTY fonts.

There are anchors for index entries, but you typically need to jump to
<https://guix.gnu.org/manual/devel/en/html_node/Programming-Index.html>
to get the link, or to click on the symbol in a code snippet.

I agree that anchor symbols in the text would help.  We’d need to tweak
the Texinfo output and/or use @anchor more frequently in the Texinfo
source of the manual.

Thanks,
Ludo’.


  reply	other threads:[~2023-11-22 21:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-16 20:25 Add anchors in HTML documentation Christian Miller
2023-11-22 21:30 ` Ludovic Courtès [this message]
2023-11-29 19:07   ` Christian Miller
2023-12-09  9:28     ` Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87bkbliihv.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=christian.miller@dadoes.de \
    --cc=guix-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.