From: Bastien <bzg@gnu.org>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>,
"Berry, Charles" <ccberry@ucsd.edu>,
Kaushal Modi <kaushal.modi@gmail.com>
Subject: Re: Missing `Specific Header Arguments' in Manual
Date: Tue, 08 May 2018 10:29:34 +0200 [thread overview]
Message-ID: <87vabyv9ch.fsf@bzg.fr> (raw)
In-Reply-To: 87a7tifcme.fsf@nicolasgoaziou.fr
Hi Nicolas,
Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
> Kaushal Modi <kaushal.modi@gmail.com> writes:
>
>> In the Org 9.1 version manual, it was possible to search ":eval" and find
>> what I was looking for. In 9.2 manual, very few of the header arguments are
>> documented with the colon prefix.
>
> I removed all colon prefixes, so it is a bug if any header argument is
> prefixed with a colon.
Why did you remove colon prefixes?
The colon is part of the header argument, so I'd thought it is natural
to include it in searches.
>> So searching is not consistent any more.
>
> Of course, it is. Now, you can search by topic. E.g., `eval' header
> argument belongs to "Limit Code block evaluation", which is a sub-topic
> of "Evaluation Code Blocks". This was clearly not possible before,
> because unrelated arguments were located in the same section.
>
> You can also search the index alphabetically.
There is a section called "Header arguments" in the new org-manual.org.
The natural expectation is for this section to list all header arguments.
Looking for ":eval" or "eval" in here will bring nothing, which is not
very natural. As Kaushal said, the previous listing, though perhaps
inconsistent, helped discoverability of arguments a lot. (In general,
it is good to have all entities of a kind listed somewhere.)
What can we do to improve the manual here?
--
Bastien
next prev parent reply other threads:[~2018-05-08 8:29 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-01 21:34 Missing `Specific Header Arguments' in Manual Berry, Charles
2018-05-01 21:49 ` Nicolas Goaziou
2018-05-01 22:10 ` Kaushal Modi
2018-05-01 22:31 ` Berry, Charles
2018-05-02 12:47 ` Nicolas Goaziou
2018-05-08 8:29 ` Bastien [this message]
2018-05-08 14:05 ` Nicolas Goaziou
2018-05-08 16:01 ` Bastien
2018-05-08 16:28 ` Nicolas Goaziou
2018-05-01 23:05 ` Berry, Charles
2018-05-02 10:56 ` Nicolas Goaziou
2018-05-02 17:47 ` Berry, Charles
2018-05-08 23:47 ` Nicolas Goaziou
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87vabyv9ch.fsf@bzg.fr \
--to=bzg@gnu.org \
--cc=ccberry@ucsd.edu \
--cc=emacs-orgmode@gnu.org \
--cc=kaushal.modi@gmail.com \
--cc=mail@nicolasgoaziou.fr \
/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/org-mode.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).