From: Eli Zaretskii <eliz@gnu.org>
To: rms@gnu.org
Cc: drew.adams@oracle.com, emacs-devel@gnu.org
Subject: Re: Indentation conventions for Info manuals; recognizing code
Date: Mon, 08 Mar 2021 15:57:00 +0200 [thread overview]
Message-ID: <83k0qhsq8j.fsf@gnu.org> (raw)
In-Reply-To: <E1lJ8a1-0000NR-Nl@fencepost.gnu.org> (message from Richard Stallman on Mon, 08 Mar 2021 00:37:21 -0500)
> From: Richard Stallman <rms@gnu.org>
> Date: Mon, 08 Mar 2021 00:37:21 -0500
> Cc: emacs-devel@gnu.org
>
> > But other manuals don't seem to use the same indentation. Several
> > (org, eintr, ccmode, efaq(-w32),...) indent code (including Elisp)
> > 5 spaces - which is the same amount that other, non-code text is
> > indented.
>
> Aside from eintr, I don't know anything specific about those manuals.
>
> The eintr manual was written by Bob Chassell; I presume it is still
> generated from Texinfo, right? So I find it puzzling that it produces
> a different format in the Info file.
>
> Why does it do that? Is the source formatted in an unusual way? Does
> it somehow specify different parameters for generating the Info file?
Neither eintr nor any other manual do anything special with @code.
It's an illusion. The actual indentation of a code snippet in the
Info output is determined not only by the immediate Texinfo source,
but also by the surrounding context. The Introduction manual is
written as a book, so @code blocks there are inserted in regular text,
and the indentation of @code there is the original 5-space
indentation. By contrast, most other manuals are written as reference
manuals, and thus are full of @table's, @defun's, etc., and the @code
blocks there are more often than not part of those environments. So
the indentation of @code in those other manuals starts at the
indentation of the innermost environment and not at the left margin.
That's all.
next prev parent reply other threads:[~2021-03-08 13:57 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-07 1:58 Indentation conventions for Info manuals; recognizing code Drew Adams
2021-03-07 6:33 ` Eli Zaretskii
2021-03-08 3:47 ` [External] : " Drew Adams
2021-03-08 5:49 ` Yuri Khan
2021-03-08 14:07 ` Eli Zaretskii
2021-03-08 15:33 ` Drew Adams
2021-03-08 5:37 ` Richard Stallman
2021-03-08 13:57 ` Eli Zaretskii [this message]
2021-03-08 15:33 ` [External] : " Drew Adams
-- strict thread matches above, loose matches on Subject: below --
2021-03-08 9:51 tydrdn
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=83k0qhsq8j.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=drew.adams@oracle.com \
--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).