Am Sonntag, 2. Jänner 2022, 01:06:35 CET schrieb David Kastrup:
> Jean Abou Samra <jean@abou-samra.fr> writes:
> > Hi all,
> >
> > There is an ongoing proposal to add syntax highlighting
> > in LilyPond's documentation. Since it is a notable change
> > to the documentation reading experience, user feedback would
> > be appreciated. You can browse a syntax-highlighted version
> > of the notation manual here:
> >
> > http://abou-samra.fr/highlighting-demo/notation/index.html
> >
> > For comparison, this is the current notation manual:
> >
> > https://lilypond.org/doc/v2.23/Documentation/notation/index.html
> >
> > The main questions are: what do you think of the principle?
> > And is the color scheme good enough?
>
> I just followed the discussion without much attention because I did not
> think that it would affect me whether or not there was syntax
> highlighting. That probably was a mistake. Taking a random example:_______________________________________________
lilypond-user mailing list
lilypond-user@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-user
In general, I think syntax highlighting is a good idea.
However, I would say that the backslash prefix already provides a level of baked-in syntactic self-highlighting. Using color to reinforce anything with a backslash seems unnecessary, and potentially dilutes the opportunities to have a meaningful palette, since a smaller palette is easier to comprehend.
I'm not sure the distinction between categories of things like \layout, \override, and \relative is what adds value.
However, I will say that if it is possible to tag it as such, we should. It is better to have the ability to style against it in case someone wants to customize it. It is easy enough to have the default styling show them all the same if that ends up being what is desired.
What I do find useful is the coloring of reserved words, such as objects like Staff, properties like baseMoment, string literals, bare words that are expected arguments, like volta, and clef names.
In this sense, it seems like the place that has the most potential use for helping people distinguish different data types is where the syntax is the most complicated and dense, which is in music entry.
The ability to quickly distinguish articulations, dynamics, notes, and durations seems like it would probably be most useful to people reading examples in docs, since that is the most unusual aspect of lilypond syntax.
Thanks,
Producer ~ Composer ~ Instrumentalist ~ Educator
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-