[ << Documentation work ] | [Top][Contents] | [ Website work >> ] |
[ < Special characters ] | [ Up : Syntax survey ] | [ Other text concerns > ] |
Miscellany
-
@notation{…}
– refer to pieces of notation, e.g., ‘@notation{clef}’. Also use for specific lyrics (‘the @notation{A - men} is centered’). Only use once per subsection per term. -
@q{…}
– single quotes. Used for ‘vague’ terms. This is the preferred quoting mechanism in the LilyPond manuals. -
@qq{…}
– double quotes. Used for actual quotes (“he said”) or for introducing special input modes. -
@var{…}
– use for metasyntactic variables (such asfoo
,bar
,arg1
, etc.). In most cases, when the@var{…}
command appears in the text (and not in an@example
block) it should be wrapped with an appropriate code-highlighting Texinfo command (such as@code
,@samp
,@file
,@command
, etc.). For example: ‘@code{@var{foo}}’, ‘@file{@var{myfile.ly}}’, ‘@samp{git switch @var{branch}}’, etc. This improves readability in the PDF and HTML output. -
@version{}
– return the current LilyPond version string. Use ‘@w{@version{}}’ if it’s at the end of a line (to prevent an ugly line break in PDF); use ‘@w{"@version{}"}’ if you need it in quotes. -
@w{…}
– do not allow any line breaks. -
@warning{…}
– produce a “Note: ” box. Use for important messages.