[frogs] Re: IR 3.2.111 doesn't mention 'numbered style

["Carl D. Sorensen" <c_sorensen@xxxxxxx>]

On 1/24/09 12:47 AM, "Mark Polesky" <markpolesky@xxxxxxxxx> wrote:

> IR 3.2.111 time-signature-interface doesn't
> mention the 'numbered style.

This needs to be added to the code, not the documentation, because the IR is
automatically generated.  Would you be willing to take this task on as a
Frog?  You can find the location in the source by using

git grep "are written with two digits"

You could then update the description to something that would be more
correct. 

> Also, on a more
> general level, the default description for
> the "style" property in IR 3 is the same
> for a lot of different grobs, IIRC:
> 
> This setting determines in what style a grob
> is typeset.  Valid choices depend on the
> stencil callback reading this property.
> 
> It would be nice to see more specific entries
> like:

It would be nice to see that, but it's not possible.  There is only one
entry for style, in scm/define-grob-properties.scm.  It must apply anywhere
that style applies.

IR is entirely automatically generated.  No human intervention is involved,
except for creating the main chapter and section headings.

There are two ways that I can see to create object-specific documentation of
style.

First, we can add the documentation of style to the interface documetnation,
as is it currently done.  If one of the interfaces is missing a description
of style, then it should be added to the interface.  This is also a task
that can be done relatively easily by a new Frog.

Second, we can add information to the Notation Reference through the use of
snippets. To demonstrate the usage of all possible styles, a snippet should
be added to the LSR (because \override would be used to set it) that
demonstrates them all.  This snippet would then show up in the NR at the
proper location.

Personally, I think we should make sure to do both.  It would be very
convenient to have snippets in the NR that show all possible uses of style
associated with the grob with which we are concerned.

Do I hear you volunteering to take on this task as a Frog? :-)

Or do I hear any other Frogs volunteering to take on this task?

Thanks,

Carl


---

----
Join the Frogs!