]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/doc-work.itexi
Docs: remove implicit relative from @lilypond[verbatim]; issue 4371
[lilypond.git] / Documentation / contributor / doc-work.itexi
index 7bf37c72e96d60cf0f20666306548f76435fbbdf..f017041d46d1382fcba61301dfd08484d1debe93 100644 (file)
@@ -401,23 +401,10 @@ Most LilyPond examples throughout the documentation can be produced
 with:
 
 @example
-@@lilypond[verbatim,quote,relative=1]
+@@lilypond[verbatim,quote]
 @end example
 
-or
-
-@example
-@@lilypond[verbatim,quote,relative=2]
-@end example
-
-If using any combination of @code{\header@{@}}, @code{\score@{@}} or
-@code{\layout@{@}} in your example, then you must omit the
-@code{relative} variable and either use absolute entry mode or an
-explicit @code{\relative@{@}} construction.
-
-If using @code{\book@{@}} in your example then you must also omit the
-@code{relative} variable and either use absolute entry mode or an
-explicit @code{\relative@{@}} construction.  However, you must also
+If using @code{\book@{@}} in your example then you must also
 include the @code{papersize=X} variable, where @code{X} is a defined
 paper size from within @file{scm/paper.scm}.  This is to avoid the
 default @code{a4} paper size being used and leaving too much unnecessary
@@ -460,8 +447,8 @@ Please avoid using extra spacing either after or within the
 @code{@@lilypond} parameters.
 
 @example
-not:          @@lilypond [verbatim, quote, relative=1]
-but instead:  @@lilypond[verbatim,quote,relative=1]
+not:          @@lilypond [verbatim, quote, fragment]
+but instead:  @@lilypond[verbatim,quote,fragment]
 @end example
 
 @item
@@ -945,6 +932,18 @@ the same format as @code{@@enumerate}.  Do not use
 @node Special characters
 @unnumberedsubsubsec Special characters
 
+@warning{In Texinfo, the backslash is an ordinary character, and
+is entered without escaping (e.g.
+@samp{The@tie{}@@code@{@bs{}foo@}@tie{}command}).  However, within
+double-quoted Scheme and/or LilyPond strings, backslashes
+(including those ending up in Texinfo markup) need to be escaped
+by doubling them:
+@example
+(define (foo x)
+  "The @@code@{@bs{}@bs{}foo@} command..."
+  ...)
+@end example}
+
 @itemize
 @item
 @code{--}, @code{---} --- Create an en dash (--) or an em dash