all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Stefan Kangas <stefan@marxist.se>, Richard Stallman <rms@gnu.org>
Cc: "Mattias Engdegård" <mattiase@acm.org>,
	41006@debbugs.gnu.org, rtm443x@googlemail.com
Subject: bug#41006: 26.3; regular expressions documentation
Date: Tue, 5 May 2020 14:37:30 -0700 (PDT)	[thread overview]
Message-ID: <481d95db-c770-4c03-a7ae-bd5ee154a614@default> (raw)
In-Reply-To: <CADwFkmkdWLOgqkuYDDhWarH51EFbdmYR9X_qbPZoA+gWGmxS7A@mail.gmail.com>

> > 1. Let users who happen to read the manual
> > consecutively learn about _using_ regexps before
> > delving into the detailed reference info about
> > what they are - their syntax, etc.
> 
> Thanks for explaining.  My suggestion was simply to have it all under
> one node: "Regular Expressions".  The idea being that when you go
> there, you probably also want to know how to use them.
> 
> The same goes for the index, IMHO.  But that's just how I imagine the
> manual could be improved.

That's OK too.

It was your problem - you had difficulty finding the
kind of info you were looking for - so the solution
that appeals to you most is likely the best one, at
least for addressing that particular problem.

In that case, in the section an search there'd need
to be some mention the ability to do regexp search,
and xrefs to the relevant "use" sections of the
regexp doc.

My own view favors "Every Page Is Page One"

https://everypageispageone.com/the-book/

Readers will arrive at a given part of the doc any
which way.  (In general, for doc on the web they
arrive from a search-engine search.)

With that perspective, _the_ most important thing
is to have rich, rich, rich linking among related
topics.

Very few of us will sit down and read a manual,
or even a chunk of it, in order, from beginning to
end.

That's not an argument that order/structure doesn't
matter.  It's just an argument for good linking
among related parts.

> > 4. Putting all together physically, in one giant
> > node, is not feasible (especially if you include
> > all the other nodes about "what").  And it's not
> > helpful.
> 
> Agreed, my idea was to have them as subnodes.

OK by me.  Go for it, if it's OK'd.  But please be
sure that the resulting search section still ends
up useful when deprived of the regexp-search stuff.





  reply	other threads:[~2020-05-05 21:37 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-01 19:06 bug#41006: 26.3; regular expressions documentation jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-03  3:40 ` Richard Stallman
2020-05-03 10:31   ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-03 13:07 ` Mattias Engdegård
2020-05-03 14:00   ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-03 20:08   ` Drew Adams
2020-05-03 20:31     ` Stefan Kangas
2020-05-04  1:00       ` Drew Adams
2020-05-05  2:56       ` Richard Stallman
2020-05-05 10:05         ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-05 16:51           ` Mattias Engdegård
2020-05-05 18:20         ` Stefan Kangas
2020-05-05 18:40           ` Drew Adams
2020-05-05 19:04             ` Stefan Kangas
2020-05-05 19:42               ` Drew Adams
2020-05-05 21:23                 ` Stefan Kangas
2020-05-05 21:37                   ` Drew Adams [this message]
2020-05-07  2:40                   ` Richard Stallman
2020-05-09  3:48               ` Richard Stallman
2020-05-07  2:41             ` Richard Stallman
2020-05-07  3:17               ` Drew Adams
2020-05-08  2:51                 ` Richard Stallman
2020-05-07 10:31               ` Stefan Kangas
2020-05-07  2:41           ` Richard Stallman
2020-05-07  3:18             ` Drew Adams
2020-05-07 10:32             ` Stefan Kangas
2020-05-08  2:49               ` Richard Stallman
2020-05-08  6:47                 ` Eli Zaretskii
2020-05-08 10:10                   ` Stefan Kangas
2020-05-08 10:31                     ` Eli Zaretskii
2020-05-08 18:17                       ` Stefan Kangas
2020-05-08 18:47                         ` Eli Zaretskii
2020-05-08 20:09                           ` Stefan Kangas
2020-05-08 10:04                 ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-09  3:56                   ` Richard Stallman
2020-05-08 16:49                 ` Drew Adams
2020-05-09  3:53                   ` Richard Stallman
2020-05-09  3:54                   ` Richard Stallman
2020-05-07  2:41           ` Richard Stallman
2020-05-04  3:10   ` Richard Stallman
2020-05-04  9:13     ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-05  2:56       ` Richard Stallman
2020-05-05 10:02         ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-05 17:12     ` Mattias Engdegård
2020-05-05 17:40       ` Eli Zaretskii
2020-05-05 17:50         ` jan via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-05-05 18:09         ` Stefan Kangas
2020-05-05 18:23           ` Eli Zaretskii
2020-05-07  2:42       ` Richard Stallman
2022-04-29 12:22 ` Lars Ingebrigtsen

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=481d95db-c770-4c03-a7ae-bd5ee154a614@default \
    --to=drew.adams@oracle.com \
    --cc=41006@debbugs.gnu.org \
    --cc=mattiase@acm.org \
    --cc=rms@gnu.org \
    --cc=rtm443x@googlemail.com \
    --cc=stefan@marxist.se \
    /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/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.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.