ADD_INTERFACE (Accidental_interface,
- "a single accidental",
+ "A single accidental.",
/* props */
"alteration "
}
ADD_INTERFACE (Align_interface,
+ "Order grobs from top to bottom, left to right, right to left "
+ "or bottom to top. For vertical alignments of staves, the "
+ "@code{break-system-details} of the left "
+ "@internalsref{NonMusicalPaperColumn} may be set to tune "
+ "vertical spacing. Set @code{alignment-extra-space} to add "
+ "extra space for staves. Set "
+ "@code{fixed-alignment-extra-space} to force staves in "
+ "@code{PianoStaff}s further apart.",
- "Order grobs from top to bottom, left to right, right to left or bottom "
- "to top. "
- "For vertical alignments of staves, the @code{break-system-details} of "
- "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
- "Set @code{alignment-extra-space} to add extra space for staves. Set "
- "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."
- ,
-
- /*
- properties
- */
+ /* properties */
"align-dir "
"axes "
"elements "
return SCM_EOL;
}
-ADD_INTERFACE (Ambitus ,
+ADD_INTERFACE (Ambitus,
"The line between note heads for a pitch range.",
/* props */
}
ADD_INTERFACE (Arpeggio,
- "Functions and settings for drawing an arpeggio symbol (a wavy line left to noteheads.",
+ "Functions and settings for drawing an arpeggio symbol (a "
+ "wavy line left to noteheads.",
/* properties */
"arpeggio-direction "
}
ADD_INTERFACE (Axis_group_interface,
-
"An object that groups other layout objects.",
/* properties */
}
ADD_INTERFACE (Balloon_interface,
- "A collection of routines to put text balloons around an object.",
+ "A collection of routines to put text balloons around an "
+ "object.",
/* properties */
"padding "
}
ADD_INTERFACE (Bar_line,
-
"Bar line.\n"
"\n"
- "Print a special bar symbol. It replaces the \n"
- "regular bar symbol with a special\n"
- "symbol. The argument @var{bartype} is a string which specifies the\n"
- "kind of bar to print. Options are @code{:|}, \n"
- "@code{|:}, @code{:|:},\n"
- "@code{||}, @code{|.},\n"
- "@code{.|}, and @code{.|.}. \n"
+ "Print a special bar symbol. It replaces the regular bar "
+ "symbol with a special symbol. The argument @var{bartype} "
+ "is a string which specifies the kind of bar to print. "
+ "Options are @code{:|}, @code{|:}, @code{:|:}, @code{||}, "
+ "@code{|.}, @code{.|}, and @code{.|.}.\n"
"\n"
- "These produce, respectively, a right repeat, a left repeat, a double\n"
- "repeat, a double bar, a start bar, an end bar, and a thick double bar.\n"
- "In addition, there is an option @code{||:} which is equivalent to\n"
- "@code{|:} except at line breaks, where it produces a double bar (@code{||})\n"
- "at the end of the line and a repeat sign (@code{|:}) at the beginning\n"
- "of the new line."
- "If @var{bartype} is set to @code{empty} then nothing is printed,\n"
- "but a line break is allowed at that spot.\n"
- "\n\n"
- "@code{gap} is used for the gaps in dashed barlines."
-
- ,
-
+ "These produce, respectively, a right repeat, a left repeat, "
+ "a double repeat, a double bar, a start bar, an end bar, and "
+ "a thick double bar. In addition, there is an option "
+ "@code{||:} which is equivalent to @code{|:} except at line "
+ "breaks, where it produces a double bar (@code{||}) at the "
+ "end of the line and a repeat sign (@code{|:}) at the "
+ "beginning of the new line.\n"
+ "\n"
+ "If @var{bartype} is set to @code{empty} then nothing is "
+ "printed, but a line break is allowed at that spot.\n"
+ "\n"
+ "@code{gap} is used for the gaps in dashed barlines.",
/* properties */
"allow-span-bar "
}
ADD_INTERFACE (Beam,
-
- "A beam. \n\n"
+ "A beam.\n"
+ "\n"
"The @code{thickness} property is the weight of beams, "
- "measured in staffspace. The @code{direction} "
- "property is not user-serviceable. Use "
- "the @code{direction} property of @code{Stem} instead. "
-
- ,
+ "measured in staffspace. The @code{direction} property is "
+ "not user-serviceable. Use the @code{direction} property "
+ "of @code{Stem} instead.",
/* properties */
"annotation "
}
ADD_INTERFACE (Break_alignable_interface,
- "Object that is aligned on a break aligment. ",
+ "Object that is aligned on a break aligment.",
/* properties */
"break-align-symbols "
- )
-
-
+ );
ADD_INTERFACE (Break_aligned_interface,
"Items that are aligned in prefatory matter.\n"
"\n"
- "The spacing of these items is controlled by the @code{space-alist}\n"
- "property. It contains a list @code{break-align-symbol}s with a specification\n"
- "of the associated space. The space specification can be "
+ "The spacing of these items is controlled by the "
+ "@code{space-alist} property. It contains a list "
+ "@code{break-align-symbol}s with a specification of the "
+ "associated space. The space specification can be\n"
+ "\n"
"@table @code\n"
"@item (minimum-space . @var{spc}))\n"
- " Pad space until the distance is @var{spc}\n"
+ " Pad space until the distance is @var{spc}.\n"
"@item (fixed-space . @var{spc})\n"
- " Set a fixed space\n"
+ " Set a fixed space.\n"
"@item (semi-fixed-space . @var{spc})\n"
- " Set a space. Half of it is fixed and half is stretchable. \n"
- "(does not work at start of line. fixme)\n"
+ " Set a space. Half of it is fixed and half is stretchable. "
+ " (does not work at start of line. fixme)\n"
"@item (extra-space . @var{spc})\n"
" Add @var{spc} amount of space.\n"
"@end table\n"
"\n"
- "Special keys for the alist are @code{first-note} and @code{next-note}, signifying\n"
- "the first note on a line, and the next note halfway a line.\n"
+ "Special keys for the alist are @code{first-note} and "
+ "@code{next-note}, signifying the first note on a line, and "
+ "the next note halfway a line.\n"
"\n"
- "Rules for this spacing are much more complicated than this. \n"
- "See [Wanske] page 126 -- 134, [Ross] pg 143 -- 147\n",
+ "Rules for this spacing are much more complicated than this. "
+ "See [Wanske] page 126--134, [Ross] page 143--147.",
/* properties */
"break-align-anchor "
);
ADD_INTERFACE (Break_alignment_interface,
- "The object that performs break aligment. See @ref{break-aligned-interface}.",
+ "The object that performs break aligment. "
+ "See @ref{break-aligned-interface}.",
/* properties */
"positioning-done "
- "break-align-orders");
+ "break-align-orders "
+ );
ADD_INTERFACE (Breathing_sign,
"A breathing sign.",
+ /* properties */
"direction "
-
);
ADD_INTERFACE (Chord_name,
"A chord name.",
-
- "begin-of-line-visible");
+ /* properties */
+ "begin-of-line-visible "
+ );
}
ADD_INTERFACE (Clef,
- "A clef sign",
+ "A clef sign.",
/* properties */
"full-size-change "
}
ADD_INTERFACE (Cluster,
- "A graphically drawn musical cluster. "
- "\n\n"
- "@code{padding} adds to the vertical extent of the shape (top and "
- "bottom). \n\n"
- "The property @code{style} controls the shape of cluster segments. Valid values "
- "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, "
- "and @code{ramp}.\n",
-
- /* props */
+ "A graphically drawn musical cluster.\n"
+ "\n"
+ "@code{padding} adds to the vertical extent of the shape (top "
+ "and bottom).\n"
+ "\n"
+ "The property @code{style} controls the shape of cluster "
+ "segments. Valid values include @code{leftsided-stairs}, "
+ "@code{rightsided-stairs}, @code{centered-stairs}, and "
+ "@code{ramp}.\n",
+
+ /* properties */
"style "
"padding "
"columns "
}
ADD_INTERFACE (Cluster_beacon,
- "A place holder for the cluster spanner to determine the vertical "
- "extents of a cluster spanner at this X position.",
+ "A place holder for the cluster spanner to determine the "
+ "vertical extents of a cluster spanner at this "
+ "X@tie{}position.",
/* properties */
- "positions ");
+ "positions "
+ );
ADD_INTERFACE (Custos,
"A custos object. @code{style} can have four valid values: "
- "mensural, vaticana, medicaea and hufnagel. Mensural is the "
- "default style. ",
+ "@code{mensural}, @code{vaticana}, @code{medicaea}, and "
+ "@code{hufnagel}. @code{mensural} is the default style.",
/* properties */
"style "
"neutral-position "
- "neutral-direction ");
+ "neutral-direction "
+ );
}
ADD_INTERFACE (Dot_column,
-
- "Groups dot objects so they form a column, and position dots so they do not "
- "clash with staff lines. ",
+ "Group dot objects so they form a column, and position "
+ "dots so they do not clash with staff lines.",
/* properties */
"dots "
}
ADD_INTERFACE (Dots,
- "The dots to go with a notehead or rest."
- "@code{direction} sets the preferred direction to move in case of staff "
- "line collisions. @code{style} defaults to undefined, which is "
- "normal 19th/20th century traditional style. Set @code{style} "
- "to @code{vaticana} for ancient type dots. ",
+ "The dots to go with a notehead or rest. @code{direction} "
+ "sets the preferred direction to move in case of staff line "
+ "collisions. @code{style} defaults to undefined, which is "
+ "normal 19th/20th century traditional style. Set "
+ "@code{style} to @code{vaticana} for ancient type dots.",
/* properties */
"direction "
ADD_INTERFACE (Enclosing_bracket,
-
"Brackets alongside bass figures.",
- /* props */
+ /* properties */
"bracket-flare "
"edge-height "
"elements "
ADD_INTERFACE (Figured_bass_continuation,
"Simple extender line between bounds.",
- /* props */
+ /* properties */
"thickness "
"padding "
"figures "
ADD_INTERFACE (Font_interface,
"Any symbol that is typeset through fixed sets of glyphs, "
- " (ie. fonts)",
+ "(i.e., fonts).",
+ /* properties */
"font "
"font-encoding "
"font-family "
read by the associated item class, such as VaticanaLigature.--jr
*/
ADD_INTERFACE (Gregorian_ligature,
- "A gregorian ligature",
- "virga stropha inclinatum auctum descendens ascendens "
- "oriscus quilisma deminutum cavum linea pes-or-flexa "
- "context-info prefix-set");
+ "A gregorian ligature.",
+
+ /* properties */
+ "virga "
+ "stropha "
+ "inclinatum "
+ "auctum "
+ "descendens "
+ "ascendens "
+ "oriscus "
+ "quilisma "
+ "deminutum "
+ "cavum "
+ "linea "
+ "pes-or-flexa "
+ "context-info "
+ "prefix-set "
+ );
}
ADD_INTERFACE (Grid_line_interface,
- "A line that spanned between grid-points. ",
- "elements thickness");
+ "A line that is spanned between grid-points.",
+
+ /* properties */
+ "elements "
+ "thickness "
+ );
ADD_INTERFACE (Grid_point_interface,
- "A spanning point for grid lines. ",
- "");
+ "A spanning point for grid lines.",
+
+ /* properties */
+ ""
+ );
ADD_INTERFACE (Grob,
- "A grob represents a piece of music notation\n"
+ "A grob represents a piece of music notation.\n"
"\n"
- "All grobs have an X and Y-position on the page. These X and Y positions\n"
- "are stored in a relative format, so they can easily be combined by\n"
- "stacking them, hanging one grob to the side of another, and coupling\n"
- "them into a grouping objects.\n"
+ "All grobs have an X and Y@tie{}position on the page. These "
+ "X and Y@tie{}positions are stored in a relative format, thus "
+ "they can easily be combined by stacking them, hanging one "
+ "grob to the side of another, or coupling them into grouping "
+ "objects.\n"
"\n"
- "Each grob has a reference point (a.k.a. parent): the position of a grob\n"
- "is stored relative to that reference point. For example the X-reference\n"
- "point of a staccato dot usually is the note head that it applies\n"
- "to. When the note head is moved, the staccato dot moves along\n"
+ "Each grob has a reference point (a.k.a.@: parent): The "
+ "position of a grob is stored relative to that reference "
+ "point. For example, the X@tie{}reference point of a staccato "
+ "dot usually is the note head that it applies to. When the "
+ "note head is moved, the staccato dot moves along "
"automatically.\n"
"\n"
- "A grob is often associated with a symbol, but some grobs do not print\n"
- "any symbols. They take care of grouping objects. For example, there is a\n"
- "separate grob that stacks staves vertically. The @ref{NoteCollision}\n"
- "is also an abstract grob: it only moves around chords, but doesn't print\n"
+ "A grob is often associated with a symbol, but some grobs do "
+ "not print any symbols. They take care of grouping objects. "
+ "For example, there is a separate grob that stacks staves "
+ "vertically. The @ref{NoteCollision} object is also an "
+ "abstract grob: It only moves around chords, but doesn't print "
"anything.\n"
"\n"
- "Grobs have a properties: Scheme variables, that can be read and set. "
- "They have two types. Immutable variables "
- "define the default style and behavior. They are shared between many objects. "
- "They can be changed using @code{\\override} and @code{\\revert}. "
- "\n\n"
- "Mutable properties are variables that are specific to one grob. Typically, "
- "lists of other objects, or results from computations are stored in"
- "mutable properties: every call to set-grob-property (or its C++ equivalent) "
- "sets a mutable property. "
- "\n\n"
- "The properties @code{after-line-breaking} and @code{before-line-breaking} "
- "are dummies that are not user-serviceable. "
-
- ,
+ "Grobs have properties (Scheme variables) that can be read and "
+ "set. Two types of them exist: immutable and mutable. "
+ "Immutable variables define the default style and behavior. "
+ "They are shared between many objects. They can be changed "
+ "using @code{\\override} and @code{\\revert}. Mutable "
+ "properties are variables that are specific to one grob. "
+ "Typically, lists of other objects, or results from "
+ "computations are stored in mutable properties. In "
+ "particular, every call to @code{set-grob-property} (or its "
+ "C++ equivalent) sets a mutable property.\n"
+ "\n"
+ "The properties @code{after-line-breaking} and "
+ "@code{before-line-breaking} are dummies that are not "
+ "user-serviceable.",
/* properties */
"X-extent "
}
ADD_INTERFACE (Hairpin,
- "A hairpin crescendo/decrescendo.",
+ "A hairpin crescendo or decrescendo.",
/* props */
"adjacent-hairpins "
}
ADD_INTERFACE (Hara_kiri_group_spanner,
- "A group spanner that keeps track of interesting items. If it "
- "doesn't contain any after linebreaking, then it "
- "will remove itself and all its children.",
-
+ "A group spanner that keeps track of interesting items. If it "
+ "doesn't contain any after line breaking, it removes itself "
+ "and all its children.",
/* properties */
"items-worth-living "
}
ADD_INTERFACE (Item,
-
- "Grobs can be distinguished in their role in the horizontal spacing.\n"
- "Many grobs define constraints on the spacing by their sizes. For\n"
- "example, note heads, clefs, stems, and all other symbols with a fixed\n"
- "shape. These grobs form a subtype called @code{Item}.\n"
- "\n"
+ "Grobs can be distinguished in their role in the horizontal "
+ "spacing. Many grobs define constraints on the spacing by "
+ "their sizes, for example, note heads, clefs, stems, and all "
+ "other symbols with a fixed shape. These grobs form a "
+ "subtype called @code{Item}.\n"
"\n"
- "Some items need special treatment for line breaking. For example, a\n"
- "clef is normally only printed at the start of a line (i.e. after a\n"
- "line break). To model this, `breakable' items (clef, key signature,\n"
- "bar lines, etc.) are copied twice. Then we have three versions of each\n"
- "breakable item: one version if there is no line break, one version\n"
- "that is printed before the line break (at the end of a system), one\n"
- "version that is printed after the line break.\n"
+ "Some items need special treatment for line breaking. For "
+ "example, a clef is normally only printed at the start of a "
+ "line (i.e., after a line break). To model this, "
+ "@q{breakable} items (clef, key signature, bar lines, etc.) "
+ "are copied twice. Then we have three versions of each "
+ "breakable item: one version if there is no line break, one "
+ "version that is printed before the line break (at the end of "
+ "a system), and one version that is printed after the line "
+ "break.\n"
"\n"
- "Whether these versions are visible and take up space, is determined by\n"
- "the outcome of the @code{break-visibility}. This grob property is a\n"
- "function taking a direction (-1, 0 or 1) as argument. It returns a\n"
- "cons of booleans, signifying whether this grob should be transparent\n"
- "and have no extent.\n"
+ "Whether these versions are visible and take up space is "
+ "determined by the outcome of the @code{break-visibility} "
+ "grob property, which is a function taking a direction (-1, 0 "
+ "or@tie{}1) as an argument. It returns a cons of booleans, "
+ "signifying whether this grob should be transparent and have "
+ "no extent.\n"
"\n"
- "The following variables for break-visibility are predefined:\n"
+ "The following variables for @code{break-visibility} are "
+ "predefined:\n"
"@example\n"
" grob will show: before no after\n"
" break break break\n"
" begin-of-line-invisible yes yes no\n"
" end-of-line-invisible no yes yes\n"
" center-invisible yes no yes\n"
- "@end example\n",
+ "@end example",
/* properties */
"break-visibility "
"extra-spacing-width "
"infinite-spacing-height "
- "non-musical")
+ "non-musical "
+ );
ADD_INTERFACE (Key_signature_interface,
"A group of accidentals, to be printed as signature sign.",
+ /* properties */
"alteration-alist "
"c0-position "
"glyph-name-alist "
}
ADD_INTERFACE (Ledger_line_spanner,
-
- "This spanner draws the ledger lines of a staff.\n"
- "This is a separate grob because it has to process\n"
- "all potential collisions between all note heads.",
+ "This spanner draws the ledger lines of a staff. This is a "
+ "separate grob because it has to process all potential "
+ "collisions between all note heads.",
/* properties */
"gap "
};
ADD_INTERFACE (Ledgered_interface,
+ "Objects that need ledger lines, typically note heads. See "
+ "also @ref{ledger-line-spanner-interface}.",
- "Objects that need ledger lines, typically "
- "note heads. See also @ref{ledger-line-spanner-interface}.",
-
- "no-ledgers");
+ /* properties */
+ "no-ledgers "
+ );
}
ADD_INTERFACE (Line_interface,
- "Generic line objects. Any object using lines supports this. "
+ "Generic line objects. Any object using lines supports this. "
"The property @code{style} can be @code{line}, "
- "@code{dashed-line}, @code{trill}, \n"
- "@code{dotted-line} or @code{zigzag}.\n"
+ "@code{dashed-line}, @code{trill}, @code{dotted-line} or "
+ "@code{zigzag}.\n"
"\n"
- "For dashed-line, the length of the dashes is tuned with "
- "@code{dash-fraction}. If the latter is set to 0, a dotted line is "
- "produced. If @code{dash-period} is negative, the line is made "
- "transparent.",
+ "For @code{dashed-line}, the length of the dashes is tuned "
+ "with @code{dash-fraction}. If the latter is set to@tie{}0, a "
+ "dotted line is produced. If @code{dash-period} is negative, "
+ "the line is made transparent.",
/* properties */
"dash-period "
}
ADD_INTERFACE (Line_spanner,
- "Generic line drawn between two objects, e.g. for use with glissandi.\n"
+ "Generic line drawn between two objects, e.g., for use with "
+ "glissandi.\n"
+ "\n"
"The property @code{style} can be @code{line}, "
- "@code{dashed-line}, @code{trill}, \n"
- "@code{dotted-line} or @code{zigzag}.\n"
- "\n",
+ "@code{dashed-line}, @code{trill}, @code{dotted-line} or "
+ "@code{zigzag}.",
+ /* properties */
"bound-details "
"extra-dy "
"gap "
ADD_INTERFACE (Lyric_extender,
"The extender is a simple line at the baseline of the lyric "
- "that helps show the length of a melissima (tied/slurred note).",
+ "that helps show the length of a melisma (a tied or slurred "
+ "note).",
+ /* properties */
"heads "
"left-padding "
"next "
}
ADD_INTERFACE (Lyric_hyphen,
+ "A centered hyphen is simply a line between lyrics used to "
+ "divide syllables.",
- "A centered hyphen is a simple line between "
- "lyrics used to divide syllables",
-
- /* props */
+ /* properties */
"dash-period "
"height "
"length "
}
ADD_INTERFACE (Measure_grouping,
- "This object indicates groups of beats. "
- "Valid choices for @code{style} are @code{bracket} and @code{triangle}.",
- "thickness style height");
+ "This object indicates groups of beats. Valid choices for "
+ "@code{style} are @code{bracket} and @code{triangle}.",
+
+ /* properties */
+ "thickness "
+ "style "
+ "height "
+ );
ADD_INTERFACE (Melody_spanner,
"Context dependent typesetting decisions.",
+ /* properties */
"stems "
- "neutral-direction ");
+ "neutral-direction "
+ );
}
ADD_INTERFACE (Mensural_ligature,
- "A mensural ligature",
+ "A mensural ligature.",
+ /* properties */
"delta-position "
"flexa-width "
"head-width "
"join-right-amount "
"primitive "
- "thickness"
+ "thickness "
);
"thick-thickness "
"use-breve-rest "
"bound-padding "
- "minimum-length");
+ "minimum-length "
+ );
}
ADD_INTERFACE (Note_collision_interface,
- "An object that handles collisions between notes with different stem "
- "directions and horizontal shifts. Most of the interesting properties "
- "are to be set in @ref{note-column-interface}: these are "
- "@code{force-hshift} and @code{horizontal-shift}.",
+ "An object that handles collisions between notes with "
+ "different stem directions and horizontal shifts. Most of "
+ "the interesting properties are to be set in "
+ "@ref{note-column-interface}: these are @code{force-hshift} "
+ "and @code{horizontal-shift}.",
/* properties */
"merge-differently-dotted "
}
ADD_INTERFACE (Note_column,
- "Stem and noteheads combined",
+ "Stem and noteheads combined.",
/* properties */
"arpeggio "
ADD_INTERFACE (Note_head,
- "Note head",
+ "Note head.",
/* properties */
"note-names "
ADD_INTERFACE (Note_spacing,
"This object calculates spacing wishes for individual voices.",
-
+ /* properties */
"knee-spacing-correction "
"left-items "
"right-items "
"same-direction-correction "
"stem-spacing-correction "
"space-to-barline "
-
);
}
ADD_INTERFACE (Ottava_bracket,
- "An ottava bracket",
+ "An ottava bracket.",
- /*
- properties
- */
+ /* properties */
"edge-height "
"bracket-flare "
"shorten-pair "
- "minimum-length");
+ "minimum-length "
+ );
ADD_INTERFACE (Paper_column,
- "@code{Paper_column} objects form the top-most X-parents for items."
- " The are two types of columns: musical columns, where are attached to, and "
- " non-musical columns, where bar-lines, clefs etc. are attached to. "
- " The spacing engine determines the X-positions of these objects."
-
- "\n\n"
- "They are\n"
- " numbered, the first (leftmost) is column 0. Numbering happens before\n"
- " line-breaking, and columns are not renumbered after line breaking.\n"
- " Since many columns go unused, you should only use the rank field to\n"
- " get ordering information. Two adjacent columns may have\n"
- " non-adjacent numbers.\n",
-
+ "@code{Paper_column} objects form the top-most X@tie{}parents "
+ "for items. There are two types of columns: musical columns, "
+ "where are attached to, and non-musical columns, where "
+ "bar-lines, clefs, etc., are attached to. The spacing engine "
+ "determines the X@tie{}positions of these objects.\n"
+ "\n"
+ "They are numbered, the first (leftmost) is column@tie{}0. "
+ "Numbering happens before line breaking, and columns are not "
+ "renumbered after line breaking. Since many columns go "
+ "unused, you should only use the rank field to get ordering "
+ "information. Two adjacent columns may have non-adjacent "
+ "numbers.",
/* properties */
"between-cols "
"shortest-starter-duration "
"spacing "
"used "
- "when ");
+ "when "
+ );
}
ADD_INTERFACE (Percent_repeat_item_interface,
- "Repeats that look like percent signs",
+ "Repeats that look like percent signs.",
+ /* properties */
"slope "
- "thickness ");
+ "thickness "
+ );
}
ADD_INTERFACE (Piano_pedal_bracket,
+ "The bracket of the piano pedal. It can be tuned through "
+ "the regular bracket properties.",
- "The bracket of the piano pedal. "
- "It can be tuned through the regular "
- "bracket properties.",
-
- /* props */
+ /* properties */
"bound-padding "
"edge-height "
"shorten-pair "
"bracket-flare "
- "pedal-text ");
+ "pedal-text "
+ );
/* properties */
"minimum-distance "
"positioning-done "
- "elements");
+ "elements "
+ );
}
ADD_INTERFACE (Rest,
- "A rest symbol."
- "The property @code{style} can be @code{default}, "
- "@code{mensural}, @code{neomensural} or @code{classical}.",
+ "A rest symbol. The property @code{style} can be "
+ "@code{default}, @code{mensural}, @code{neomensural} or "
+ "@code{classical}.",
/* properties */
-
"direction "
"minimum-distance "
"style "
}
ADD_INTERFACE (Rhythmic_head,
-
- "Note head or rest",
+ "Note head or rest.",
+ /* properties */
"dot "
"duration-log "
"stem "
);
-
}
ADD_INTERFACE (Script_column,
- "An interface that sorts scripts "
- "according to their @code{script-priority}",
+ "An interface that sorts scripts according to their "
+ "@code{script-priority}.",
- "");
+ /* properties */
+ ""
+ );
};
ADD_INTERFACE (Text_script,
- "An object that is put above or below a note",
+ "An object that is put above or below a note.",
/* properties */
"add-stem-support "
Hmm. Where should we put add-stem-support ?
*/
ADD_INTERFACE (Script_interface,
- "An object that is put above or below a note",
+ "An object that is put above or below a note.",
+
+ /* properties */
"add-stem-support "
"avoid-slur "
"positioning-done "
}
ADD_INTERFACE (Self_alignment_interface,
- "Position this object on itself and/or on its parent. To this end, the following functions "
- " are provided: \n"
- "@table @code \n"
+ "Position this object on itself and/or on its parent. To this "
+ "end, the following functions are provided:\n"
+ "\n"
+ "@table @code\n"
"@item Self_alignment_interface::[xy]_aligned_on_self\n"
- " Align self on reference point, using @code{self-alignment-X} and "
- "@code{self-alignment-Y}."
+ " Align self on reference point, using "
+ " @code{self-alignment-X} and @code{self-alignment-Y}."
"@item Self_alignment_interface::aligned_on_[xy]_parent\n"
"@item Self_alignment_interface::centered_on_[xy]_parent\n"
- " Shift the object so its own reference point is centered on the "
- " extent of the parent \n"
+ " Shift the object so its own reference point is centered on "
+ " the extent of the parent\n"
"@end table\n",
-
/* properties */
"self-alignment-X "
- "self-alignment-Y ");
+ "self-alignment-Y "
+ );
ADD_INTERFACE (Semi_tie_column,
- "The interface for a column of l.v. ties.",
+ "The interface for a column of l.v. (laissez vibrer) ties.",
/* properties */
"positioning-done "
#include "staff-symbol-referencer.hh"
ADD_INTERFACE (Semi_tie,
-
- "A tie which is only on one side connected to note heads. ",
+ "A tie which is only on one side connected to a note head.",
/* properties */
"control-points "
}
ADD_INTERFACE (Separation_item,
- "Item that computes widths to generate spacing rods. "
- ,
+ "Item that computes widths to generate spacing rods.",
+ /* properties */
"X-extent "
"conditional-elements "
"elements "
}
ADD_INTERFACE (Side_position_interface,
- "Position a victim object (this one) next to other objects (the "
- "support). The property @code{direction} signifies where to put the "
- "victim object relative to the support (left or right, up or down?)\n\n "
- "The routine also takes the size the staff into account if "
- "@code{staff-padding} is set. If undefined, the staff symbol is ignored.",
+ "Position a victim object (this one) next to other objects "
+ "(the support). The property @code{direction} signifies where "
+ "to put the victim object relative to the support (left or "
+ "right, up or down?)\n"
+ "\n"
+ "The routine also takes the size of the staff into account if "
+ "@code{staff-padding} is set. If undefined, the staff symbol "
+ "is ignored.",
/* properties */
"direction "
}
ADD_INTERFACE (Slur,
-
- "A slur",
+ "A slur.",
/* properties */
"annotation "
ADD_INTERFACE (Spaceable_grob,
- "A layout object that takes part in the spacing problem. ",
-
+ "A layout object that takes part in the spacing problem.",
/* properties */
"allow-loose-spacing "
"minimum-distances "
"right-neighbors "
"spacing-wishes "
-
);
ADD_INTERFACE (Spacing_interface,
- "This object calculates the desired and minimum distances between two columns.",
+ "This object calculates the desired and minimum distances "
+ "between two columns.",
+ /* properties */
"left-items "
"right-items "
);
}
ADD_INTERFACE (Spacing_spanner,
- "The space taken by a note is dependent on its duration. Doubling a\n"
- "duration adds spacing-increment to the space. The most common shortest\n"
- "note gets @code{shortest-duration-space}. Notes that are even shorter are\n"
- "spaced proportonial to their duration.\n"
+ "The space taken by a note is dependent on its duration. "
+ "Doubling a duration adds @code{spacing-increment} to the "
+ "space. The most common shortest note gets "
+ "@code{shortest-duration-space}. Notes that are even shorter "
+ "are spaced proportonial to their duration.\n"
"\n"
- "Typically, the increment is the width of a black note head. In a\n"
- "piece with lots of 8th notes, and some 16th notes, the eighth note\n"
- "gets 2 note heads width (i.e. the space following a note is 1 note\n"
- "head width) A 16th note is followed by 0.5 note head width. The\n"
- "quarter note is followed by 3 NHW, the half by 4 NHW, etc.\n",
-
-
+ "Typically, the increment is the width of a black note head. "
+ "In a piece with lots of 8th notes, and some 16th notes, the "
+ "eighth note gets a 2@tie{}note heads width (i.e., the space "
+ "following a note is a 1@tie{}note head width). A 16th note "
+ "is followed by 0.5 note head width. The quarter note is "
+ "followed by 3@tie{}NHW, the half by 4@tie{}NHW, etc.",
+
+ /* properties */
"average-spacing-wishes "
"base-shortest-duration "
"common-shortest-duration "
"strict-grace-spacing "
"strict-note-spacing "
"uniform-stretching "
-
);
}
ADD_INTERFACE (Span_bar,
- "A bar line that spanned between other barlines. This interface is "
- " used for bar lines that connect different staves.",
+ "A bar line that is spanned between other barlines. This "
+ "interface is used for bar lines that connect different "
+ "staves.",
/* properties */
"glyph-name "
- "elements");
+ "elements "
+ );
}
ADD_INTERFACE (Spanner,
- "Some objects are horizontally spanned between objects. For\n"
- "example, slur, beam, tie, etc. These grobs form a subtype called\n"
- "@code{Spanner}. All spanners have two span-points (these must be\n"
- "@code{Item} objects), one on the left and one on the right. The left bound is\n"
- "also the X-reference point of the spanner.\n",
-
+ "Some objects are horizontally spanned between objects. For "
+ "example, slurs, beams, ties, etc. These grobs form a subtype "
+ "called @code{Spanner}. All spanners have two span points "
+ "(these must be @code{Item} objects), one on the left and one "
+ "on the right. The left bound is also the X@tie{}reference "
+ "point of the spanner.",
+
+ /* properties */
"minimum-length "
"to-barline "
);
}
ADD_INTERFACE (Staff_spacing,
- "This object calculates spacing details from a "
- " breakable symbol (left) to another object. For example, it takes care "
- " of optical spacing from a bar lines to a note.",
+ "This object calculates spacing details from a breakable "
+ "symbol (left) to another object. For example, it takes care "
+ "of optical spacing from a bar line to a note.",
/* properties */
"stem-spacing-correction "
}
ADD_INTERFACE (Staff_symbol_referencer,
- "An object whose Y position is meant relative to a staff "
- "symbol. "
- "These usually have @code{Staff_symbol_referencer::callback} "
- "in their @code{Y-offset-callbacks}. ",
+ "An object whose Y@tie{}position is meant relative to a staff "
+ "symbol. These usually "
+ "have @code{Staff_symbol_referencer::callback} in their "
+ "@code{Y-offset-callbacks}.",
/* properties */
- "staff-position");
-
-
+ "staff-position "
+ );
+
\ No newline at end of file
ADD_INTERFACE (Staff_symbol,
- "This spanner draws the lines of a staff. "
- "A staff symbol definines a vertical unit, the staff space. "
- "Quantities that go by a half staff space are called positions "
- "The center (i.e. middle line "
- "or space) is position 0. The length of the symbol may be set by hand "
- "through the @code{width} property. ",
-
+ "This spanner draws the lines of a staff. A staff symbol "
+ "defines a vertical unit, the @empf{staff space}. Quantities "
+ "that go by a half staff space are called @emph{positions}. "
+ "The center (i.e., middle line or space) is position@tie{}0. "
+ "The length of the symbol may be set by hand through the "
+ "@code{width} property.",
/* properties */
"ledger-line-thickness "
}
ADD_INTERFACE (Stem_tremolo,
- "A beam slashing a stem to indicate a tremolo. "
- "The property @code{style} can be @code{default} or "
- "@code{rectangle}.",
+ "A beam slashing a stem to indicate a tremolo. The property "
+ "@code{style} can be @code{default} or @code{rectangle}.",
/* properties */
"beam-thickness "
/* FIXME: Too many properties */
ADD_INTERFACE (Stem,
- "The stem represent the graphical stem. "
- "In addition, it internally connects note heads, beams and"
- "tremolos. "
- "Rests and whole notes have invisible stems."
-
- "\n\nThe following properties may be set in the details list."
+ "The stem represents the graphical stem. In addition, it "
+ "internally connects note heads, beams, and tremolos. Rests "
+ "and whole notes have invisible stems.\n"
+ "\n"
+ "The following properties may be set in the @code{details} "
+ "list.\n"
+ "\n"
"@table @code\n"
- "@item beamed-lengths \n"
- "list of stem lengths given beam multiplicity. \n"
- "@item beamed-minimum-free-lengths \n"
- "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.\n"
+ "@item beamed-lengths\n"
+ " List of stem lengths given beam multiplicity.\n"
+ "@item beamed-minimum-free-lengths\n"
+ " List of normal minimum free stem lengths (chord to beams) "
+ " given beam multiplicity.\n"
"@item beamed-extreme-minimum-free-lengths\n"
- "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.\n"
+ " List of extreme minimum free stem lengths (chord to beams) "
+ " given beam multiplicity.\n"
"@item lengths\n"
- "Default stem lengths. The list gives a length for each flag-count.\n"
+ " Default stem lengths. The list gives a length for each "
+ " flag count.\n"
"@item stem-shorten\n"
- "How much a stem in a forced direction "
- "should be shortened. The list gives an amount depending on the number "
- "of flags/beams."
- "@end table\n"
- ,
+ " How much a stem in a forced direction should be shortened. "
+ " The list gives an amount depending on the number of flags "
+ " and beams.\n"
+ "@end table\n",
/* properties */
"avoid-note-head "
}
ADD_INTERFACE (System_start_delimiter,
- "The brace, bracket or bar in front of the system. The following "
- "values for @code{style} are recognized:\n"
- "\n"
- " @table @samp\n"
- " @item @code{bracket}\n"
- " A thick bracket, normally used to group similar\n"
- " instruments in a score. Default for StaffGroup.\n"
- " SystemStartBracket use this style.\n"
- "\n"
- " @item @code{brace}\n"
- " A \"piano style\" brace normally used for an instrument\n"
- " that use two staffs. The default style for GrandStaff.\n"
- " SystemStartBrace use this style.\n"
- "\n"
- " @item @code{bar-line}\n"
- " A simple line between the staffs in a score. Default\n"
- " for staffs enclosed in << >>.\n"
- " SystemStartBar use this style.\n"
- "\n"
- " @item @code{line-bracket}\n"
- " A simple square, normally used for subgrouping\n"
- " instruments in a score.\n"
- " SystemStartSquare use this style.\n"
- " @end table\n"
- "\n"
- "See also @file{input/regression/system-start-nesting.ly}. ",
+ "The brace, bracket or bar in front of the system. The "
+ "following values for @code{style} are recognized:\n"
+ "\n"
+ "@table @code\n"
+ "@item bracket\n"
+ " A thick bracket, normally used to group similar "
+ " instruments in a score. Default for @code{StaffGroup}. "
+ " @code{SystemStartBracket} uses this style.\n"
+ "@item brace\n"
+ " A @q{piano style} brace normally used for an instrument "
+ " that uses two staves. The default style for "
+ " @code{GrandStaff}. @code{SystemStartBrace} uses this "
+ " style.\n"
+ "@item bar-line\n"
+ " A simple line between the staves in a score. Default "
+ " for staves enclosed in @code{<<} and @code{>>}. "
+ " @code{SystemStartBar} uses this style.\n"
+ "@item line-bracket\n"
+ " A simple square, normally used for subgrouping "
+ " instruments in a score. @code{SystemStartSquare} uses "
+ " this style.\n"
+ "@end table\n"
+ "\n"
+ "See also @file{input/regression/system-start-nesting.ly}.",
/* properties */
"collapse-height "
}
ADD_INTERFACE (System,
- "This is the toplevel object: each object in a score "
- "ultimately has a System object as its X and Y parent. ",
+ "This is the top-level object: Each object in a score "
+ "ultimately has a @code{System} object as its X and "
+ "Y@tie{}parent.",
/* properties */
"all-elements "
ADD_INTERFACE (Text_interface,
- "A scheme markup text, see @ruser{Text markup} and "
- "@ruser{New markup command definition}. "
- "\n\n"
- "There are two important commands: ly:text-interface::print, which is a "
- "grob callback, and ly:text-interface::interpret-markup ",
-
- /* props */
+ "A Scheme markup text, see @ruser{Text markup} and "
+ "@ruser{New markup command definition}.\n"
+ "\n"
+ "There are two important commands: "
+ "@code{ly:text-interface::print}, which is a "
+ "grob callback, and "
+ "@code{ly:text-interface::interpret-markup}.",
+
+ /* properties */
"baseline-skip "
"text "
"word-space "
ADD_INTERFACE (Tie_column,
- "Object that sets directions of multiple ties in a tied chord",
+ "Object that sets directions of multiple ties in a tied chord.",
/* properties */
"positioning-done "
}
ADD_INTERFACE (Tie,
- "A horizontal curve connecting two noteheads. \n\n"
- ,
+ "A horizontal curve connecting two noteheads.",
-
/* properties */
"annotation "
"avoid-slur " // UGH.
"quant-score "
"staff-position "
"thickness "
-
);
}
ADD_INTERFACE (Time_signature,
- "A time signature, in different styles.\n"
- " The following values for 'style are are recognized:\n"
+ "A time signature, in different styles. The following values "
+ "for @code{style} are are recognized:\n"
"\n"
- " @table @samp\n"
- " @item @code{C}\n"
- " 4/4 and 2/2 are typeset as C and struck C, respectively. All\n"
- " other time signatures are written with two digits.\n"
+ "@table @code\n"
+ "@item C\n"
+ " 4/4 and 2/2 are typeset as C and struck C, respectively. "
+ " All other time signatures are written with two digits.\n"
+ "@item neomensural\n"
+ " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are "
+ " typeset with neo-mensural style mensuration marks. All "
+ " other time signatures are written with two digits.\n"
+ "@item mensural\n"
+ " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8, and 9/8 are "
+ " typeset with mensural style mensuration marks. All other "
+ " time signatures are written with two digits.\n"
+ "@item single-digit\n"
+ " All time signatures are typeset with a single digit, e.g., "
+ " 3/2 is written as 3.\n"
+ "@end table\n"
"\n"
- " @item @code{neomensural}\n"
- " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are\n"
- " typeset with neo-mensural style mensuration marks. All other time\n"
- " signatures are written with two digits.\n"
- "\n"
- " @item @code{mensural}\n"
- " 2/2, 3/2, 2/4, 3/4, 4/4, 6/4, 9/4, 4/8, 6/8 and 9/8 are\n"
- " typeset with mensural style mensuration marks. All other time\n"
- " signatures are written with two digits.\n"
- "\n"
- " @item @code{single-digit}\n"
- " All time signatures are typeset with a single\n"
- " digit, e.g. 3/2 is written as 3.\n"
- " @end table\n"
- "\n"
- "See also the test-file @file{input/test/time.ly}.\n",
- "fraction style");
+ "See also the test-file @file{input/test/time.ly}.",
+
+ /* properties */
+ "fraction "
+ "style "
+ );
}
ADD_INTERFACE (Tuplet_bracket,
- "A bracket with a number in the middle, used for tuplets. "
- "When the bracket spans a line break, the value of "
+ "A bracket with a number in the middle, used for tuplets. "
+ "When the bracket spans a line break, the value of "
"@code{break-overshoot} determines how far it extends "
- "beyond the staff. "
- "At a line break, the markups in the @code{edge-text} are printed "
- "at the edges. ",
-
+ "beyond the staff. At a line break, the markups in the "
+ "@code{edge-text} are printed at the edges.",
/* properties */
"bracket-flare "
"shorten-pair "
"staff-padding "
"thickness "
- "tuplets ");
+ "tuplets "
+ );
}
ADD_INTERFACE (Tuplet_number,
- "The number for a bracket. "
- ,
+ "The number for a bracket.",
/* properties */
"avoid-slur " // UGH.
- "bracket ");
+ "bracket "
+ );
}
ADD_INTERFACE (Vaticana_ligature,
- "A vaticana style gregorian ligature",
+ "A vaticana style Gregorian ligature.",
/* properties */
"glyph-name "
}
ADD_INTERFACE (Volta_bracket_interface,
- "Volta bracket with number",
+ "Volta bracket with number.",
/* properties */
"bars "
"thickness "
- "height");
+ "height "
+ );
projects / lilypond.git / commitdiff