From: Thomas Rast <trast@student.ethz.ch>
To: <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Quote ' as \(aq in manpages
Date: Wed, 21 Oct 2009 10:24:42 +0200 [thread overview]
Message-ID: <ab31eb03b25272341b91e1f1132dab9d8a49e5b6.1256113282.git.trast@student.ethz.ch> (raw)
In-Reply-To: <200910151402.56295.trast@student.ethz.ch>
The docbook/xmlto toolchain insists on quoting ' as \'. This does
achieve the quoting goal, but modern 'man' implementations turn the
apostrophe into a unicode "proper" apostrophe (given the right
circumstances), breaking code examples in many of our manpages.
Quote them as \(aq instead, which is an "apostrophe quote" as per the
groff_char manpage.
Signed-off-by: Thomas Rast <trast@student.ethz.ch>
---
I've had this around since my last rant, and it actually gives good
results with both setups I can test on, which are:
- asciidoc 8.4.5, docbook-xsl 1.75.2, xmlto 0.0.18
- asciidoc 8.2.7, docbook-xsl 1.73.2, xmlto 0.0.20
Documentation/manpage-base.xsl | 9 +++++++++
1 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/Documentation/manpage-base.xsl b/Documentation/manpage-base.xsl
index a264fa6..bf74bb7 100644
--- a/Documentation/manpage-base.xsl
+++ b/Documentation/manpage-base.xsl
@@ -7,6 +7,15 @@
<xsl:param name="man.output.quietly" select="1"/>
<xsl:param name="refentry.meta.get.quietly" select="1"/>
+<xsl:template name="escape.apostrophe">
+ <xsl:param name="content"/>
+ <xsl:call-template name="string.subst">
+ <xsl:with-param name="string" select="$content"/>
+ <xsl:with-param name="target">'</xsl:with-param>
+ <xsl:with-param name="replacement">\(aq</xsl:with-param>
+ </xsl:call-template>
+</xsl:template>
+
<!-- convert asciidoc callouts to man page format;
git.docbook.backslash and git.docbook.dot params
must be supplied by another XSL file or other means -->
--
1.6.5.1.144.g40216
next prev parent reply other threads:[~2009-10-21 8:25 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-10-12 10:29 quote in help code example bill lam
2009-10-12 19:40 ` Miklos Vajna
2009-10-13 2:16 ` bill lam
2009-10-13 10:19 ` Miklos Vajna
2009-10-13 14:06 ` bill lam
2009-10-13 15:30 ` Miklos Vajna
2009-10-13 20:15 ` Thomas Rast
2009-10-15 12:02 ` Thomas Rast
2009-10-21 8:24 ` Thomas Rast [this message]
2009-10-21 10:38 ` [PATCH] Quote ' as \(aq in manpages Miklos Vajna
2009-10-21 18:01 ` Anders Kaseorg
2009-10-21 18:57 ` [PATCH v2] " Thomas Rast
2009-10-21 21:31 ` [PATCH] Document GNU_ROFF in Makefile Miklos Vajna
2009-10-21 22:22 ` Junio C Hamano
2009-10-21 22:51 ` Anders Kaseorg
2009-10-22 8:19 ` [PATCH v3] Quote ' as \(aq in manpages Thomas Rast
2009-10-21 21:42 ` [PATCH v2] " Anders Kaseorg
2009-10-12 21:06 ` quote in help code example Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ab31eb03b25272341b91e1f1132dab9d8a49e5b6.1256113282.git.trast@student.ethz.ch \
--to=trast@student.ethz.ch \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).