]> git.donarmstrong.com Git - lilypond.git/commitdiff
Mention backslash escaping in Scheme.
authorMark Polesky <markpolesky@yahoo.com>
Wed, 9 Jul 2014 21:40:31 +0000 (14:40 -0700)
committerMark Polesky <markpolesky@yahoo.com>
Wed, 16 Jul 2014 06:03:44 +0000 (23:03 -0700)
Clarify confusion about `@code{\foo}' vs. `@code{\\foo}'.

Documentation/contributor/doc-work.itexi

index 7bf37c72e96d60cf0f20666306548f76435fbbdf..cdd069ed5dc22d3fa5d9b59cb954f4eacad63798 100644 (file)
@@ -945,6 +945,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