Document incipit command

Docstring and index entries added

[PhilEHolmes, 2015-05-04 11:27:12]

Please review

[Trevor Daniels, 2015-05-05 11:43:26]

One suggestion, otherwise LGTM.

https://codereview.appspot.com/232180043/diff/1/Documentation/notation/ancien...
File Documentation/notation/ancient.itely (right):

https://codereview.appspot.com/232180043/diff/1/Documentation/notation/ancien...
Documentation/notation/ancient.itely:2651: @funindex incipit
@cindex entries too?

[mail_philholmes.net, 2015-05-05 12:07:32]

----- Original Message ----- 
From: <tdanielsmusic@googlemail.com>
To: <PhilEHolmes@googlemail.com>; <dak@gnu.org>; <pkx166h@gmail.com>
Cc: <reply@codereview-hr.appspotmail.com>; <lilypond-devel@gnu.org>
Sent: Tuesday, May 05, 2015 12:43 PM
Subject: Re: Document incipit command (issue 232180043 
byPhilEHolmes@googlemail.com)


> One suggestion, otherwise LGTM.
>
>
>
https://codereview.appspot.com/232180043/diff/1/Documentation/notation/ancien...
> File Documentation/notation/ancient.itely (right):
>
>
https://codereview.appspot.com/232180043/diff/1/Documentation/notation/ancien...
> Documentation/notation/ancient.itely:2651: @funindex incipit
> @cindex entries too?


I read the CG on *index entries, and experimented a fair amount, but never 
quite got to understand the difference.

Is cindex the Command index only?  Should it be @cindex \incipit or @cindex 
incipit?  Or both? And funindex is the main index, which therefore separates 
the \ entries from the others with alpha sorting?

--
Phil Holmes 

[Trevor Daniels, 2015-05-05 13:09:15]

On 2015/05/05 12:07:32, mail_philholmes.net wrote:

> I read the CG on *index entries, and experimented a fair amount, but never 
> quite got to understand the difference.
> 
> Is cindex the Command index only?  Should it be @cindex \incipit or @cindex 
> incipit?  Or both? And funindex is the main index, which therefore separates 
> the \ entries from the others with alpha sorting?

It is a bit of a mess, but we never agreed on the best way to sort it out.

cindex is the Concept index and feeds into App E - the general index - only.
funindex feeds into the command index, App D, and also into the "\" section of
App E.

(Correct me if that's wrong - I'm relying on a 4-year old memory here.)

Anyway, we decided to continue to add more rather than fewer index entries so if
we ever decided to separate them some other way we'd have all the entries
available.

So in addition to your two entries I would suggest adding

@cindex incipits, adding

or some such.

Trevor

[dak, 2015-05-05 13:20:02]

On 2015/05/05 13:09:15, Trevor Daniels wrote:
> On 2015/05/05 12:07:32, http://mail_philholmes.net wrote:
> 
> > I read the CG on *index entries, and experimented a fair amount, but never 
> > quite got to understand the difference.
> > 
> > Is cindex the Command index only?  Should it be @cindex \incipit or @cindex 
> > incipit?  Or both? And funindex is the main index, which therefore separates

> > the \ entries from the others with alpha sorting?
> 
> It is a bit of a mess, but we never agreed on the best way to sort it out.

The best way to sort this out, I think, was to fix the !@#$ index generation in
Texinfo.  Now that Texinfo 5 has presumably been rewritten in Perl, maybe we
should try bringing this up on the Texinfo mailing list again.

The basic topic is to have a way to get \xyz sorted under X.  In older versions
of Texinfo, at least the TeX version of the index was generated by running the
"texindex" program (which is, hard to know from its name, quite specific to
Texinfo in contrast to the general-purpose "makeindex" program).

[dak, 2015-05-05 13:22:56]

On 2015/05/05 13:09:15, Trevor Daniels wrote:
> On 2015/05/05 12:07:32, http://mail_philholmes.net wrote:
> 
> > I read the CG on *index entries, and experimented a fair amount, but never 
> > quite got to understand the difference.
> > 
> > Is cindex the Command index only?  Should it be @cindex \incipit or @cindex 
> > incipit?  Or both? And funindex is the main index, which therefore separates

> > the \ entries from the others with alpha sorting?
> 
> It is a bit of a mess, but we never agreed on the best way to sort it out.

The best way to sort this out, I think, was to fix the !@#$ index generation in
Texinfo.  Now that Texinfo 5 has presumably been rewritten in Perl, maybe we
should try bringing this up on the Texinfo mailing list again.

The basic topic is to have a way to get \xyz sorted under X.  In older versions
of Texinfo, at least the TeX version of the index was generated by running the
"texindex" program (which is, hard to know from its name, quite specific to
Texinfo in contrast to the general-purpose "makeindex" program).

[mail_philholmes.net, 2015-05-05 14:59:28]

----- Original Message ----- 
From: <tdanielsmusic@googlemail.com>

> So in addition to your two entries I would suggest adding
>
> @cindex incipits, adding
>
> or some such.
>
> Trevor


OK - done that on my local copy here.  It compiles fine, so I'm not 
proposing to upload it for further review.

--
Phil Holmes