Re: Issue 4002: Mention backslash escaping in Scheme. (issue 112040043 by address@hidden)

[markpolesky]

Reviewers: dak,

Message:
On 2014/07/09 23:46:36, dak wrote:

https://codereview.appspot.com/112040043/diff/1/Documentation/contributor/doc-work.itexi#newcode950
> Documentation/contributor/doc-work.itexi:950:
> @address@hidden@@address@hidden@address@hidden@tie{}command}).  However, if a
> Why write @bs{} instead of \ here?

Because we're in a @warning block.


https://codereview.appspot.com/112040043/diff/1/Documentation/contributor/doc-work.itexi#newcode951
> Documentation/contributor/doc-work.itexi:951: Texinfo string is within
a block
> of Scheme code, it must be
> That's incorrect.  Correct would be:
> However, within double-quoted Scheme and/or LilyPond strings,
backslashes
> (including those ending up in Texinfo markup) need to be escaped by
doubling
> them.

> There is no such thing as a "Texinfo string", and it is not contained
in "Scheme
> code" but rather in strings.

Okay


https://codereview.appspot.com/112040043/diff/1/Documentation/contributor/doc-work.itexi#newcode955
> Documentation/contributor/doc-work.itexi:955: "The
@@address@hidden@address@hidden@}
> command..."
> That's awfully unreadable source code.  I'd be tempted to use
@verbatim instead
> in order to avoid all the Texinfo escapes.  Also there is no point in
writing
> @address@hidden instead of \\ here.

Again, I think the @bs{} is needed in a @warning block, but I'll try
verbatim.

Thanks,
Mark


Description:
Clarify confusion about address@hidden' vs. address@hidden'.

Issue on tracker:
http://code.google.com/p/lilypond/issues/detail?id=4002

Please review this at https://codereview.appspot.com/112040043/

Affected files (+12, -0 lines):
  M Documentation/contributor/doc-work.itexi


Index: Documentation/contributor/doc-work.itexi
diff --git a/Documentation/contributor/doc-work.itexi  
b/Documentation/contributor/doc-work.itexi
index  
7bf37c72e96d60cf0f20666306548f76435fbbdf..be55aa42955e51b57f4360253b7f11603d769f09  
100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -945,6 +945,18 @@ the same format as @code{@@enumerate}.  Do not use
 @node Special characters
 @unnumberedsubsubsec Special characters

address@hidden Texinfo, the backslash is an ordinary character, and
+is entered without escaping (e.g.
address@hidden@tie{}@@address@hidden@address@hidden@tie{}command}).  However, 
if a
+Texinfo string is within a block of Scheme code, it must be
+escaped:
address@hidden
+(define (foo x)
+  "The @@address@hidden@address@hidden@} command..."
+  ...)
address@hidden example
+}
+
 @itemize
 @item
 @code{--}, @code{---} --- Create an en dash (--) or an em dash