Docs: Fix buggy AsciiDoc rendering of backticks
authorRemington Steed <rjs7@calvin.edu>
Thu, 25 May 2017 18:32:57 +0000 (14:32 -0400)
committerRemington Steed <rjs7@calvin.edu>
Thu, 25 May 2017 19:02:58 +0000 (15:02 -0400)
Apparently, AsciiDoc matches backticks (`) with single quotes (') as a
valid quote pair, and this happens before matching a pair of backticks.
So in cases where a pair of backticks is followed by only one single
quote (not within a word), the first backtick is treated as a single
quote, thus breaking the backtick pair and not applying the intended
monospace formatting.

This commit fixes two such cases by escaping the backticks. This doesn't
prevent the same problem in the future, but I haven't found any way to
change this parsing behavior.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
docs/opac/new_skin_customizations.adoc

index 4c2df8a..478c6ca 100644 (file)
@@ -87,7 +87,7 @@ is done by setting the search.metarecord_default variable to 1.
   images with text on them (which is not an acceptable practice for
   accessibility reasons), and promises of answers to frequently asked questions
   that might not exist at your site.
-* `parts/login/password_hint.tt2`: contains a hint about your users' password
+* \`parts/login/password_hint.tt2\`: contains a hint about your users' password
   on first login that is misleading if your library does not set the initial
   password for an account to the last four digits of the phone number associated
   with the account.
@@ -105,7 +105,7 @@ is done by setting the search.metarecord_default variable to 1.
   NOT_STRONG text that appears when the user tries to set a password that
   does not match the required format. Ideally, this message will tell the user
   how they should format the password.
-* `parts/css/fonts.tt2`: defines the font sizes for the TPAC in terms of one
+* \`parts/css/fonts.tt2\`: defines the font sizes for the TPAC in terms of one
   base font size, and all other sizes derived from that in percentages. The
   default is 12 pixels, but http://goo.gl/WfNkE[some design sites] strongly
   suggest a base font size of 16 pixels. Perhaps you want to try '1em' as a