From 0535b7262f9fbd79efd2dd471971c1d94fcc3bf5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Thu, 12 Nov 2020 00:56:40 +0100 Subject: regen (change terminology) --- index.html | 176 ++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 99 insertions(+), 77 deletions(-) diff --git a/index.html b/index.html index 23462fd..9fd23dc 100644 --- a/index.html +++ b/index.html @@ -33,17 +33,17 @@ Furthermore, you never run the risk of accidentally losing the references attached to a document.

-
  • rf is around 150 lines of Perl. If you find a bug - or an (in your opinion) undesirable behavior in +
  • rf consists of circa 200 lines of Perl. If you + find a bug or an (in your opinion) undesirable behavior in rf, you can easily patch it.
    • -
  • Finally, rf is much more simple and offers much - more basic functionality than refer(1). This means that - you can learn all of it in five minutes.
    • +
  • Finally, rf is much simpler, much less opaque and + offers much more basic functionality than refer(1). You + can learn all of it in five minutes.

    • The performance of rf primarily depends on - the number of entries in the reference list at the end of the document. On - my HP Compaq dc5700 from 2007, the relationship between number of entries in - the reference list and total execution time is roughly the following:

    + the number of references (but not citations). On my HP Compaq dc5700 from + 2007, the relationship between number of references and total execution time + is roughly the following:

    @@ -51,56 +51,69 @@ - + - + - - + + - - + + + + + + + + + + + + + +
    Entries    
    30.03s0.01s
    500.09s0.07s
    1070.15s1000.14s
    1820.24s2000.26s
    5000.65s
    2,0002.59s
    10,00012.94s
    -

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

    +

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

    -rf is controlled by several macros, all consisting of - one uppercase and one lowercase letter, beginning with either an - ‘F’ or an ‘R’. Macros beginning with - ‘R’ control the two primary “units” of - rf: -
      -
    1. entries in the reference list, and
      2. -
    2. inline references to these entries.
      3. -
    -

    Macros beginning with ‘F’, in turn, control the - appearance of these two units.

    +rf provides two features, which it calls + references and citations: +
    +
    reference
    +
    a bibliographic entry written at the end of the document
    +
    citation
    +
    an inline reference to a bibliographic entry
    +
    +

    rf is controlled by several macros, all + consisting of one uppercase and one lowercase letter, beginning with either + an ‘R’ – macros controlling references and citations + – or an ‘F’ – macros controlling the appearance + of references and citations.

    -You can control the appearance of your references as they are displayed in-line - as well as in the final reference list by using the format macros. +These macros control control the appearance of references and citations.
    -
    Fe
    -
    Defines the format for reference list entries. +
    Fr
    +
    Defines the format for references in the bibliography.

    Default: %a (%y). {\fI%t\fR}. {\*Q%q\*U}. %n, %d. %c: %p. {Available: %w.}

    Ff
    -
    Defines the format for “full” inline references, which by - default contain both author and year. +
    Defines the format for “full” citations, which by default + contain both author and year.

    Default: (%A %y)

    Fx
    -
    Defines the format for “alternate” inline references, which - by default contain only the year. +
    Defines the format for “alternate” citations, which by + default contain only the year.

    Default: (%y)

    @@ -108,17 +121,18 @@ You can control the appearance of your references as they are displayed in-line FORMAT SYNTAX.

    -

    -In the reference list, each entry is defined by a contiguous - block of lines containing definition macros, describing various - fields belonging to the reference, such as author and year. - The definition of one reference is separated from that of another by any other - lines, including text lines and empty lines. +In the reference list or bibliography, a single reference is defined by a + contiguous block of lines containing any of the macros + described below. The definition of one reference is separated from that of + another by any other lines, including text lines, empty + lines and lines containing other macros than the ones listed below.
    Ra
    -
    Adds to the list of authors of the current reference. -

    Format: Surname(s), Forename(s)

    +
    Defines the author of the publication. You can use + Ra more than once in order to define multiple authors. +

    Format: Surname, Forename/Initial

    Rc
    Defines the city of publication.
    @@ -141,49 +155,57 @@ In the reference list, each entry is defined by a contiguous
    Defines the year of publication.

    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.

    + version of each reference in place of its definition. + rf does not change the order of reference. This + means that you can arrange your references freely.

    -

    -To insert an inline reference to an entry in the reference list, you can use one - of two macros: +

    +To insert a citation, you can use one of two macros:
    Rf
    -
    Inserts a “full” inline reference, which usually contains - both author and year.
    +
    Inserts a “full” citation, which usually contains both + author and year.
    Rx
    -
    Inserts an “alternate” inline reference, which usually - contains only the year.
    +
    Inserts an “alternate” citation, which usually contains only + the year.
    -

    What reference to refer to is specified by the rest of the line. - Each word of it is matched against the author, year and title of all - references to find a match. If only a weak match is found, a warning is - printed on standard error.

    -

    To include some punctuation character immediately after the inline - reference, add a space before it:

    +

    Reference identification.  After the + macro name, you should provide one or more keywords to identify the + reference to which the citation is to refer. Each word is matched + case-insensitively against the author, year and title of all references. For + example:

    +
    +
    +.Rf Trubetzkoy 1969
+
    +
    +

    If only a weak match is found, a helpful warning is printed on + standard error.

    +

    Adjacent punctuation.  To include some + punctuation character immediately after the inline reference, use the + following syntax:

    -.Rf Johnson 92 .
+.Rf Grot 1873 .

    To wrap the inline reference in parentheses, use the following syntax:

    -.Rf Johnson 92 ) (
+.Rf Courtenay 1972 ) (
    -

    Additionally, any instance of '' is - replaced with the last word on the preceding line. This allows the following - shortcut:

    +

    Shortcuts.  Any instance of + '' is replaced with the last word on the preceding + line. This allows the following shortcut:

    -According to Johnson
-.Rx '' 92 ,
-there has been a gradual change in attitudes towards ...
+According to Brandt
+.Rx '' 1892 ,
+Russian differs from other European languages in its [...]
    @@ -193,10 +215,10 @@ there has been a gradual change in attitudes towards ... SYNTAX

    -In a format definition, use a percent (%) sigil followed by a single letter to - interpolate any given field of the reference. The letter following the percent - sign corresponds to the second letter of the reference list macros described - above. For example: +In a format specification, use a percent (%) sigil followed by a single letter + to interpolate any given field of the reference. The letter following the + percent sign corresponds to the second letter of the reference list macros + described above. For example: 
     .Ff (%A, %y)      \" (Author, Year)
@@ -220,13 +242,13 @@ In a format definition, use a percent (%) sigil followed by a single letter to
 
      
   
    1. A backslash at the end of a format line acts as a line continuation
       marker. The newline after the backslash is preserved.
      2. 
-  
    2. For format macros describing inline references, a backslash immediately
-      following the macro name will cause the reference be joined to the
-      preceding line.
      3. 
+  
    3. For format macros describing citations, a backslash immediately following
+      the macro name will cause the reference be joined to the preceding
+    line.
      4. 
 
    
 
    Anywhere else in the line, backslashes are preserved
   literally.
    
-
    By using backslashes, you can implement footnote-based references.
+
    By using backslashes, you can implement footnote-based citations.
     For example, using the ms macro package:
    
 
    
 
    @@ -328,7 +350,7 @@ Smith, P. (2007).  \fIModern Society\fR.  Athens: Logos.
 
    
 
-    
+    
    
   
    November 11, 2020November 12, 2020
     Linux 5.4.72-0-lts
   
    
 
    
-- 
cgit v1.2.3