* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
@ 2009-07-09 21:19 Drew Adams
2011-07-12 15:24 ` Lars Magne Ingebrigtsen
0 siblings, 1 reply; 10+ messages in thread
From: Drew Adams @ 2009-07-09 21:19 UTC (permalink / raw)
To: emacs-pretest-bug
I tried looking for the place in the Emacs manual where the notation
for key sequences (the one used in the doc) is described. I tried
`notation' and found there was only one match:
`gdb-use-colon-colon-notation'. Users should be able to find this by
looking for terms such as `notation' and `conventions'.
In GNU Emacs 23.0.96.1 (i386-mingw-nt5.1.2600)
of 2009-07-09 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2009-07-09 21:19 bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation" Drew Adams
@ 2011-07-12 15:24 ` Lars Magne Ingebrigtsen
2011-07-12 16:27 ` Drew Adams
0 siblings, 1 reply; 10+ messages in thread
From: Lars Magne Ingebrigtsen @ 2011-07-12 15:24 UTC (permalink / raw)
To: Drew Adams; +Cc: bugs, 3801
"Drew Adams" <drew.adams@oracle.com> writes:
> I tried looking for the place in the Emacs manual where the notation
> for key sequences (the one used in the doc) is described. I tried
> `notation' and found there was only one match:
> `gdb-use-colon-colon-notation'. Users should be able to find this by
> looking for terms such as `notation' and `conventions'.
In what circumstances does Emacs talk about notations for key sequences?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 15:24 ` Lars Magne Ingebrigtsen
@ 2011-07-12 16:27 ` Drew Adams
2011-07-12 17:51 ` Eli Zaretskii
0 siblings, 1 reply; 10+ messages in thread
From: Drew Adams @ 2011-07-12 16:27 UTC (permalink / raw)
To: bugs; +Cc: 3801
> > I tried looking for the place in the Emacs manual where the notation
> > for key sequences (the one used in the doc) is described. I tried
> > `notation' and found there was only one match:
> > `gdb-use-colon-colon-notation'. Users should be able to find this by
> > looking for terms such as `notation' and `conventions'.
>
> In what circumstances does Emacs talk about notations for key
> sequences?
The conventions used in the doc should be described. They are, for the Elisp
manual: see node `Conventions' and its subnodes. See how detailed those nodes
are, and how well they explain the notations used in the Elisp manual.
The Emacs manual should also describe the notations it uses. In particular,
key-sequence notation.
There should be a description of how the manual indicates key sequences,
including for different kinds of keys (e.g. angle-bracket notation vs no angle
brackets).
If there is not yet such a desciption, it should be added. And then it should
be indexed (this bug report).
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 16:27 ` Drew Adams
@ 2011-07-12 17:51 ` Eli Zaretskii
2011-07-12 19:35 ` Lars Magne Ingebrigtsen
2011-07-12 20:25 ` Drew Adams
0 siblings, 2 replies; 10+ messages in thread
From: Eli Zaretskii @ 2011-07-12 17:51 UTC (permalink / raw)
To: Drew Adams; +Cc: bugs, 3801
> From: "Drew Adams" <drew.adams@oracle.com>
> Date: Tue, 12 Jul 2011 09:27:55 -0700
> Cc: 3801@debbugs.gnu.org
>
> There should be a description of how the manual indicates key sequences,
> including for different kinds of keys (e.g. angle-bracket notation vs no angle
> brackets).
I think you are looking for "User Input" and "Keys" nodes.
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 17:51 ` Eli Zaretskii
@ 2011-07-12 19:35 ` Lars Magne Ingebrigtsen
2011-07-12 20:25 ` Drew Adams
2011-07-12 20:25 ` Drew Adams
1 sibling, 1 reply; 10+ messages in thread
From: Lars Magne Ingebrigtsen @ 2011-07-12 19:35 UTC (permalink / raw)
To: 3801
Eli Zaretskii <eliz@gnu.org> writes:
> I think you are looking for "User Input" and "Keys" nodes.
Yes, I can't remember "notation" as a word people use for keys.
Closing this bug report.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 19:35 ` Lars Magne Ingebrigtsen
@ 2011-07-12 20:25 ` Drew Adams
0 siblings, 0 replies; 10+ messages in thread
From: Drew Adams @ 2011-07-12 20:25 UTC (permalink / raw)
To: 'Lars Magne Ingebrigtsen', 3801
> > I think you are looking for "User Input" and "Keys" nodes.
>
> Yes, I can't remember "notation" as a word people use for keys.
>
> Closing this bug report.
It's not about anyone using "notation" as a word for keys.
It's about being able to easily locate the notational conventions we use in our
manuals.
As I said, contrast the case of the Elisp manual.
In the Elisp manual too we should probably add "notational conventions" as an
index entry, in addition to the existing entry "typographical conventions"
(which takes you to node `Some Terms', a subnode of node `Conventions').
But in that manual (Elisp) things are much clearer because of this top-level
table of contents entry:
`Conventions' - How the manual is formatted
There is no similar organization for the Emacs manual, and consequently it is
more difficult to find a presentation of "how the manual is formatted".
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 17:51 ` Eli Zaretskii
2011-07-12 19:35 ` Lars Magne Ingebrigtsen
@ 2011-07-12 20:25 ` Drew Adams
2011-07-12 20:33 ` Eli Zaretskii
1 sibling, 1 reply; 10+ messages in thread
From: Drew Adams @ 2011-07-12 20:25 UTC (permalink / raw)
To: 'Eli Zaretskii'; +Cc: bugs, 3801
> > There should be a description of how the manual indicates
> > key sequences, including for different kinds of keys (e.g.
> > angle-bracket notation vs no angle brackets).
>
> I think you are looking for "User Input" and "Keys" nodes.
Yes and no. Yes, those nodes speak about keys, and they _use_ the notational
conventions defined for the manual.
But no, those nodes do not _present_ (introduce, describe, explain) the
notational conventions that are used.
I don't see any place in the Emacs manual where we introduce the notational
conventions used. Contrast that with the Elisp manual, where we go into quite a
bit of detail about the notation used in the manual.
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 20:25 ` Drew Adams
@ 2011-07-12 20:33 ` Eli Zaretskii
2011-07-12 21:16 ` Drew Adams
0 siblings, 1 reply; 10+ messages in thread
From: Eli Zaretskii @ 2011-07-12 20:33 UTC (permalink / raw)
To: Drew Adams; +Cc: bugs, 3801
> From: "Drew Adams" <drew.adams@oracle.com>
> Cc: <bugs@gnus.org>, <3801@debbugs.gnu.org>
> Date: Tue, 12 Jul 2011 13:25:10 -0700
>
> I don't see any place in the Emacs manual where we introduce the notational
> conventions used.
Right. It doesn't do that.
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 20:33 ` Eli Zaretskii
@ 2011-07-12 21:16 ` Drew Adams
2011-07-13 2:53 ` Eli Zaretskii
0 siblings, 1 reply; 10+ messages in thread
From: Drew Adams @ 2011-07-12 21:16 UTC (permalink / raw)
To: 'Eli Zaretskii'; +Cc: bugs, 3801
> > I don't see any place in the Emacs manual where we
> > introduce the notational conventions used.
>
> Right. It doesn't do that.
Glad we agree. That's the bug. Please introduce the conventions and then index
that doc.
^ permalink raw reply [flat|nested] 10+ messages in thread
* bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation"
2011-07-12 21:16 ` Drew Adams
@ 2011-07-13 2:53 ` Eli Zaretskii
0 siblings, 0 replies; 10+ messages in thread
From: Eli Zaretskii @ 2011-07-13 2:53 UTC (permalink / raw)
To: Drew Adams; +Cc: 3801-done, bugs
> From: "Drew Adams" <drew.adams@oracle.com>
> Cc: <bugs@gnus.org>, <3801@debbugs.gnu.org>
> Date: Tue, 12 Jul 2011 14:16:23 -0700
>
> > > I don't see any place in the Emacs manual where we
> > > introduce the notational conventions used.
> >
> > Right. It doesn't do that.
>
> Glad we agree. That's the bug.
Not necessarily. It's marked "notabug".
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2011-07-13 2:53 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-07-09 21:19 bug#3801: 23.0.96; Emacs manual: add index entry for "notation, keys" or "key notation" Drew Adams
2011-07-12 15:24 ` Lars Magne Ingebrigtsen
2011-07-12 16:27 ` Drew Adams
2011-07-12 17:51 ` Eli Zaretskii
2011-07-12 19:35 ` Lars Magne Ingebrigtsen
2011-07-12 20:25 ` Drew Adams
2011-07-12 20:25 ` Drew Adams
2011-07-12 20:33 ` Eli Zaretskii
2011-07-12 21:16 ` Drew Adams
2011-07-13 2:53 ` Eli Zaretskii
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).