bug-lilypond
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: NR A.10 Markup commands list review


From: James
Subject: Re: NR A.10 Markup commands list review
Date: Mon, 01 Sep 2014 18:34:40 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.0

On 31/08/14 13:04, Simon Albrecht wrote:
Hello,

upon reading the list of markup commands in the NR, I noticed several issues, which I’d like to report. I apologize for not making a patch myself; firstly, I have been uncertain at some points, secondly others are more apt at English phrasing, and also I’m not yet familiar with the process.

Well this appendix is auto-generated not directly like the bulk of the NR just a bunch of TexInfo files. The information is extracted directly from the core *.scm or *.ly files (or similar), so it is not just a case of editing the page of the NR as it looks directly. You would have to look at each command in its context in whatever associated file it resides in and make the edits there.

While not especially complicated if you know where to edit, it can be time consuming.


The most extensive issue is that with most commands, no unit of measurement is given for certain arguments, leaving the user to guess (I guess that it’s usually staff spaces, but I’m not sure…). These commands are the following: (sometimes I add the number of arguments concerned in brackets; for */** see below)
FONT SECTION
– \abs-fontsize (of course the unit is 1pt)
ALIGN
– \fill-with-pattern (1)
– \general-align (*)
– \halign (*)
– \hcenter-in
– \hspace
– \lower
– \pad-around
– \pad-markup
– \pad-to-box (2 pairs)
– \pad-x
(\raise is the only positive exception, although the description might be a bit too lenghty)
– \translate
– \translate-scaled
– \vspace
GRAPHIC
– \beam (3)
– \draw-circle (2)
– \draw-dashed-line (**)
– \draw-dotted-line (**)
– \draw-line (**)
– \epsfile
– \filled-box (2)
– \path (2)
(– \postscript)
MUSIC
– \customTabClef (1)
OTHER
– \pattern (1)
– \with-dimensions (2)

* the unit of the /dir/ argument is half the extent of the markup in /axis/ direction (isn’t it?) ** add a description like “/dest/ gives the #'(x . y) coordinates of the end of the line, which will begin at #'(0 . 0)”


Some other annotations of mine:
– For what I know of typography, \caps should actually have a different meaning from \smallCaps (THAT IS TO SAY, WITH EVERY LETTER BEING A LARGE CAPITAL), and having them as synonyms tends to be confusing. – For several of the used properties, such as thickness, baseline-skip and font-size, it might also be unclear which unit they are using. I don’t know the right place to put this information, though. – Naming convention: nearly all markup commands have \command-name. Exceptions: \customTabClef should probably be renamed to \custom-tab-clef, and \epsfile to \eps-file (much better to read and easy to convert) – \pad-around and \pad-markup are duplicates, as far as I can see. Perhaps it would be better to have just one of them? (I’d vote for the former)
– The list entry for \fill-line should probably begin |
\fill-line| markups (markup list)
instead of
|\fill-line| args (markup list), in order to be consistent with the description. – Does \arrow-head have a font-size property or another facility to change the size?
– The description for \customTabClef seems too short.
– The \accidental and \fermata commands also use the font-size property, I should think? – \markletter: Perhaps it would be easier to describe it as “the same as \markalphabet with letter I being skipped.” – The description for \on-the-fly should contain a link to the list of available procedures, namely <http://lilypond.org/doc/v2.18/Documentation/notation/custom-titles-headers-and-footers#index-_005con_002dthe
_002dfly-1> or similar.

This is all rather a lot to process and I don't think you will get much reaction from this email (I may be wrong) from the group. As a group we have been known to spend a lot of time on the (re)naming of just a single command; and changing names of existing commands is not something we take lightly. Look up the discussion on the new recent command for \magnifyMusic.

It seems you have done a lot of reading, and I fear this email may not get any (useful) reply as it is just too much in one go to take in or even begin to address.

Frankly I think each of these last set of points needs its own 'email' (I hesitate to say tracker simply because some of them are just your opinion than any technical 'problem' or 'issue'. That's not to say that your opinion isn't important but if you really want to change the name of \customTabClef to \custom-tab-clef (for example) then start a new email thread with just that discussion, and if the group agree then we can start on getting patches made.

James



reply via email to

[Prev in Thread] Current Thread [Next in Thread]