unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: Glenn Morris <rgm@gnu.org>
Cc: 45143@debbugs.gnu.org
Subject: bug#45143: Incorrect markup in some doc/misc manuals
Date: Sun, 21 Feb 2021 01:15:25 -0500	[thread overview]
Message-ID: <E1lDi1d-0004le-LW@fencepost.gnu.org> (raw)
In-Reply-To: <s68s7kd2gd.fsf@fencepost.gnu.org> (message from Glenn Morris on Fri, 19 Feb 2021 00:57:38 -0500)

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

Theis problem is in doc/misc/modus-themes.texi,
but I suspect that doc/misc/org.texi has it too.

The problem is that the file uses the wrong Texinfo markup in some
places.  I suspect that the source markup language, from which this
Texinfo text is generated, doesn't have the ability to make all the
distinctions Texinfo needs.


Here's an example from modus-themes.texi:

    Prior to querying any package archive, make sure to have updated the
    index, with @samp{M-x package-refresh-contents}.  Then all you need to do is
    type @samp{M-x package-install} and specify the theme of your choice.

@samp is incorrect here.  If it is M-x package-install RET, that is
keyboard input so it ashould be written in @kbd.  On the other hand,
package-install without M-x and RET is a command name and should be
inside @code.

Later on:

    If you set @samp{calendar-latitude} and @samp{calendar-longitude} (defined in the
    built-in @samp{solar.el} library---read it with @samp{M-x find-library}), you c

calendar-longitude is a symbol; it should be in @code.
solar.el is a file name; it should be in @file.

    The symbols ``subtle'' and ``intense'' will apply a combination of accented

Those symbol names should be in @code, not doublequotes.





-- 
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)







  parent reply	other threads:[~2021-02-21  6:15 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-09 17:41 bug#45143: Missing source for some doc/misc manuals? Glenn Morris
2020-12-15 18:17 ` Glenn Morris
2021-01-31 21:47   ` Glenn Morris
2021-02-17  5:40     ` bug#45143: Missing source for some doc/misc manuals (moral-issue) Glenn Morris
2021-02-17  8:45       ` Robert Pluim
2021-02-17 14:27         ` Basil L. Contovounesios
2021-02-17 14:41           ` Robert Pluim
2021-02-17 16:09             ` Eli Zaretskii
2021-02-17 16:15               ` Robert Pluim
2021-02-17 17:28                 ` Eli Zaretskii
2021-02-19  5:34       ` Richard Stallman
2021-02-19  5:57         ` Glenn Morris
2021-02-21  6:15           ` Richard Stallman
2021-02-21  6:15           ` Richard Stallman [this message]
2021-02-21 11:01             ` bug#45143: Incorrect markup in some doc/misc manuals Protesilaos Stavrou
2021-02-22  6:22               ` Richard Stallman
2021-02-22 16:38                 ` Protesilaos Stavrou
2021-02-24  7:38                   ` Protesilaos Stavrou
2021-02-24 15:13                     ` Eli Zaretskii
2021-02-25  6:04                       ` Protesilaos Stavrou
2021-02-25 14:40                         ` Eli Zaretskii
2021-02-27  3:49                           ` Glenn Morris
2021-02-27  3:55                             ` Glenn Morris
2021-02-27  6:29                             ` Protesilaos Stavrou
2021-02-21 20:11             ` Eli Zaretskii
2021-02-24  6:49               ` Richard Stallman
2021-02-24 15:09                 ` Eli Zaretskii
2021-02-26  6:32                   ` Richard Stallman
2021-02-26  7:45                     ` Eli Zaretskii
2021-02-27 16:14                       ` Richard Stallman
2021-02-27 18:20                         ` Eli Zaretskii
2021-03-01  5:18                           ` 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=E1lDi1d-0004le-LW@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=45143@debbugs.gnu.org \
    --cc=rgm@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).