RE: AllAbout Examples

[Anthony Youngman]

I've started writing something on noteheads. This seems to be where it
would fit in perfectly. (I probably ought to add stems and rests to it,
but that can wait :-)

I do feel something like this would be useful. As you say, we currently
have the User Manual (great for getting started) and the Program
Reference (great for technical detail). But there isn't a reference
manual for users.

Just one little point that I've come across with noteheads ... I suspect
this section would be good if you based each piece on a low-level part
of lilypond. Like in my example noteheads. And then include all the
stuff that sits on top, like \setEasyNoteheads which, if I understand
aright, does a host of fancy stuff like changing the notehead engraver,
making fonts larger, etc etc. There's a lot of useful stuff in lily that
is mid-level stuff like this. Often (as with easy noteheads) documented
in its own right when it would make sense to put it with the underlying
concept instead.

-----Original Message-----
From:
address@hidden
[mailto:address@hidden
.org] On Behalf Of Fairchild
Sent: 22 June 2006 19:35
To: 'Graham Percival'; 'Kieren MacMillan'
Cc: 'lilypond-user Mailinglist'
Subject: AllAbout Examples

LilyPond documentation is good.  Newbies get started quickly with the
User
Manual.  Regression Tests and Tips and Tricks contain a wealth of
tutorial
material.  The Program Reference has detail for the initiated.

However, based in my own experience and many postings on
address@hidden, I perceive a need for information that falls
between
content of tutorial and reference documentation -- more detailed than
the
tutorial material and less cryptic than the internals reference.

I propose using the rendered "Examples" section of the documentation
(now
empty) to post a series of AllAbouts, prepared by users, each being an
in-depth example of a narrow set of features: fonts, layout, header,
embedded PostScript, rests, lyrics, tuplets, markup, etc.  (The user
perspective is valuable to identify information found difficult to
extract
from existing documentation.)

(I have good starts at a couple of such examples. One,
AllAboutAlternateScaling.ly is an example demonstrating scaling of
things
entered on staves.
 - - It's primary purpose is to scale cue notes, cadenzas, and alternate
notes.
 - - It includes some Scheme code.
 - - It exposes some unexplained and inconsistent things.
 - - It could be useful as a regression test.
 - - It is intended to be used with jEdit, fixed-width font, tab stops
every
5 characters.)

Please comment on the proposal.  Would AllAbouts be useful to you?
Would
you be willing to contribute?  Who is now responsible for the Examples?
Who
is willing and able to manage postings?

                              - Bruce

-----Original Message-----
From: address@hidden
[mailto:address@hidden On Behalf
Of
Graham Percival
Sent: Thursday, June 08, 2006 6:38 PM
To: Kieren MacMillan
Cc: lilypond-user Mailinglist
Subject: Re: Celebrity Deathmatch: Padding vs. Staff-Padding



On 8-Jun-06, at 6:04 AM, Kieren MacMillan wrote:

>> I'd rather that the example was three systems or less, though.
>
> I can easily make the *basic* example three systems or less.
>
> However, I think (i.e., have recently been thinking) that there should
> be, if possible, examples in (much) more depth -- "articles", really 
> -- and what I've written here was meant to be the start of such an 
> article. I don't know exactly where such a beast would live -- it 
> doesn't really belong in the standard "docs", or the LSR, I think -- 
> but it should be easily accessible. Maybe a Lilypond e-zine (with 
> searchable archive)?

That's what the new chapters 3-5 are for.

We have
- manual
- tricks and tips
- regressions tests
- LSR
- mailist archives
- (lilypond wiki)

The wiki appears to be stagnant, so we can basically cross it off.  But 
that still leaves five places that newbies should ideally look for help 
before sending emails to the mailing lists.  We need to reduce this 
number, not increase it!  I have some ideas for combining tricks, 
regressions, and LSR.  If we can do that (and I do mean "we", since the 
Example Janitor is a necessary part of this), then I'll consider adding 
docs for articles/ezines/blogs/whatever.

Cheers,
- Graham



_______________________________________________
lilypond-user mailing list
address@hidden
http://lists.gnu.org/mailman/listinfo/lilypond-user





_______________________________________________
lilypond-user mailing list
address@hidden
http://lists.gnu.org/mailman/listinfo/lilypond-user

* ************************************************************************ *

This transmission is intended for the named recipient only. It may contain 
private and confidential information. If this has come to you in error you must 
not act on anything disclosed in it, nor must you copy it, modify it, 
disseminate it in any way, or show it to anyone. Please e-mail the sender to 
inform us of the transmission error or telephone ECA International immediately 
and delete the e-mail from your information system.

Telephone numbers for ECA International offices are: Sydney +61 (0)2 8272 5300, 
Hong Kong + 852 2121 2388, London +44 (0)20 7351 5000 and New York +1 212 582 
2333.

* ************************************************************************ *