]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: List predefined procedures for `barNumberVisibility'.
authorWerner Lemberg <wl@gnu.org>
Wed, 1 May 2013 08:44:50 +0000 (10:44 +0200)
committerWerner Lemberg <wl@gnu.org>
Fri, 10 May 2013 09:57:17 +0000 (11:57 +0200)
scm/define-context-properties.scm

index 667986d427ba70d5b853de878214f7d947a161a3..eed64e63423324ca99c55e7a35509875fa6b008b 100644 (file)
@@ -132,7 +132,38 @@ number, measure position, and alternative number and returns a markup
 of the bar number to print.")
      (barNumberVisibility ,procedure? "A procedure that takes a bar
 number and a measure position and returns whether the corresponding
-bar number should be printed.")
+bar number should be printed.  Note that the actual print-out of
+bar numbers is controlled with the @code{break-visibility} property.
+
+The following procedures are predefined:
+
+@table @code
+@item all-bar-numbers-visible
+Enable bar numbers for all bars, including the first one and broken
+bars (which get bar numbers in parentheses).
+
+@item first-bar-number-invisible
+Enable bar numbers for all bars (including broken bars) except the
+first one.  If the first bar is broken, it doesn't get a bar number
+either.
+
+@item first-bar-number-invisible-save-broken-bars
+Enable bar numbers for all bars (including broken bars) except the
+first one.  A broken first bar gets a bar number.
+
+@item first-bar-number-invisible-and-no-parenthesized-bar-numbers
+Enable bar numbers for all bars except the first bar and broken bars.
+This is the default.
+
+@item (every-nth-bar-number-visible @var{n})
+Assuming @var{n} is value@tie{}2, for example, this enables bar numbers
+for bars 2, 4, 6, etc.
+
+@item (modulo-bar-number-visible @var{n} @var{m})
+If bar numbers 1, 4, 7, etc., should be enabled, @var{n}@tie{}(the modulo)
+must be set to@tie{}3 and @var{m}@tie{}(the division remainder) to@tie{}1.
+@end table")
+
      (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
 own as a subdivided section.")
      (bassFigureFormatFunction ,procedure? "A procedure that is