From a3718361f89d5f5b115341f02e435658073eb770 Mon Sep 17 00:00:00 2001 From: Mark Polesky Date: Wed, 14 Apr 2010 00:33:49 -0700 Subject: [PATCH] Doc: CG: Fix backslashes in @samp example. --- Documentation/contributor/doc-work.itexi | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index e66e15476e..c299d47d83 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -590,17 +590,20 @@ blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim} are not converted to left- and right-angled quotes (@code{@quoteleft{} @quoteright{}}) as they normally are within the text, so the apostrophes in -@q{@w{@code{@@w@{@@code@{\relative c''@}@}}}} will display +@q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display correctly. However, these settings do not affect the PDF output for anything within a @code{@@samp} block (even if it includes a nested @code{@@code} block), so entering -@q{@code{@@w@{@@samp@{\relative c''@}@}}} wrongly produces -@q{@w{@code{\relative c@quoteright{}@quoteright{}}}} in PDF. +@q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces +@q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF. Consequently, if you want to use a @code{@@samp@{@dots{}@}} block which contains backticks or apostrophes, you should instead use @q{@code{@@q@{@@code@{@dots{}@}@}}} (or @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also -contains spaces). +contains spaces). Note that backslashes within +@code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}}, +so the example above would be coded as +@q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}. @item @code{@@command@{@dots{}@}} --- Use for command-line commands (eg. -- 2.39.5