summaryrefslogtreecommitdiff
path: root/doc/output.but
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2004-07-16 11:54:04 +0000
committerSimon Tatham <anakin@pobox.com>2004-07-16 11:54:04 +0000
commitea8075f55ea0bfc2ed04c9efa0e03c2468962eec (patch)
tree9fbae41eab16b105968a338b85ecd968159b22a4 /doc/output.but
parenta5e910448b26d9d77af462c0634ab34b0a465d0d (diff)
downloadhalibut-ea8075f55ea0bfc2ed04c9efa0e03c2468962eec.zip
halibut-ea8075f55ea0bfc2ed04c9efa0e03c2468962eec.tar.gz
halibut-ea8075f55ea0bfc2ed04c9efa0e03c2468962eec.tar.bz2
halibut-ea8075f55ea0bfc2ed04c9efa0e03c2468962eec.tar.xz
Right; I'm finally sick of typing \q{\cw{foo}}, so I've invented a
shorthand command \cq{foo}. [originally from svn r4327]
Diffstat (limited to 'doc/output.but')
-rw-r--r--doc/output.but28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/output.but b/doc/output.but
index 6cf2e7d..964f49d 100644
--- a/doc/output.but
+++ b/doc/output.but
@@ -144,7 +144,7 @@ be prefixed by \q{Chapter} or equivalent.
\dd This specifies the suffix text to be appended to the chapter
number, before displaying the chapter title. For example, if you set
-this to \q{\cw{:\_}}, then the chapter title might look something
+this to \cq{:\_}, then the chapter title might look something
like \q{Chapter 2: Doing Things}.
\dt \I{\cw{\\cfg\{text-section-align\}}}\cw{\\cfg\{text-section-align\}\{}\e{level}\cw{\}\{}\e{alignment}\cw{\}}
@@ -215,7 +215,7 @@ and resort to the ASCII asterisk if all else failed.
\i{horizontal rules} (generated by \i\c{\\rule}; see
\k{input-rule}). It can be one character, or more than one. The
string you specify will be repeated to reach the required width, so
-you can specify something like \q{\cw{-=}} to get a rule that looks
+you can specify something like \cq{-=} to get a rule that looks
like \cw{-=-=-=}.
\lcont{
@@ -364,15 +364,15 @@ The formatting commands used in this template are:
\dt \I{%N-upper}\c{%N}
\dd Expands to the visible title of the section, with white space
-removed. So in a chapter declared as \q{\cw{\\C\{fish\} Catching
-Fish}}, this formatting command would expand to
-\q{\cw{CatchingFish}}.
+removed. So in a chapter declared as \cq{\\C\{fish\} Catching
+Fish}, this formatting command would expand to
+\cq{CatchingFish}.
\dt \i\c{%n}
\dd Expands to the type and number of the section, without white
-space. So in chapter 1 this would expand to \q{\cw{Chapter1}}; in
-section A.4.3 it would expand to \q{\cw{SectionA.4.3}}, and so on.
+space. So in chapter 1 this would expand to \cq{Chapter1}; in
+section A.4.3 it would expand to \cq{SectionA.4.3}, and so on.
If the section has no number (an unnumbered chapter created using
\c{\\U}), this directive falls back to doing the same thing as
\c{%N}.
@@ -380,16 +380,16 @@ If the section has no number (an unnumbered chapter created using
\dt \i\c{%b}
\dd Expands to the bare number of the section. So in chapter 1 this
-would expand to \q{\cw{1}}; in section A.4.3 it would expand to
-\q{\cw{A.4.3}}, and so on. If the section has no number (an
+would expand to \cq{1}; in section A.4.3 it would expand to
+\cq{A.4.3}, and so on. If the section has no number (an
unnumbered chapter created using \c{\\U}), this directive falls back
to doing the same thing as \c{%N}.
\dt \i\c{%k}
\dd Expands to the internal keyword specified in the section title.
-So in a chapter declared as \q{\cw{\\C\{fish\} Catching Fish}}, this
-formatting command would expand to \q{\cw{fish}}. If the section has
+So in a chapter declared as \cq{\\C\{fish\} Catching Fish}, this
+formatting command would expand to \cq{fish}. If the section has
no keyword (an unnumbered chapter created using \c{\\U}), this
directive falls back to doing the same thing as \c{%N}.
@@ -560,7 +560,7 @@ be prefixed by \q{Chapter} or equivalent.
\dd This specifies the suffix text to be appended to the chapter
number, before displaying the chapter title. For example, if you set
-this to \q{\cw{:\_}}, then the chapter title might look something
+this to \cq{:\_}, then the chapter title might look something
like \q{Chapter 2: Doing Things}.
\dt \I{\cw{\\cfg\{xhtml-section-numeric\}}}\cw{\\cfg\{xhtml-section-numeric\}\{}\e{level}\cw{\}\{}\e{boolean}\cw{\}}
@@ -585,7 +585,7 @@ particular level, before displaying the section title.
same syntax used in \cw{\\cfg\{xhtml-template-filename\}} (see
\k{output-html-file}), to be used for the anchor names (\i\cw{<A
NAME="...">}) used to allow URLs to refer to specific sections
-within a particular HTML file. So if you set this to \q{\cw{%k}},
+within a particular HTML file. So if you set this to \cq{%k},
for example, then each individual section in your document will be
addressable by means of a URL ending in a \c{#} followed by your
internal section keyword.
@@ -1017,7 +1017,7 @@ directive (see \k{output-text-dimensions}).
\dd Specifies the suffix text to be appended to each section number
before displaying the section title. For example, if you set this to
-\q{\cw{:\_}}, then a typical section title might look something like
+\cq{:\_}, then a typical section title might look something like
\q{Section 3.1: Something Like This}.
\dt \I{\cw{\\cfg\{info-underline\}}}\cw{\\cfg\{info-underline\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]