Back to Table of Contents

Next: Writing letters

Bibliographies and references

Introduction to bibliographies and references

Mom provides the ability to format and generate bibliographies, as well as footnote or endnote references, in MLA (Modern Language Association) style. She accomplishes this by working in conjunction with a special groff program called refer.

Refer requires first that you create a database of works that will be cited in your documents. Once that’s done, special macros let you briefly key in references to entries in the database and have mom format them with respect to order, punctuation and italicization in footnotes, endnotes, or a full bibliography.

Refer has been around for a long time. It’s powerful and has many, many features. Unfortunately, the manpage (man refer), while complete and accurate, is dense and not a good introduction. (It’s a classic manpage Catch-22: the manpage is useful only after you know how to use the program.)

In order to get mom users up and running with refer, this section of mom’s documentation focuses exclusively, in a recipe-like manner, on what you need to know to use refer satisfactorily in conjunction with mom. The instructions are not to be taken as a manual on full refer usage.

If you’re already a refer user, the information herein will be useful for adapting your current refer usage to mom’s way of doing things. If you’ve never used refer, the information is essential, and, in many cases, may be all you need.

I encourage anyone interested in what MLA style looks like—and, by extension, how your bibliographies and references will look after mom formats them—to check out
http://www.aresearchguide.com/12biblio.html or any other website or reference book on MLA style.

MLA (Modern Language Association) style

Types of references (endnote/footnote or bibliographic)

MLA allows for three types of references, or referencing styles:

• short, parenthetical references in the text, linked to a list of works cited (a bibliography) at the end of the document
• footnote references
• endnote references

There are significant differences between the way footnote/endnote references should be formatted, and the formatting style of bibliographies. One example is that footnote/endnote references should have their first lines indented, whereas bibliographic references should have their second lines indented. Fortunately, with mom, there’s no need to concern yourself with the differences; they’re taken care of automatically.

In terms of inserting references into your documents, footnote/endnote references are input in a manner similar to entering any other kind of footnote or endnote. Parenthetical references linked to a bibliography, however, need to be handled differently.

Inserting parenthetical references into the text

MLA style prefers restricting the information in parenthetical references to the barest minimum needed to find the cited work in the bibliography. Human judgment is usually required, therefore it is generally best to enter the parenthetical references by hand rather than asking mom and refer to generate them. While the latter is possible with the macro pair, .REF( /.REF), it requires more work to set up your database and interrupts the flow of your input file. Consider these two examples, which accomplish exactly the same thing:

versus

Clearly, the first example takes less work, and is much easier to read.

The refer database

Introduction

The heart and soul of refer is the bibliographic database. Knowing how to create records (ie. the entries for works cited in a document) is largely a question matching data (author, title, publisher, etc) with the correct field identifier. For example, if you’re citing from a scholarly journal, you need to know that %J is the field identifier for journal names and %N is the field identifier for the journal number. Use the Quick list of field identifiers as your guide.

The rules

Entering the data correctly is also important. Fortunately, there are very few rules, and those there are make sense. In a nutshell:

• enter the data in each field in natural order; author John Smith is “John Smith”, editor Jane Doe is “Jane Doe”
• capitalize all proper nouns and words in titles as you expect to see them; otherwise, use lowercase
• use no terminating punctuation unless required; typically, required punctuation is the period after a shortform (“ed.” or “eds.”, “Jr.”, etc) or a question mark or exclamation mark at the end of a title
• if part of a field needs to be set off in single-quotes, use \[oq] and \[cq] (openquote, closequote) rather than the single-quote (or apostrophe) character on your keyboard
• if part of a field needs to be forced into italics, use the escapes \*[IT] and \*[PREV]; if the italicized portion concludes the field, omit \*[PREV]
• if you require characters with accents, ligatures or special symbols, use groff’s “named” glyphs (eg. \['e] for é); a full list can be found in man groff_char

Quick guide to field identifiers (click on any that are links for more information)

Field identifiers: specifics, usage and examples

%A – author field

For multiple authors, enter each in a separate %A field in the order in which they should appear. If the author on the title page is the editor (say, a book of short stories edited by Ray Bradbury), add , ed. to the end of the %A field, like this:
%A Ray Bradbury, ed. Do not use the %E field in these instances. If the work has several such editors, enter each in a separate %A field, as for multiple authors, and add , eds. to the last one, like this:
%A Jane Dearborne %A Bill Parsons, eds.

%Q – exceptional entries

Sometimes, a work has no author or title information, for example a book review in a newspaper. In such cases, use %Q, like this:
%Q Rev. of \*[IT]Mean Streets Omnibus\*[PREV], ed. Raymond Hammett %M Times Literary Supplement %D 7 July 1972

%m – multiple authors (et al.)

Whenever it’s desirable to abbreviate a list of authors with “et al.” enter it in the %m field, like this:
%A Paul Lauter %A Doug Scofield %m et al.

%i – idem

Whenever there are several works by the same author, fill out the %A field with the author’s name and follow it with the %i idem, like this:
%A Jonathon Schmidt %i idem Per MLA style, the author’s name will be replaced by a long dash.

If it’s necessary to state the role the author served (say, editor or translator), fill out the %i field with the information minus idem, like this:
%A Ray Bradbury %i ed. %T Timeless Stories for Today and Tomorrow

%p – post-author information

When citing from a preface, foreword, introduction, afterword or appendix, MLA requires that the information come between the author’s name and the work’s title, like this:
%A Martin Packham, Jr. %p appendix %T Why the West was Won Do not capitalize the first word in the %p field unless it is a proper noun.

%q – force title into double-quotes

Occasionally, you may not be able to use %T for the title because doing so will cause it to come out in italics when double-quotes are called for. An example of this is when citing from a dissertation. Use %q to get around the problem, like this:
%A Carol Sakala %q Maternity Care Policy in the United States %O diss., Boston U, 1993

%E – editor

Use this only if the author and the editor are not one in the same, eg
%A Geoffrey Chaucer %T The Works of Geoffrey Chaucer %E F. W. Robinson

%l – translator

If there is more than one translator, enter all the names, with appropriate conjunctions and punctuation, like this:
%A Feodor Dostoevsky %T Crime and Punishment %l Jessie Coulson, Marjorie Benton, and George Bigian

%O – other

Occasionally, MLA requires additional information after the title but before the publication data (city/publisher/date), for instance, the number of volumes in a series, or the fact that the work cited is a dissertation. Here are two examples:
%A Arthur M. Schlesinger %T History of U.S. Political Parties %O 4 vols. %C New York %I Chelsea %D 1973 %A Carol Sakala %q Maternity Care Policy in the United States %O diss., Boston U, 1993 Do not capitalize the first word of the %O field unless it is a proper noun.

Generally, consider %O a catch-all for information that does not match the criterion of any existing field identifier.

%C – city

Normally, %C takes the name of the city of publication, and that’s all. In the case of a republished book, if new material has been added, put such information in the %C field, like this:
%A Theodore Dreiser %T Sister Carrie %d 1900 %C Introd. E. L. Doctorow, New York

%d – original date of publication

Normally, all that is required in the %d field is the original date of publication. However, if supplementary original publication data is desired, include it in the field, like this:
%A Kazuo Ishiguro %T The Remains of the Day %d London: Faber, 1989 %D New York %I Knopf %D 1990

%K – keywords

Refer hates ambiguity, and complains when encountering it. Ambiguities result from the duplication of any word in more than one database record when that word is used to identify a reference in your input file. Use %K to create unique keywords found nowhere else in the database.

Imagine, for example, that your database contains records for Ray Bradbury’s The Illustrated Man, another record for The Illustrated Bradbury and a third for Bradbury, Illustrated. %K can be used to clear up any ambiguities by assigning a unique word to each record, for example %K ill-man for the first, %K ill-brad for the second, and %K brad-ill for the third.

%P – pages

When citing page numbers, which is often the case with footnotes and endnotes, it is not necessary to put the numbers in the database records. The %P field can be added underneath the keyword(s) in the .[ / .] entries in your input file, allowing you to recycle database records. For example,
%A Frye %T Anatomy %K frye-anat could be your short record for Northrop Frye’s The Anatomy of Criticism. Any time you wanted to cite a particular page or range of pages from that work in a footnote or endnote, you can put
.REF .[ frye-anat %P 67-8 .] .REF in your input file, and have it show up with the correct page(s).

%n – annotations

Annotations come at the very end of references. Capitalize all words that require it, including, for bibliographic references (but not for footnotes/endnotes) the first.

The macro, REF, tells mom that what follows is refer-specific, a keyword-identified reference from a refer database. Depending on whether you’ve issued a .FOOTNOTE_REFS or .ENDNOTE_REFS instruction, REF also tells mom where to place the reference. If FOOTNOTE_REFS, the reference will be formatted and placed in a footnote. If ENDNOTE_REFS, the reference will be collected for output as an endnote. If you have issued neither instruction, the reference will be collected for later output, most likely in a bibliography.

Before you use REF, you must create a refer block containing refer commands (see Required refer commands in the tutorial, above).

REF usage always looks like this:
.REF .[ keyword(s) .] .REF Notice that REF “brackets” the refer instructions, and never takes an argument.

What REF really is is a convenience. One could, for example, put a reference in a footnote by doing
.FOOTNOTE .[ keyword(s) .] .FOOTNOTE OFF However, if you have a lot of references going into footnotes (or endnotes), it’s much shorter to type .REF/.REF than .FOOTNOTE/.FOOTNOTE OFF. It also helps you distinguish—visually, in your input file—between footnotes (or endnotes) which are references, and footnotes (or endnotes) which are explanatory, or expand on the text.

FOOTNOTE_REFS is an instruction to REF, saying, “put all subsequent references bracketed by the REF macro into footnotes.” You invoke it by itself, with no argument.

When FOOTNOTE_REFS is in effect, regular footnotes, (ie those introduced with .FOOTNOTE and terminated with .FOOTNOTE OFF) continue to behave normally.

You may switch between FOOTNOTE_REFS and ENDNOTE_REFS at any time.

By default, FOOTNOTE_REFS sets the FOOTNOTE_MARKER_STYLE to NUMBER (ie superscript numbers). You may change change that if you wish by invoking FOOTNOTE_MARKER_STYLE, with the argument you want after FOOTNOTE_REFS.

If you have a lot of footnote references, and are identifying footnotes by line number rather than by markers in the text, you may want to enable FOOTNOTES_RUN_ON in conjunctions with FOOTNOTE_REFS.

ENDNOTE_REFS is an instruction to REF, saying, “add all subsequent references bracketed by the REF macro to endnotes.” You invoke it by itself, with no argument.

When ENDNOTE_REFS is in effect, mom continues to format regular endnotes, (ie those introduced with .ENDNOTE and terminated with .ENDNOTE OFF) in the normal way.

You may switch between ENDNOTE_REFS and FOOTNOTE_REFS at any time.

You may sometimes want to embed fairly complete references directly into the body of your document, typically, but not always, inside parentheses. An instance where this might be desirable would be when there are one or two citations in a document where footnotes or endnotes are inappropriate, and a bibliography just plain silly (as it would be for just one or two citations).

Mom allows you to embed references from your database directly into documents through the use of the REF<bracket type> macros.

All four macro pairs, above, are invoked the same way, namely by introducing the reference with the first (“open”) macro of the REF<bracket type> pair, and terminating it with the second (“close”) REF<bracket type> of the pair. For example
.REF( .[ keyword(s) .] .REF) will embed a reference in the body of your document, surrounded by parentheses. .REF[ / .REF] will surround the reference with square brackets, etc.

REF_STYLE

When embedding references in the body of text, you’ll need to tell mom which formatting style to use: footnote/endnote or bibliography. Footnote/endnote referencing style uses no periods between fields, only proper nouns and titles are capitalized, and publication data is enclosed in parentheses. Bibliography referencing style separates each field with a period, every field begins with a capital letter, and publication data is not in parentheses.

If you want footnote/endnote style, invoke .REF_STYLE NOTE. If you want bibliographic style, invoke .REF_STYLE BIBLIO.

• <indent> requires a unit of measure

MLA-style requires that footnote or endnote references should have their first lines indented, whereas bibliographic references should have their second and subsequent lines indented. Thus, if you invoke INDENT_REFS with a first argument of FOOTNOTE or ENDNOTE, the value you give to <indent> sets the indent of the first line for those types of references; if you invoke it with BIBLIO, the value you give <indent> sets the indent of second and subsequent lines in bibliographies.

By default, the indent for all three types of references is 1/2-inch for PRINSTYLE TYPEWRITE and 2 ems for PRINSTYLE TYPESET.

If you’d like to change the indent for footnote, endnote or bibliography references, just invoke .INDENT_REFS with a first argument saying which one you want the indent changed for, and a second argument saying what you’d like the indent to be. For example, if you want the second-line indent of references on a bibliography page to be 3 picas,
.INDENT_REFS BIBLIO 3P is how you’d set it up.

If you have hyphenation turned on for a document (see HY), and in most cases you probably do, mom will hyphenate references bracketed by the REF macro. Since references typically contain quite a lot of proper names, which shouldn’t be hyphenated, you may want to disable hyphenation for references.

HYPHENATE_REFS is a toggle macro; invoking it by itself will turn automatic hyphenation of REF-bracketed references on (the default). Invoking it with any other argument (OFF, NO, X, etc.) will disable automatic hyphenation for references bracketed by REF.

An alternative to turning reference hyphenation off is to prepend to selected proper names in your refer database the groff discretionary hyphen character, \%. (See here in the tutorial for an example.)

If you want to append a bibliography to your document, all you need do is invoke .BIBLIOGRAPHY. .BIBLIOGRAPHY breaks to a new page, prints the title (BIBLIOGRAPHY by default, but that can be changed), and awaits refer instructions. How to create bibliographies is covered in the tutorial section, Creating bibliography pages. When all the required data has been entered, type
.BIBLIOGRAPHY OFF to complete the bibliography.

See the Bibliography control macros and defaults for macros to tweak, design and control the appearance of bibliography pages.

Mom offers two styles of bibliography output: plain, or numbered list style. With the argument, PLAIN, bibliography entries are output with no enumerators. With the argument, LIST, each entry is numbered.

The two optional arguments, <list separator> and <list prefix> have the same meaning as the equivalent arguments to LIST (ie <separator> and <prefix>).

You may enter the BIBLIOGRAPHY_TYPE either before or after .BIBLIOGRAPHY. It must, however, always come before the refer command to output bibliographies. (See the tutorial section, Creating bibliography pages, for instructions on how to output bibliographies.)

Mom’s default BIBLIOGRAPHY_TYPE is PLAIN.

1. General bibliography page style control

• Base family/font/quad

• Base point size

Unlike most other control macros that deal with size of document elements, BIBLIOGRAPHY_PT_SIZE takes as its argument an absolute value, relative to nothing. Therefore, the argument represents the size of bibliography type in points, unless you append an alternative unit of measure. For example,
.BIBLIOGRAPHY_PT_SIZE 12 sets the base point size of type on the bibliography page to 12 points, whereas
.BIBLIOGRAPHY_PT_SIZE .6i sets the base point size of type on the bibliography page to 1/6 of an inch.

The type size set with BIBLIOGRAPHY_PT_SIZE is the size of type used for the text of the bibliographies, and forms the basis from which the point size of other bibliography page elements is calculated.

The default for PRINTSTYLE TYPESET is 12.5 points (the same default size used in the body of the document).

• Leading

• Does not require a unit of measure; points is assumed

Unlike most other control macros that deal with leading of document elements, BIBLIOGRAPHY_LEAD takes as its argument an absolute value, relative to nothing. Therefore, the argument represents the leading of bibliographies in points unless you append an alternative unit of measure. For example,
.BIBLIOGRAPHY_LEAD 14 sets the base leading of type on the bibliography page to 14 points, whereas
.BIBLIOGRAPHY_LEAD .5i sets the base leading of type on the bibliography page to 1/2 inch.

If you want the leading of bibliographies adjusted to fill the page, pass BIBLIOGRAPHY_LEAD the optional argument, ADJUST. (See DOC_LEAD_ADJUST for an explanation of leading adjustment.)

The default for PRINTSTYLE TYPESET is the prevailing document lead (16 by default), adjusted.

• Adjust the space between bibliography entries

• Requires a unit of measure

By default, mom inserts no space between bibliography entries. If you’d prefer she add some, instruct her to do so with BIBLIOGRAPHY_SPACING. Say, for example, you want a half a linespace between entries,
.BIBLIOGRAPHY_SPACING .5v would do the trick.

• Singlespace bibliography (TYPEWRITE only)

If your PRINTSTYLE is TYPEWRITE and you use TYPEWRITE’s default double-spacing, bibliographies are double-spaced. If your document is single-spaced, bibliographies are single-spaced.

If, for some reason, you’d prefer that bibliographies be single-spaced in an otherwise double-spaced document (including double-spaced collated documents), invoke .SINGLESPACE_BIBLIOGRAPHY with with no argument.

• Turning off column mode during bibliography output

By default, if your document is set in columns, mom sets the bibliographies in columns, too. However, if your document is set in columns and you’d like the bibliographies not to be, just invoke .BIBLIOGRAPHY_NO_COLUMNS with no argument. The bibliography pages will be set to the full page measure of your document.

If you output bibliographies at the end of each document in a collated document set in columns, column mode will automatically be reinstated for each document, even with BIBLIOGRAPHY_NO_COLUMNS turned on. In such circumstances, you must re-enable ENDNOTES_NO_COLUMNS for each separate collated document.

2. Pagination of bibliographies

• Page numbering style

Use this macro to set the page numbering style of bibliography pages. The arguments are identical to those for PAGENUM_STYLE. The default is digit. You may want to change it to, say, alpha, which you would do with
.BIBLIOGRAPHY_PAGENUM_STYLE alpha

• Setting the first page number of bibliographies

Use this macro with caution. If the bibliography for a collated document is to be output at the document’s end, BIBLIOGRAPHY_FIRST_PAGENUMBER tells mom what page number to put on the first page of the bibliography.

However, if you’re outputting a bibliography at the end of each section (chapter, article, etc) of a collated document, you have to reset every section’s first page number after COLLATE and before START.

• Omitting a page number on the first page of bibliographies

This macro is for use only if FOOTERS are on. It tells BIBLIOGRAPHY not to print a page number on the first bibliography page. Mom’s default is to print the page number.

• Suspending pagination during bibliography output

SUSPEND_PAGINATION doesn’t take an argument. Invoked immediately prior to BIBLIOGRAPHY, it turns off pagination for the duration of the bibliography. Mom continues, however to increment page numbers silently.

To restore normal document pagination after bibliographies, invoke .RESTORE_PAGINATION (again, with no argument) immediately after you’ve finished with your bibliography.

3. Header/footer control

• Modifying what goes in the bibliography header/footer

If you wish to modify what appears in the header/footer that appears on bibliography pages, make the changes before you invoke .BIBLIOGRAPHY, not afterwards.

Except in the case of DOCTYPE CHAPTER, mom prints the same header or footer used throughout the document on bibliography pages. Chapters get treated differently in that, by default, mom does not print the header/footer centre string (normally the chapter number or chapter title.) In most cases, this is what you want. However, should you not want mom to remove the centre string from the bibliography pages headers/footers, invoke .BIBLIOGRAPHY_HEADER_CENTER with no argument.

An important change you may want to make is to put the word “Bibliography” in the header/footer centre position. To do so, invoke
.HEADER_CENTER "Endnotes" or .FOOTER_CENTER "Endnotes" prior to invoking .BIBLIOGRAPHY.

• Header/footer centre string when doctype is CHAPTER

If your DOCTYPE is CHAPTER and you want mom to include a centre string in the headers/footers that appear on bibliography pages, invoke .BIBLIOGRAPHY_HEADER_CENTER (or .BIBLIOGRAPHY_FOOTER_CENTER) with no argument. Mom’s default is NOT to print the centre string.

If, for some reason, having enabled the header/footer centre string on bibliography pages, you wish to disable it, invoke the same macro with any argument (OFF, QUIT, Q, X...).

• Allow headers on bibliography pages

By default, if HEADERS are on, mom prints page headers on all bibliography pages except the first. If you don’t want her to print headers on bibliography pages, do
.BIBLIOGRAPHY_ALLOWS_HEADERS OFF If you want headers on every page including the first, do
.BIBLIOGRAPHY_ALLOWS_HEADERS ALL

4. Bibliography first-page title control

• Title string

By default, mom prints the word “BIBLIOGRAPHY” as a title at the top of the first page of a bibliography. If you want her to print something else, invoke .BIBLIOGRAPHY_STRING with the title you want, surrounded by double-quotes.

If you don’t want a title at the top of the first bibliography page, invoke .BIBLIOGRAPHY_STRING with a blank argument (either two double-quotes side by side—""—or no argument at all).

• Title string control macros and defaults

• Title string placement

• Argument requires a unit of measusure

By default, mom places the title (the docheader, as it were) of bibliographies (typically "BIBLIOGRAPHY") on the same baseline that is used for the start of running text. If you’d prefer another location, higher or lower on the page (thereby also raising or lowering the starting position of the bibliography itself), invoke .BIBLIOGRAPHY_STRING_ADVANCE with an argument stating the distance from the top edge of the page at which you’d like the title placed.

The argument requires a unit of measure, so if you’d like the title to appear 1-1/2 inches from the top edge of the page, you’d tell mom about it like this:
.BIBLIOGRAPHY_STRING_ADVANCE 1.5i

• Title string underscoring

Alias: BIBLIOGRAPHY_STRING_UNDERLINE

• The argument <underscore weight> must not have the unit of measure, p, appended to it

Invoked without an argument, .BIBLIOGRAPHY_STRING_UNDERSCORE will place a single rule underneath the bibliography’s first-page title. Invoked with the argument, DOUBLE, BIBLIOGRAPHY_STRING_UNDERSCORE will double-underscore the thtile. Invoked with any other non-numeric argument, (eg OFF, NO, X, etc.) the macro disables underlining of the title.

In addition, you can use BIBLIOGRAPHY_STRING_UNDERSCORE to control the weight of the underscore rule(s), the gap between the title and the underscore, and, in the case of double-underscores, the distance between the two rules.

Some examples:
.BIBLIOGRAPHY_STRING_UNDERLINE 1 - turn underlining on; set the rule weight to 1 point .BIBLIOGRAPHY_STRING_UNDERLINE 1 3p - turn underlining on; set the rule weight to 1 point; set the gap between the string and the underline to 3 points .BIBLIOGRAPHY_STRING_UNDERLINE DOUBLE .75 3p - turn double-underlining on; set the rule weight to 3/4 of a point; set the gap between the string and the upper underline to 3 points; leave the gap between the upper and the lower underline at the default .BIBLIOGRAPHY_STRING_UNDERLINE DOUBLE 1.5 1.5p 1.5p - turn double-underlining on; set the rule weight to 1-1/2 points; set the gap between the string and the upper underline to 1-1/2 points; set the gap between the upper and the lower underline to 1-1/2 points Note, from the above, that in all instances, underscoring (single or double) is enabled whenever BIBLIOGRAPHY_STRING_UNDERSCORE is used in this way.

Mom’s default is to double-underscore the title with 1/2-point rules placed 2 points apart and 2 points below the baseline of the title.

• Title string capitalization

Invoked by itself, .BIBLIOGRAPHY_STRING_CAPS will automatically capitalize the bibliography first-page title. Invoked with any other argument, the macro disables automatic capitalization of the title.

If you’re generating a table of contents, you may want the bibliography first-page title to be in caps, but the toc entry in caps/lower case. If the argument to BIBLIOGRAPHY_STRING is in caps/lower case and BIBLIOGRAPHY_STRING_CAPS is on, this is exactly what will happen.

Mom’s default is to capitalize the bibliography first-page title.

Back to Table of Contents

Top

Next: Writing letters