From mboxrd@z Thu Jan  1 00:00:00 1970
From: Bastien <bzg@gnu.org>
Subject: Re: Missing `Specific Header Arguments' in Manual
Date: Tue, 08 May 2018 10:29:34 +0200
Message-ID: <87vabyv9ch.fsf@bzg.fr>
References: <8D4BA262-9F3F-412B-8DF1-5F6A6E3E671C@ucsd.edu>
	<87o9hzf3mu.fsf@nicolasgoaziou.fr>
	<CAFyQvY1P1T4M4cLM6S8SoY4J1YTqGoiD4HsL2-hphxZAAu0hLg@mail.gmail.com>
	<87a7tifcme.fsf@nicolasgoaziou.fr>
Mime-Version: 1.0
Content-Type: text/plain
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:44671)
	by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <bzg@gnu.org>)
	id 1fFy0F-0000xJ-5l
	for emacs-orgmode@gnu.org; Tue, 08 May 2018 04:29:44 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <bzg@gnu.org>) id 1fFy0E-0006NG-6F
	for emacs-orgmode@gnu.org; Tue, 08 May 2018 04:29:43 -0400
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/emacs-orgmode/>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: "Emacs-orgmode"
	<emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@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>

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