summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2004-03-27 17:09:13 +0000
committerSimon Tatham <anakin@pobox.com>2004-03-27 17:09:13 +0000
commit58cee09140826d377a1e20cb4b0d064723d1355e (patch)
treea99b8ffce5d7ad58b976ee35d996424eaf88015c /doc
parent415a2e6c2bc96a038afd318efade56d7cd8b0eff (diff)
downloadhalibut-58cee09140826d377a1e20cb4b0d064723d1355e.zip
halibut-58cee09140826d377a1e20cb4b0d064723d1355e.tar.gz
halibut-58cee09140826d377a1e20cb4b0d064723d1355e.tar.bz2
halibut-58cee09140826d377a1e20cb4b0d064723d1355e.tar.xz
Couple of extra points: forgot about the \i\cw special case, and
Jacob points out that I didn't specify whether inline formatting commands can surround line breaks (they can). [originally from svn r3994]
Diffstat (limited to 'doc')
-rw-r--r--doc/input.but13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/input.but b/doc/input.but
index 31c9f8d..a52735e 100644
--- a/doc/input.but
+++ b/doc/input.but
@@ -65,6 +65,17 @@ commands, which means you can use them in the middle of a paragraph.
\K{input-para} describes some \e{paragraph} commands, which affect a
whole paragraph at a time.
+Many of these commands are followed by a pair of braces surrounding
+some text. In all cases, it is perfectly safe to have a line break
+(in the input file) within those braces; Halibut will treat that
+exactly the same as a space. For example, these two paragraphs will
+be treated identically:
+
+\c Here is some \e{emphasised
+\c text}.
+\c
+\c Here is some \e{emphasised text}.
+
\S{input-emph} \c{\\e}: Emphasising text
Possibly the most obvious piece of formatting you might want to use
@@ -1016,7 +1027,7 @@ You can wrap more than one word in \c{\\i} as well:
\S{input-index-special} Special cases of indexing
If you need to index a computer-related term, you can use the
-special case \c{\\i\\c}:
+special case \c{\\i\\c} (or \c{\\i\\cw} if you prefer):
\c The \i\c{grep} command is what you want here.