git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chris Johnsen <chris_johnsen@pobox.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
	Chris Johnsen <chris_johnsen@pobox.com>
Subject: [PATCH 8/8] Documentation: option to render literal text as bold for manpages
Date: Tue, 24 Mar 2009 03:04:26 -0500	[thread overview]
Message-ID: <1237881866-5497-9-git-send-email-chris_johnsen@pobox.com> (raw)
In-Reply-To: <1237881866-5497-1-git-send-email-chris_johnsen@pobox.com>

This allows manpages viewed on a tty to render inline literal
text in a manner that is distinct from the surrounding text.

Testing done with asciidoc 8.3.1 and docbook-xsl 1.74.0.

Signed-off-by: Chris Johnsen <chris_johnsen@pobox.com>

---

Since dobcook-xsl 1.74.0 seems to introduce using a monospace
font for literal text (asciidoc backticks), this patch may not be
so important for end users that can install their own
docbook-xsl.

But this patch, or something like it, might be useful for
introducing some kind of typesetting for literal text in the
official manpages (since it would not require upgrading
docbook-xsl). It could probably even be changed/extended to
provide monospacing without using a new docbook-xsl.

The functionality is optional and defaults to "off", so there
probably is not too much harm in including it, even if it is not
used for the official manpages.
---
 Documentation/Makefile                 |    6 +++++-
 Documentation/manpage-bold-literal.xsl |   17 +++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletions(-)
 create mode 100644 Documentation/manpage-bold-literal.xsl

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 11b26aa..238ff83 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -42,6 +42,7 @@ man7dir=$(mandir)/man7
 ASCIIDOC=asciidoc
 ASCIIDOC_EXTRA =
 MANPAGE_XSL = manpage-normal.xsl
+XMLTO_EXTRA =
 INSTALL?=install
 RM ?= rm -f
 DOC_REF = origin/man
@@ -93,6 +94,9 @@ else
 	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
 	endif
 endif
+ifdef MAN_BOLD_LITERAL
+XMLTO_EXTRA += -m manpage-bold-literal.xsl
+endif
 
 #
 # Please note that there is a minor bug in asciidoc.
@@ -192,7 +196,7 @@ $(MAN_HTML): %.html : %.txt
 
 %.1 %.5 %.7 : %.xml
 	$(RM) $@
-	xmlto -m $(MANPAGE_XSL) -m manpage-base.xsl man $<
+	xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) -m manpage-base.xsl man $<
 
 %.xml : %.txt
 	$(RM) $@+ $@
diff --git a/Documentation/manpage-bold-literal.xsl b/Documentation/manpage-bold-literal.xsl
new file mode 100644
index 0000000..608eb5d
--- /dev/null
+++ b/Documentation/manpage-bold-literal.xsl
@@ -0,0 +1,17 @@
+<!-- manpage-bold-literal.xsl:
+     special formatting for manpages rendered from asciidoc+docbook -->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+		version="1.0">
+
+<!-- render literal text as bold (instead of plain or monospace);
+     this makes literal text easier to distinguish in manpages
+     viewed on a tty -->
+<xsl:template match="literal">
+	<xsl:value-of select="$git.docbook.backslash"/>
+	<xsl:text>fB</xsl:text>
+	<xsl:apply-templates/>
+	<xsl:value-of select="$git.docbook.backslash"/>
+	<xsl:text>fR</xsl:text>
+</xsl:template>
+
+</xsl:stylesheet>
-- 
1.6.2.1.214.ge986c

  parent reply	other threads:[~2009-03-24  8:09 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-03-24  8:04 [PATCH 0/8] Documentation: XSLT/asciidoc.conf cleanup; tty literals Chris Johnsen
2009-03-24  8:04 ` [PATCH 1/8] Documentation: move callouts.xsl to manpage-{base,normal}.xsl Chris Johnsen
2009-03-24  8:51   ` Jeff King
2009-03-24 19:36     ` Chris Johnsen
2009-03-26  9:40       ` Jeff King
2009-03-24  8:04 ` [PATCH 2/8] Documentation: use parametrized manpage-base.xsl with manpage-{1.72,normal}.xsl Chris Johnsen
2009-03-24  8:57   ` Jeff King
2009-03-24 19:42     ` Chris Johnsen
2009-03-24  8:04 ` [PATCH 3/8] Documentation: rename docbook-xsl-172 attribute to git-asciidoc-no-roff Chris Johnsen
2009-03-24  9:04   ` Jeff King
2009-03-24 19:48     ` Chris Johnsen
2009-03-26  9:43       ` Jeff King
2009-03-26 16:47         ` Junio C Hamano
2009-03-26 18:49           ` Michael J Gruber
2009-03-24  8:04 ` [PATCH 4/8] Documentation: move quieting params into manpage-base.xsl Chris Johnsen
2009-03-24  9:18   ` Jeff King
2009-03-25  4:21     ` [PATCH 1/2] Documentation/Makefile: make most operations "quiet" Chris Johnsen
2009-03-25  4:21       ` [PATCH 2/2] Documentation/Makefile: break up texi pipeline Chris Johnsen
2009-03-25  4:28       ` [PATCH 1/2] Documentation/Makefile: make most operations "quiet" Jeff King
2009-03-25  9:55         ` Chris Johnsen
2009-03-24  8:04 ` [PATCH 5/8] Documentation: move "spurious .sp" code into manpage-base.xsl Chris Johnsen
2009-03-24  8:04 ` [PATCH 6/8] Documentation: asciidoc.conf: always use <literallayout> for [blocktext] Chris Johnsen
2009-03-24  8:04 ` [PATCH 7/8] Documentation: asciidoc.conf: fix verse block with block titles Chris Johnsen
2009-03-24  8:04 ` Chris Johnsen [this message]
2009-03-26  8:59 ` [PATCH 0/8] Documentation: XSLT/asciidoc.conf cleanup; tty literals 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=1237881866-5497-9-git-send-email-chris_johnsen@pobox.com \
    --to=chris_johnsen@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /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).