unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Cecilio Pardo <cpardo@imayhem.com>
To: rms@gnu.org
Cc: arne_bab@web.de, emacs-devel@gnu.org
Subject: Re: Colorizing source code in Info manuals
Date: Wed, 11 Dec 2024 12:01:26 +0100	[thread overview]
Message-ID: <c080d342-d948-47a5-98b1-1cf49d1cb30a@imayhem.com> (raw)
In-Reply-To: <E1tLEPW-0000nK-A8@fencepost.gnu.org>

On 11/12/2024 5:33, Richard Stallman wrote:

>    > I think some 'cheap' changes in info, such as the presentation of source
>    > code and emacs key sequences, in my unqualified opinion, are worth the
>    > effort at this point.
> 
> Would you please say specifically what extensions you're suggesting?
> How would one use them?  What jobs would they do?


I suggest modifying makinfo to generate markers around certain text in 
its Info output, so that we can find them (with lisp) and change text 
properties.

Those markers can be implemented using the construct that is used for 
images and indices, as Eli suggested.
They are ignored by the standalone Info viewer when they are not 
recognized, so it will not be affected.

We would put them around some commands, like:

@kbd @key @code @example

For @code, @kbd and @key, Emacs Info reader keeps the standard font, and 
ads quotes around it, making them in my opinion even harder to read.

If you look at "A note for novices" on the Emacs lisp intro, which show 
many keys in the text, I think it its obvious that readability can be 
improved just by applying a different face to them.

This is the starting line from 1.1 Lisp lists, on the Lisp intro:

   In Lisp, a list looks like this: ‘'(rose violet daisy buttercup)’.

Would much easier without the quotes, and with a different face.

And for the @example command, we can colorize the code according to the 
language. Also add some tricks like a button to copy the example.











  reply	other threads:[~2024-12-11 11:01 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-05 22:06 Colorizing source code in Info manuals Cecilio Pardo
2024-12-05 22:33 ` Dr. Arne Babenhauserheide
2024-12-06  0:31   ` Arsen Arsenović
2024-12-06  8:39   ` Cecilio Pardo
2024-12-08  5:17     ` Richard Stallman
2024-12-08 18:08       ` Cecilio Pardo
2024-12-08 19:58         ` Björn Bidar
2024-12-11  4:33         ` Richard Stallman
2024-12-11 10:41           ` Cecilio Pardo
2024-12-11  4:33         ` Richard Stallman
2024-12-11 11:01           ` Cecilio Pardo [this message]
2024-12-06  7:38 ` Eli Zaretskii
2024-12-06  8:52   ` Cecilio Pardo
2024-12-06 11:42     ` Eli Zaretskii
2024-12-09  4:56 ` Richard Stallman

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=c080d342-d948-47a5-98b1-1cf49d1cb30a@imayhem.com \
    --to=cpardo@imayhem.com \
    --cc=arne_bab@web.de \
    --cc=emacs-devel@gnu.org \
    --cc=rms@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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).