From f6796338ea3b588d2cfbfc9e9a25a5894429a54d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Wed, 11 Nov 2020 12:57:25 +0100 Subject: regenerate (example, clarifications) --- index.html | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 80 insertions(+), 4 deletions(-) (limited to 'index.html') diff --git a/index.html b/index.html index 84b4bb5..579518a 100644 --- a/index.html +++ b/index.html @@ -66,7 +66,7 @@ 0.24s -

I would deem it rare to have more than a couple of hundred +

I would deem it rare to have more than a couple of hundred unique references in a troff document.

@@ -167,8 +167,10 @@ there has been a gradual change in attitudes towards ...
Ry
Defines the year of publication.
-

Of these macros, Ra and Ry are - the most important.

+

In the final output, rf prints a formatted + version of each reference entry in place of its definition. + rf does not change the order of reference entries. + This means that you can arrange your references freely.

@@ -194,15 +196,89 @@ In a format definition, use a percent (%) sigil followed by a single letter to

Note that all fields are inserted literally, except %a, from which the forenames of the authors are removed.

+

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 rf.

Finally, you usually don't need to worry about excessive spaces and stray punctuation marks, as rf removes many of these these automatically.

+

+Below is an example of an ms-based troff document using + rf references. +
+
+.de noop
+..
+.blm noop
+
+.SH
+Previous work
+
+.LP
+Davidson
+.Rx '' 1991
+has performed a study [...]
+
+.PP
+[...] which leads to a higher total cholesterol level
+.Rf Smith 2007 .
+
+.SH
+Literature
+
+.XP
+.Ra Davidson, H.
+.Ry 1991
+.Rt Seminal Work
+.Rc London
+.Rp Another Press
+
+.XP
+.Ra Smith, P.
+.Ry 2007
+.Rt Modern Society
+.Rc New York
+.Rp Some Press
+
+
+

When given the above file, rf will output + the following code:

+
+
+.de noop
+..
+.blm noop
+
+.SH
+Previous work
+
+.LP
+Davidson
+(1991)
+has performed a study [...]
+
+.PP
+[...] which leads to a higher total cholesterol level
+(Smith 2007).
+
+.SH
+Literature
+
+.XP
+Davidson, H. (1991). \fISeminal Work\fR. London: Another Press.
+
+.XP
+Smith, P. (2007). \fIModern Society\fR. New York: Some Press.
+
+
+
+

rf was written by John Ankarström <john - (on) + (at) ankarstrom.se>.
-- cgit v1.2.3