Re: Documentation: punctuation in menus

[Phil Holmes]

----- Original Message ----- 
From: "Mark Polesky" <address@hidden>
To: "Phil Holmes" <address@hidden>; "David Kastrup" <address@hidden>
Cc: <address@hidden>
Sent: Tuesday, September 10, 2013 5:34 PM
Subject: Re: Documentation: punctuation in menus


Phil Holmes wrote:
> > I understand the issue with colons in node names. That
> > was why I asked this question. I'll ask it again should
> > there be a documentation writer who has had this to deal
> > with before: what do we use for node names when there is
> > punctuation (specifically a colon) in a section heading?

> The @node and @subsection don't have to match. For example,
> in Documentation/included/compile.itexi:
>
> 466 @node Saving time with the -j option
> 467 @subsection Saving time with the @option{-j} option
>
> I may be wrong, but I think you could just do this:
>
> @node Warning key signatures and pitches
> @subsection Warning: key signatures and pitches
>
> - Mark


Thanks Mark (and Trevor).  What I'd not realised, and I now do, is that the 
node name (and thus the name in the @menu list) does not have to bear any 
resemblance to the heading.  If I get rid of the colon from the node name 
and the menu entry, the _actual_ menu text retains the original heading 
text.  Thus the following is perfectly allowable:

@menu
* Rubbish::
@end menu

@node Rubbish
@unnumberedsubsubsec Bar lines

I feel an update to the CG coming on.

--
Phil Holmes