emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>,
	"Berry, Charles" <ccberry@ucsd.edu>
Subject: Re: Missing `Specific Header Arguments' in Manual
Date: Wed, 02 May 2018 14:47:21 +0200	[thread overview]
Message-ID: <87a7tifcme.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAFyQvY1P1T4M4cLM6S8SoY4J1YTqGoiD4HsL2-hphxZAAu0hLg@mail.gmail.com> (Kaushal Modi's message of "Tue, 01 May 2018 22:10:48 +0000")

Hello,

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.

> 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.

> I was able to do this earlier.. open Org Info manual, C-s :eval, keep on
> C-s as it found *all hits* in the manual. Now in 9.2, the only hits are in
> (org) Exporting Code Blocks, which is not very useful.

C-s is a poor way to navigate through an Info document. I'd rather
improve the index than make it easier to use C-s.

> Can we prefix all the header arg references in the manual with ":" so
> that while searching, I can easily find the (org) Evaluating Code
> Blocks node?

This is a false good idea, because many index entries would have the
same prefix. Besides, many syntactic elements start with colons:
properties, tags, drawers.

OTOH, you can search for "header argument" in the main index, as you
experienced. It is much more efficient.

> I was having trouble finding this node as "eval" is too generic of a string..
> thankfully I remembered the "never-export" value, searched for that and
> found that node.

See above.

Regards,

-- 
Nicolas Goaziou

  parent reply	other threads:[~2018-05-02 12:47 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 [this message]
2018-05-08  8:29       ` Bastien
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=87a7tifcme.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=ccberry@ucsd.edu \
    --cc=emacs-orgmode@gnu.org \
    --cc=kaushal.modi@gmail.com \
    /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).