Re: [frogs] my contribution: barCheckNumber to endSpanners

[ Thread Index | Date Index | More lilynet.net/frogs Archives ]


Graham Percival a écrit :
On Sat, Jan 10, 2009 at 08:12:49AM +0100, Frédéric Bron wrote:
   - I have mainly copied documentation from the Notation Manual. Would be
   better to enter the documentation only once because if the function
   changes, we have to change the doc. at two locations.

Definitely -- but where were these docs from the NR?  Please give
specifics so that we can (probably) delete them from the NR.

I propose to adopt either of the following solutions:

1. Define a macro for each predefined command: the docstring of each function \foo would be stored in a macro named @musicFunctionFoo, which would be used both in the Identifiers page and throughout the manual in "Predefined commands" sections.

2. For each music function, add link from "See also" sections to the Identifiers page, with HTML/PDF anchors made with @nodes.

I'm all for 1: there are already a lot in cross-references in our docs that are necessary, this is difficult enough to read so we should avoid needing them whenever possible. The first solution makes information duplication in the output documentation only, not in the sources.

Cheers,
John

---

----
Join the Frogs!


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/