Re: Your Friendly Neighborhood LSR

[Graham Percival]

Valentin Villenave wrote:
> 2007/11/27, Rune Zedeler <address@hidden>:
>
> Hi Rune,
>
> > Valentin Villenave skrev:
> >
> > >     --> First rule of LSR is: do not add a \version line.
> > >     --> Second rule of LSR is: do NOT add a \version line.
> > What is the reason for this?
>
> The snippets are supposed to be *all* compatible with the latest
> stable version.

Leaving that aside, any \version line would be automatically updated 
whenever we update lilypond on LSR -- convert-ly would replace all the 
old \version lines.

I wouldn't be opposed to adding a
        % added in 2.8.6
comment to snippets, though.

> If one wish to demonstrate a new bleeding-edge feature
> from the development branch, one has to comment all the non-stable
> code, and mark it as "version-specific". It's that simple.
>
> The reason why I'm doing this is that otherwise we would even *not*
> accept non-stable snippets at all (I had to convince Graham that we
> needed those, and I don't know if I have convinced him yet).

No, I'm still not convinced.  The examples won't show the things they 
claim to show (since it's all commented out).  input/new/*/foo.ly  is a 
much better place to put all those snippets, since they _will_ render 
correctly.

But this is your decision, so let you make your own mistake here.  :)


> > Automatically commenting out version lines - and automatically
> > complaining if the snippet asks for a wrong version - should be quite
> > simple.
>
> Mmm... This might be a good idea. I'll submit it to Graham and
> Sebastiano; however IMHO this wouldn't be very much useful; as I've
> explained above, snippets are not meant to be ever old.

No code is "meant" to be old, but it happens.  Trust me, I've been doing 
the docs for over three years.  That doesn't sound like a lot, but in 
lilypond-years, that's a huge change.


> > The tagging is great, of course :-)
> > You did not really write anything about how far the implementation has
> > gone. afaics you are unable to search on the tags - or use them in any
> > way. What are the plans for this?
>
> However, as soon as I finish tagging the
> snippets, I think we'll remove the "directory" search, and replace it
> with "tag" search.

By "I think we'll", Valentin means "we will definitely"


> 2007/11/27, Mats Bengtsson <address@hidden>:
>
> Hi Mats,
>
> > I have some similar thoughts. I definitely think that the .ly code shown
> > when
> > you click on a snippet should include a \version line (even if it isn't
> > stored
> > internally in the database). This is crucial information for the end
> > user, who
> > maybe isn't always using the latest version (or has already updated to an
> > unstable version) and doesn't realize why a snippet doesn't work as
> > expected. Also, it's not easy to find information the LSR web pages on
> > what version you are currently using. The only place I could find is under
> > "Contributing", which is not a place where an end user is expected to look.

I agree.  Storing a \version in the database would be pointless, but 
this info should be more visible for users.  If nothing else, it helps 
to drive home the point that every single .ly file should have a \version.

My only concern is making it clear to omit the \version "" when they add 
snippets.  One solution is to let the backend handle this -- let uses 
enter \version "2.10.12" if they want, but have the backend remove that 
line before storing the snippet in the database.

Cheers,
- Graham