[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
LSR -> lilypond docs
LSR -> lilypond docs
Fri, 09 Nov 2007 21:02:42 -0800
Thunderbird 184.108.40.206 (X11/20071022)
LSR finally has tags, so it's time to describe how LSR and the lilypond
docs are linked.
I seem to be incredibly bad at describing this, so bear with me. I've
described it to the devel team at least three times, and they're a lot
more familiar with our source tree than anybody else. But let's try it
anyway. (if you're familiar with the previous LSR->lilypond stuff, this
is exactly the same, except snippets can have multiple tags instead of
I'm reserving this subject for describing the actual link. Discussion
about what this means for the exact tags in LSR and writing the docs (in
particular, the @commonprop sections) will go in a separate subject.
Open up a web browser, and go to LSR:
Type in "rhythms" in the search. This gives you a relatively short list
of snippets tagged with "rhythms".
Now open up a new browser window, and go to the GDP docs:
Go to the Notation Reference, and look at 1.2.1 Writing rhythms:
Tuplets. Scroll down to the bottom. Click on the
See the similarity in the examples?
NB: the snippets currently display may or may not remain there -- we
still need to decide which kinds of snippets to include in this. Also,
it's possible that some of these snippets are broken. This is just a
quick tech demo, not the final product by any means.
LSR snippets that are tagged with "rhythms" and "docs" are magically
added to our docs every so often. If a snippet is updated in LSR, it's
updated in our docs. If it's removed from LSR, it's removed from our
docs. This process only takes a few minutes, and it's easy for any
developer to do.
LSR snippets tagged with "rhythms" but not "docs" are not included in
this. This means that LSR can have a whole bunch of "rhythms" snippets,
of which only a subset will be added to the main docs.
These snippets are available as a PDF as well; go to the main GDP page
and follow the "Snippets" link.
The LSR->lilypnod docs link has the potential to simplify the Doc
Editor's job -- snippets may be added or updated without the need to
edit texinfo files in git. Any new (or updated) snippet must be
approved by the LSR editor, so there is still some quality control for this.
- LSR -> lilypond docs,
Graham Percival <=