aboutsummaryrefslogtreecommitdiff
path: root/rf.1
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2020-11-11 15:13:38 +0100
committerJohn Ankarström <john@ankarstrom.se>2020-11-11 15:13:44 +0100
commitcd225683d4414006c9422ff23076d88638af1794 (patch)
treedfc713cd15b0379310418f4d67c7642cfc55b42e /rf.1
parentcd6d3a48204415f4547048db0f4d0ac7b9414ffc (diff)
downloadrf-cd225683d4414006c9422ff23076d88638af1794.tar.gz
add backslash escaping, auto-remove more punctuation
Diffstat (limited to 'rf.1')
-rw-r--r--rf.128
1 files changed, 22 insertions, 6 deletions
diff --git a/rf.1 b/rf.1
index d85121b..fbf429f 100644
--- a/rf.1
+++ b/rf.1
@@ -189,16 +189,32 @@ For example:
\&.Ff (%a{, %y}). \\" Here, ', ' is removed if there is no year.
.Ed
.Pp
-Note that all fields are inserted literally, except
-.Em %a ,
-from which the forenames of the authors are removed.
+You can include a newline in your format by ending the line with a backslash and continuing on the next line.
+If you add a backslash immediately following the macro name, the interpolated format will be joined to the preceding line.
+By using backslashes, you can implement footnote-based references.
+For example, using the ms macro package:
+.Bd -literal -offset indent
+\&.Fx\\ \\**\\
+\&.FS\\
+%A, {\\fI%t\\fR}, {\\*Q%q\\*U}, %y.\\
+\&.FE
+.Ed
.Pp
-Note also that you can use troff requests and other macros in your format by starting with a dot. This will expand to a valid request/macro in the output of
+As you can see above, you can use troff requests and other macros in your format.
+This will expand to a valid request/macro in the output of
.Nm .
.Pp
-Finally, you usually don't need to worry about excessive spaces and stray punctuation marks, as
+Note that all fields are inserted literally, with one exception:
+when
+.Em %a
+is used in an inline reference format, the forenames of the authors are automatically removed.
+To include the forenames, use
+.Em %A
+instead.
+.Pp
+Finally, you usually don't need to worry about excessive spaces and stray punctuation marks.
.Nm
-removes many of these these automatically.
+removes common punctuation immediately preceding and following an unsuccessful interpolation.
.
.Sh EXAMPLE
Below is an example of an ms-based troff document using