Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
<title>Mom -- Bibliographies and References</title>
</head>
<body bgcolor="#dfdfdf">

<!====================================================================>

<a href="letters.html#TOP">Next</a>&nbsp;&nbsp;
<a href="cover.html#TOP">Prev</a>&nbsp;&nbsp;
<a href="toc.html">Back to Table of Contents</a>

<a name="TOP"></a>
<h1 align="center">
    <a name="REF_INTRO"><u>Bibliographies and references</u></a>
</h1>
<p>
<a href="#INTRO_REF">Introduction to bibliographies and references</a>
<br>
<a href="#TUTORIAL_REF">Tutorial</a>
<ul>
	<li><a href="#DB_REF">Creating a refer database</a>
	<li><a href="#RCOMMANDS_REF">Required "refer" commands</a>
	<li><a href="#ACCESSING_REF">Accessing references</a>
	<li><a href="#WHERE_REF">Telling mom where to put references</a>
	<li><a href="#BIBLIO_REF">Creating bibliography pages</a>
	<li><a href="#INVOKING_REF">Invoking groff with mom and refer</a>
</ul>
<br>
<a href="#MACROS_REF">Index of bibliography and reference macros</a>
<p>

<a name="INTRO_REF">
	<h2><u>Introduction to bibliographies and references</u></h2>
</a>

<strong>Mom</strong> provides the ability to automatically format
and generate bibliography pages, as well as footnote or endnote
bibliographic references, or references embedded in text.  She
accomplishes this by working in conjunction with a special
<strong>groff</strong> program called "refer".
<p>
<strong>refer</strong> is a <strong>groff</strong>
"pre-processor", which is to say that it scans your files looking
for very specific commands (i.e. lines that begin with a period
[dot], just like macros and document element tags).  If the
commands aren't there, <strong>refer</strong> can't do it's job,
and neither can <strong>mom</strong>.  The scanning is done
<strong>before</strong> any actual <strong>mom</strong> processing
occurs.
<p>
<strong>refer</strong> is a program that's been around for a long
time.  It's powerful and has many, many features.  Unfortunately,
the manpage (<kbd>man refer</kbd>), while complete and accurate, is
dense and not a good introduction to <strong>refer</strong>.  (It's
a classic manpage Catch-22: the information it contains is most
useful only after you already grasp it.)
<p>
In order to get <strong>mom</strong> users up and running with
<strong>refer</strong>, this section of <strong>mom</strong>'s
documentation focuses exclusively, in a recipe-like manner, on
what you need to know to use <strong>refer</strong> satisfactorily
in conjunction with <strong>mom</strong>.  The information and
instructions are <strong><em><u>not</u></em></strong> to be taken as
a manual or tutorial on full <strong>refer</strong> usage.  Much has
been left out, on purpose.
<p>
It is tempting to provide two levels of documentation, one for
users familiar with <strong>refer</strong> and one for newcomers
to <strong>groff</strong> and <strong>mom</strong>, but such an
approach may muddy the waters for newcomers. <strong>Mom</strong>'s
allegiance, first and foremost, is to newcomers.  If you're already
a <strong>refer</strong> user, the information herein will be useful
for adapting your current <strong>refer</strong> usage to
<strong>mom</strong>'s way of doing things.  If you've never used
<strong>refer</strong>, the information is essential, and, in many
cases, may be all you need.
<p>
(For the benefit of old groff-hands: <strong>refer</strong>
support in <strong>mom</strong> is heavily based on the
<strong>refer</strong> module of the ms macros.  The choice
was deliberate so that those wishing to play around with
<strong>mom</strong>'s bibliography formatting style would be
tinkering with the familiar.)
<p>
<strong>refer</strong> requires first that you create a
bibliographic database.  From the information contained in the
database, <strong>mom</strong> formats and generates bibliographies
and references in MLA (Modern Language Association) style.  MLA
style is clean, contemporary and flexible, and is widely used in
the humanities, where the range of material that has to be
referenced can run from simple books to live interviews and film.
<p>
Once you have created your database, you instruct
<strong>refer</strong> (and <strong>mom</strong>) to access entries
in it by supplying keywords from the entries.  Depending on what
you've instructed <strong>mom</strong> to do, she will put the
entries--fully and properly formatted with respect to order, punctuation
and italicization--in footnotes, endnotes, or a full bibliography.
<p>
I encourage anyone interested in what MLA style looks like--and, by
extension, how your bibliographies and references will look after
<strong>mom</strong> formats them--to check out
<p>
<pre>
	http://www.aresearchguide.com/12biblio.html
</pre>

or any other website or reference book on MLA style.
<p>
<strong>NOTE:</strong> MLA style requires that second and
subsequent lines of individual references be indented.  <strong>Mom</strong>
takes care of this for you with a default indent, which
can be changed with the macro
<a href="#INDENT_REFS">INDENT_REFS</a>.


<a name="TUTORIAL_REF"><h2><u>Tutorial</u></h2></a>

<ol>
	<li><a href="#DB_REF">Creating a refer database</a>
	<li><a href="#RCOMMANDS_REF">Required "refer" commands</a>
	<li><a href="#ACCESSING_REF">Accessing references</a>
	<li><a href="#WHERE_REF">Telling mom where to put references</a>
	<li><a href="#BIBLIO_REF">Creating bibliography pages</a>
	<li><a href="#INVOKING_REF">Invoking groff with mom and refer</a>
</ol>
<p>

<a name="DB_REF"><h3><u>1. Creating a refer database</u></h3><a>
<p>
The first step in using <strong>refer</strong> with
<strong>mom</strong> is setting up your bibliographic database.
The database is a file containing separate entries for each
reference you want to access from your <strong>mom</strong> files.
The file is <em>not</em> a "mom" file; it is a separate database.
You may set up individual databases for individual documents, or
create a large database that contains all the references you'll
ever need.
<p>
Entries ("records") in the database file are separated from each
other by a single, blank line.  The records themselves are composed
of single lines ("fields") with no blank lines between them.  Each
field begins with a percent sign and a single letter (the "field
identifier") e.g. %A or %T. The letter identifies what part of a
bibliographic entry the field refers to: Author, Title, Publisher,
Date, etc.  After the field identifier comes a single space,
followed by the information appropriate to field.  No punctuation
should go at the ends of fields; <strong>mom</strong> adds what's
correct automatically.  Do note, however, that author(s) (%A)
requires that you enter the author information exactly as you wish
it to come out (minus the period), including the comma after the
first author's last name.
<p>
Here's a sample database containing two records so you can
visualize what the above paragraph says:
<p>
<pre>
%A Schweitzer, Albert
%A C.M. Widor
%T J.S. Bach
%l Ernest Newman
%V Vol 2
%C London
%I Adam and Charles Black
%D 1923
%O 2 vols
%K bach vol 2

%A Schaffter, Peter
%T The Schumann Proof
%C Toronto
%I RendezVous Press
%D 2004
%K schumann schaffter
</pre>

The order in which you enter fields doesn't matter.
<strong>mom</strong> and <strong>refer</strong> will re-arrange
them in the correct order for you.
<p>
The meaning of the letters follows.  There are, with
<strong>refer</strong>, quite a few--all uppercase--which have, over
time, come to be "standard". <strong>Mom</strong> respects these.
However, she adds to the list (mostly the lowercase letters).
<p>
<pre>
	%A Author           -- additional authors may be entered on separate %A
	                       lines as in first entry of the sample, above; mom 
	                       and refer will figure out what to do with multiple
	                       authors according to MLA rules
	%T Title            -- either the primary title (e.g. of a book), or the
	                       title of an article (e.g. within a book or
	                       journal or magazine)
	%B Book title       -- the title of a book when %T contains the title
	                       of an article; otherwise, use %T for book
	                       titles
	%R Report number    -- for technical reports
	%J Journal name     -- the name of a journal or magazine when %T
	                       contains the title of an article
	%E Editor           -- additional editors may be entered on separate %E
	                       lines (like authors); mom and refer will figure
	                       out what to do with them according to MLA rules
	%e Edition          -- the number of name of a specific edition
	                       (e.g. Second, 2nd, Collector's, etc.)
	%V Volume           -- volume number of a journal or series of books
	%N Journal number   -- journal or magazine number
	%S Series           -- series name for books or journals that are part of
	                       a series
	%C City             -- the city of publication
	%I Publisher        -- the publisher; %I stands for "Issuer"
	%D Publication date
	%P Page number(s)   -- enter page ranges as, e.g., 22-25
	%G Gov't.
	   ordering number  -- for government publications
	%O Other            -- additional information or comments you want
	                       to appear at the end of the reference
	%K Keywords         -- any words that will clear up ambiguities
	                       resulting from database entries that
	                       contain, say, the same author or the
	                       same title
	%d original
	   publication date -- if different from the date
	                                   of publication
	%a additions        -- for books, any additions to the original work,
					       such as the preface to a new edition or a new
	                       introduction
	%t reprint title    -- if different from a work's original title
	%l translator       -- if the translator is not the editor; if more
	                        than one translator, this field should contain
	                        all the names, with appropriate punctuation
	%r translator
	   and editor       -- if tr. and ed. are one in the same;
	%s site name        -- for web sites, the site name
	%c content
	   of site          -- for web sites, the content, if unclear
	                       (i.e. advertisement, cartoon, blog)
	%o organization     -- for web sites, the organization, group or
	                       sponsor of the site
	%a access date      -- for a website, the date you accessed it
	%u URL              -- for websites, the full URL of the site
</pre>

<a name="REF_DISC_HY"></a>
<strong>Tip:</strong> If you have hyphenation turned on in your
document (you probably do), <strong>mom</strong> will hyphenate
your references.  This can be a problem because references
typically contain several proper names.  Proper names shouldn't be
hyphenated.  The solution is to prepend to any proper name in the
database the <strong>groff</strong>
<a href="definitions.html#TERMS_DISCRETIONARYHYPHEN">discretionary hyphen</a>
character, <strong>\%</strong>, like this:
<p>
<pre>
	%A Hill, \%Reginald
</pre>

Alternatively, you can turn hyphenation off entirely in
references with the macro,
<a href="#HYPHENATE_REFS">HYPHENATE_REFS</a> <kbd>OFF</kbd>.
<p>

<a name="RCOMMANDS_REF"><h3><u>2. Required "refer" commands</u></h3><a>
<p>
Having set up your database, you now need to put some
<strong>refer</strong>-specific commands at the top of your
<strong>mom</strong> file.  You cannot skip this step, nor can you
"source" these commands with the <strong>groff</strong>
<a href="definitions.html#TERMS_PRIMITIVES">primitive</a>,
<strong>.so</strong>.  They <strong><em>must</em></strong>
appear, exactly as shown, in every file requiring bibliographic
references.
<p>
<strong>refer</strong> commands are introduced with a single
line containing <kbd>.R1</kbd>, and concluded with a single line
containing <kbd>.R2</kbd>.  What you put between the <kbd>.R1</kbd>
and <kbd>.R2</kbd> lines are the commands themselves.  The commands
should be entered one per line, in lowercase letters, <em><u>with
no initial period (dot)</u></em>.
<p>
Here's an example:
<p>
<pre>
	.R1
	no-label-in-text
	no-label-in-reference
	.R2
</pre>

There are an awful lot of <strong>refer</strong> commands.  We will
focus only on those required to get <strong>mom</strong> cooperating
with <strong>refer</strong>.  If you're interested, study the
<strong>refer</strong> manpage to discover what other commands are
available and how to manipulate them.
<p>
At a minimum, all <strong>mom</strong> files accessing
a bibliographic database must contain the following
<strong>refer</strong> commands, exactly as shown:
<p>
<a name="REFER_BLOCK1"></a>
<pre>
.R1
no-label-in-text
no-label-in-reference
join-authors ", and " ", " ", and "
database &lt;full path to the database&gt;
.R2
</pre>

The first two commands tell <strong>refer</strong> to let
<strong>mom</strong> handle everything associated with footnote
and endnote markers, both in the body of the document, and in the
footnotes/endnotes themselves.
<p>
The third command is required for <strong>mom</strong> to handle
multiple authors in proper, MLA style.
<p>
The last command, <kbd>database</kbd>, assumes you have created
your own database, and do not otherwise have a system-wide
"default" database.  "...full path to the database" means the full
path <em>including</em> the database filename, e.g.
/home/user/refer/my_database.
<p> If you're already a <strong>refer</strong> user, feel free to
enter whatever <strong>refer</strong> commands are necessary to
access the database(s) you want.
<p>
With the above <strong>refer</strong> block, you can embed
references directly into the text of your document, or have them
output as footnotes or endnotes.  If you want to "collect"
references for later output on a bibliography page, the block must
read:
<p>
<pre>
.R1
no-label-in-text
no-label-in-reference
join-authors ", and " ", " ", and "
database &lt;full path to the database&gt;
sort
accumulate
.R2
</pre>

<a name="ACCESSING_REF"><h3><u>3. Accessing references</u></h3><a>
<p>
References are accessed by putting keywords, all on one line,
between the <strong>refer</strong> commands <strong>.[</strong> and
<strong>.]</strong>.  Both of these commands must appear on separate
lines, by themselves, like this:
<p>
<pre>
	.[
	keyword(s)
	.]
</pre>

Keywords are any word, or set of words, that identify a database
record (i.e. a reference) unambiguously. (<strong>refer</strong>
doesn't like ambiguity.)
<p>
If, for example, you want to reference a book by Ray Bradbury,
and the database contains only one book by Bradbury, a suitable
keyword would be "Bradbury".  If your database contains several
books by Bradbury, say, <em>Fahrenheit 451</em> and <em>The Martian
Chronicles</em>, you could reference them with the keywords, "451"
and "Martian".  If, in addition to the two books by Bradbury, you
also had one whose title was <em>The Martian Mission</em>, suitable
keywords to reference <em>The Martian Chronicles</em> might be:
<p>
<pre>
	.[                or    .[                   or  .[
	Bradbury Martian        Bradbury Chronicles      Martian Chronicles
	.]                      .]                       .]
</pre>

The database field identifier, %K, lets you create special keywords
for references.  This can be very handy if you need both a "short"
and a "long" reference to the same work.  The short reference might
be used in footnotes; the long one in a bibliography.  Consider the
following:
<p>
<pre>
	%A Isherwood, Christopher      %A Isherwood
	%T Mr. Norris Changes Trains   %T Mr. Norris Changes Trains
	%d 1935                        %K Nor short
	%t The Last of Mr. \%Norris
	%a Intro. Tom Crawford
	%C New York
	%I New Directions
	%D 1945
	%K Norris

</pre>

To access the shorter reference, you'd do
<p>
<pre>
	.[
	Nor short
	.]
</pre>

To access the longer one, you'd do
<pre>
	.[
	Norris
	.]
</pre>

<a name="WHERE_REF"><h3><u>4. Telling mom where to put references</u></h3><a>
<p>
<strong>Mom</strong> provides several mechanisms for outputting
references where you want.
<p>
<h3>Embedding references in the document body</h3>
<p>
References may be embedded in the document body, surrounded by
parentheses, square brackets, or braces.  Use whichever you prefer,
following the recipes below.
<p>
<pre>
	Parentheses    Square brackets    Braces
	-----------    ---------------    ------

	.REF(          .REF[              .REF{
	.[             .[                 .[
	keyword(s)     keyword(s)         keyword(s)
	.]             .]                 .]
	.REF)          .REF]              .REF}
</pre>

<h3>Footnote or endnote references</h3>
<p>
Most times, you'll probably want references in either footnotes or
endnotes.  <strong>Mom</strong> provides a simple mechanism whereby
you can choose which, or even switch back and forth.  The primary
tag is
<a href="#REF">REF</a>, which is used like this:
<p>
<pre>
	.REF
	.[
	keyword(s)
	.]
	.REF
</pre>

<strong>REF</strong> collects references and outputs them
where you say with the macros,
<a href="#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
or
<a href="#ENDNOTE_REFS">ENDNOTE_REFS</a>.
Neither
<strong>FOOTNOTE_REFS</strong> nor <strong>ENDNOTE_REFS</strong>
requires an argument.  All they do is tell <strong>REF</strong>,
whenever it's invoked, where to put the references.
<p>
A recipe for footnote references looks like this:
<pre>
	.FOOTNOTE_REFS
	.REF
	.[
	keyword(s)
	.]
	.REF
</pre>

When <strong>FOOTNOTE_REFS</strong> are enabled, <strong>REF</strong>
behaves identically to
<a href="docelement.html#FOOTNOTE">FOOTNOTE</a>,
so please read the
<a href="docelement.html#FOOTNOTE_NOTE">HYPER IMPORTANT NOTE</a>
found in the document entry for <strong>FOOTNOTE</strong>.
<p>
The reference between the first and second <strong>REF</strong>
will be treated as a footnote, as will all subsequent
<strong>REF</strong> pairs unless you invoke the macro,
<strong>ENDNOTE_REFS</strong>.
<p>
A recipe for endnote references looks like this:
<pre>
	.ENDNOTE_REFS
	.REF
	.[
	keyword(s)
	.]
	.REF
</pre>

The reference between the first and second <strong>REF</strong>
will be treated as an endnote, as will all subsequent
<strong>REF</strong> pairs unless you invoke the macro,
<strong>FOOTNOTE_REFS</strong>.
<p>
When <strong>ENDNOTE_REFS</strong> are enabled, <strong>REF</strong>
behaves identically to
<a href="docelement.html#FOOTNOTE">ENDNOTE</a>,
so please read the
<a href="docelement.html#ENDNOTE_NOTE">HYPER IMPORTANT NOTE</a>
found in the document entry for <strong>ENDNOTE</strong>.
<p>
The innate flexibility of this scheme allows you to have both
footnote references and endnote references in the same document.
This would be desirable if, say, you wanted "short" references in
footnotes, and complete references in endnotes.
<p>

<a name="COLLECTED_REF"><h3>Collected references</h3></a>
<p>
Sometimes, you may want to put references in input text near
sections of text to which they pertain, but not actually want
them output until later (typically, on a bibliography page).
<strong>REF</strong> is used for this, too, but you have to make
sure your <strong>refer</strong> commands block is set up properly.
The recipe for this is:
<p>
<a name="REFER_BLOCK2"></a>
<pre>
.R1
no-label-in-text
no-label-in-reference
join-authors ", and " ", " ", and "
database &lt;full path to the database&gt;
sort
accumulate
.R2
</pre>

After this set up, and provided you don't issue a
<strong>FOOTNOTE_REFS</strong> or <strong>ENDNOTE_REFS</strong>
command, all reference between <strong>REF</strong> pairs will be
collected for later output.
<p>
As a precaution, <strong>mom</strong> will issue a message the
first time you call <strong>.REF</strong> if neither
<strong>FOOTNOTE_REFS</strong> nor <strong>ENDNOTE_REFS</strong> is
in effect.  If collected references are what you want, and you have
set up your <strong>.R1 - .R2</strong> block as above, you may
safely ignore the message.
<p>
<strong>LIMITATION:</strong> You cannot combine "collected"
references (plain <strong>REF</strong>) with <strong>REF</strong>s
that are instructed to go into footnotes (with
<strong>FOOTNOTE_REFS</strong>) or endnotes (with
<strong>ENDNOTE_REFS</strong>).  This is a limitation imposed by
<strong>refer</strong>, not <strong>mom</strong>.

<a name="BIBLIO_REF"><h3><u>5. Creating bibliography pages</u></h3><a>
<p>
Bibliography pages are separate pages, like endnotes, on which
complete bibliographies are output.  And, like endnotes pages, just
about every element on them can be designed to your specifications
with control macros.  (See
<a href="#BIBLIO_CONTROL_MACROS">Control macros for bibliographies</a>.)
A bibliography page that uses <strong>mom</strong>'s defaults
begins with the macro,
<a href="BIBLIOGRAPHY">BIBLIOGRAPHY</a>,
like this:
<p>
<pre>
	.BIBLIOGRAPHY
</pre>

<p>
Following <strong>BIBLIOGRAPHY</strong>, you have three choices of
how to proceed.
<p>
If you have elected to have references collected from within the
body of a document (see above,
<a href="#COLLECTED_REF">Collected references</a>, 
for instructions), which assumes you have a <strong>refer</strong>
command block like the one
<a href="#REFER_BLOCK2">here</a>
at the top of your document, you need only do
<p>
<pre>
	.BIBLIOGRAPHY
	.[
	$LIST$
	.]
</pre>

If you want to create the bibliography by hand (which may be the
case if you've used footnote and/or endnote references throughout
your document), follow this recipe, which assumes you already have a
<strong>refer</strong> block like the one
<a href="#REFER_BLOCK1">here</a>
at the top of your document:
<p>
<pre>
	.BIBLIOGRAPHY
	.R1
	sort
	accumulate
	.R2
	.[          -+
	keyword(s)   |
	.]           | "keyword(s)" are keywords identifying the
	.[           | particular bibliographic reference you want
	keyword(s)   | from your database.  Order doesn't matter here;
	.]           | the refer command, sort, takes care of that.
	.[           |
	keyword(s)   |
	.]          -+
	.[
	$LIST$
	.]
</pre>

Your final choice is to output your whole database.  Again,
assuming you have a <strong>refer</strong> block like the one
<a href="#REFER_BLOCK1">here</a> at the top of your file, you need
only do:
<p>
<pre>
	.BIBLIOGRAPHY
	.R1
	bibliography &lt;full path to database&gt;
	.R2
</pre>

If you haven't put a <strong>refer</strong> block in
your file already, you can put the whole thing after
<strong>BIBLIOGRAPHY</strong>, like this:
<p>
<pre>
	.BIBLIOGRAPHY
	.R1
	no-label-in-text                       -+
	no-label-in-reference                   | These are actually optional
	database &lt;full path to the database&gt;   -+ 
	join-authors ", and " ", " ", and "
	bibliography &lt;full path to database&gt;
	.R2
</pre>

Whichever option you choose, <strong>mom</strong> will output a
full bibliography page, complete with a title (BIBLIOGRAPHY by
default, but that can be changed).

<a name="INVOKING_REF"><h3><u>6. Invoking groff with mom and refer</u></h3><a>
<p>
So, now you've got a document, formatted properly to use
references processed with <strong>refer</strong>, what do you do to
output the document?
<p>
It's simple.  Instead of invoking <strong>groff</strong> with just
the -mom option, as explained
<a href="using.html#USING_INVOKING">here</a>,
invoke groff with the -R option as well, like this:
<p>
<pre>
	groff -R -mom filename
</pre>

<hr width="66%">

<p>
<a name="MACROS_REF"><h3><u>Index of bibliography and reference macros</u></h3></a>
<ul>
    <li><a href="#REF">Tag: REF</a> -- collected, footnote or endnote references tag
    <li><a href="#FOOTNOTE_REFS">FOOTNOTE_REFS</a> -- REFs go to footnotes
    <li><a href="#ENDNOTE_REFS">ENDNOTE_REFS</a> -- REFs go to endnotes
    <li><a href="#BRACKET_REFS">REF(</a> -- references embedded in text between parentheses
    <li><a href="#BRACKET_REFS">REF[</a> -- references embedded in text between square brackets
    <li><a href="#BRACKET_REFS">REF{</a> -- references embedded in text between braces
    <li><a href="#INDENT_REFS">INDENT_REFS</a> -- manage the 2nd line indent of references
    <li><a href="#HYPHENATE_REFS">HYPHENATE_REFS</a> -- en/disable hyphenation of references
    <li><a href="#BIBLIOGRAPHY">BIBLIOGRAPHY</a> -- begin a bibliography page
    <li><a href="#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a> -- plain, or numbered list bibliography
    <li><a href="#BIBLIO_CONTROL">Bibliography page style control</a>
</ul>
<p>

<!---REF--->

<hr width="66%" align="left">
<a name="REF"><h3><u>Marking off references for footnotes, endnotes, or collection</u></h3></a>
<p>

Tag: <strong>REF</strong>
<p>
The macro, <strong>REF</strong>, tells <strong>mom</strong> that
what follows is <strong>refer</strong>-specific, a
keyword-identified reference from a
<strong>refer</strong> database.  Depending on whether you've
issued a
<a href="#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
or
<a href="#ENDNOTE_REFS">ENDNOTE_REFS</a>
instruction, <strong>REF</strong> also tells <strong>mom</strong>
where to place the reference.  If <strong>FOOTNOTE_REFS</strong>,
the reference will be formatted and placed in a footnote.  If
<strong>ENDNOTE_REFS</strong>, 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 on a
<a href="#BIBLIOGRAPHY">bibliography page</a>.
<p>
Before you use <strong>REF</strong>, you must create a
<strong>refer</strong> block containing <strong>refer</strong>
commands (see
<a href="#RCOMMANDS_REF">Required refer commands</a>
in the tutorial, above).
<p>
<strong>REF</strong> usage always looks like this:
<p>
<pre>
	.REF
	.[
	keyword(s)
	.]
	.REF
</pre>

Notice that <strong>REF</strong> "brackets" the
<strong>refer</strong> call, and never takes an argument.
<p>
What <strong>REF</strong> really is is a convenience.  One could,
for example, put a reference in a footnote by doing
<p>
<pre>
	.FOOTNOTE
	.[
	keyword(s)
	.]
	.FOOTNOTE OFF
</pre>

However, if you have a lot of references going into footnotes (or
endnotes), it's much shorter to type <kbd>.REF/.REF</kbd> than
<kbd>.FOOTNOTE/.FOOTNOTE OFF</kbd>.  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.
<p>
<strong>Additional arguments:</strong> If you're using
<strong>REF</strong> to put references in footnotes and your
footnotes need to be indented, you may (indeed, should) pass
<strong>REF</strong> the same arguments used to indent footnotes.
See
<a href="docelement.html#FOOTNOTE">FOOTNOTE</a>.
<p>
<strong>Note:</strong>
When <strong>REF</strong> is used with
<a href="#FOOTNOTE_REFS">FOOTNOTE_REFS</a>,
it behaves identically to
<a href="docelement.html#FOOTNOTE">FOOTNOTE</a>,
so please read the
<a href="docelement.html#FOOTNOTE_NOTE">HYPER IMPORTANT NOTE</a>
found in the document entry for <strong>FOOTNOTE</strong>.
<p>
When <strong>REF</strong> is used with
<a href="#ENDNOTE_REFS">ENDNOTE_REFS</a>,
it behaves identically to
<a href="docelement.html#FOOTNOTE">ENDNOTE</a>,
so please read the
<a href="docelement.html#ENDNOTE_NOTE">HYPER IMPORTANT NOTE</a>
found in the document entry for <strong>ENDNOTE</strong>.

<br>

<!---FOOTNOTE_REFS--->

<hr width="33%" align="left">
<a name="FOOTNOTE_REFS"><h3><u>Instruct REF to put references in footnotes</u></h3></a>
<p>

Macro: <strong>FOOTNOTE_REFS</strong>
<p>
<strong>FOOTNOTE_REFS</strong> is an instruction to
<a href="#REF">REF</a>,
saying, "put all subsequent references bracketed by the
<strong>REF</strong> macro into footnotes."  You invoke it by
itself, with no argument.
<p>
When <strong>FOOTNOTE_REFS</strong> is in effect, regular
footnotes, (i.e. those introduced with <kbd>.FOOTNOTE</kbd> and
terminated with <kbd>.FOOTNOTE OFF</kbd>) continue to behave
normally.
<p>
You may switch between <strong>FOOTNOTE_REFS</strong> and
<a href="#ENDNOTE_REFS">ENDNOTE_REFS</a>
at any time.
<p>
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
<a href="docelement.html#FOOTNOTES_RUN_ON">FOOTNOTES_RUN_ON</a>
in conjunctions with <strong>FOOTNOTE_REFS</strong>.

<br>

<!---ENDNOTE_REFS--->

<hr width="33%" align="left">
<a name="ENDNOTE_REFS"><h3><u>Instruct REF to put references in endnotes</u></h3></a>
<p>

Macro: <strong>ENDNOTE_REFS</strong>
<p>
<strong>ENDNOTE_REFS</strong> is an instruction to
<a href="#REF">REF</a>,
saying, "add all subsequent references bracketed by the
<strong>REF</strong> macro to endnotes."  You invoke it by
itself, with no argument.
<p>
When <strong>ENDNOTE_REFS</strong> is in effect,
<strong>mom</strong> continues to format regular endnotes, (i.e.
those introduced with <kbd>.ENDNOTE</kbd> and terminated with
<kbd>.ENDNOTE OFF</kbd>) in the normal way.
<p>
You may switch between <strong>ENDNOTE_REFS</strong> and
<a href="#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
at any time.

<br>

<!---BRACKET_REFS--->

<hr width="33%" align="left">
<a name="BRACKET_REFS"><h3><u>References embedded in text</u></h3></a>
<p>

Macro pair: <strong>REF(</strong>&nbsp;&nbsp;...&nbsp;&nbsp;<strong>REF)</strong>
<br>
Macro pair: <strong>REF[</strong>&nbsp;&nbsp;...&nbsp;&nbsp;<strong>REF]</strong>
<br>
Macro pair: <strong>REF{</strong>&nbsp;&nbsp;...&nbsp;&nbsp;<strong>REF}</strong>
<p>
You may sometimes want to embed references directly into the body
of your documents, typically, but not always, inside parentheses.
<strong>Mom</strong> makes this possible through the use of the
<strong>REF&lt;bracket&nbsp;type&gt;</strong> macros.
<p>
All three macro pairs, above, are invoked the same way, namely by
introducing the reference with the first ("open") macro of
the <strong>REF&lt;bracket&nbsp;type&gt;</strong> pair, and
terminating it with the second ("close")
<strong>REF&lt;bracket&nbsp;type&gt;</strong> of the pair.  For
example
<p>
<pre>
	.REF(
	.[
	keyword(s)
	.]
	.REF)
</pre>

will embed a reference in the body of your document, surrounded by
parentheses.  <strong>.REF[</strong>&nbsp;...&nbsp;<strong>.REF]</strong> will
surround the reference with square brackets.
<strong>.REF{</strong>&nbsp;...&nbsp;<strong>.REF}</strong> will surround it with
curly braces.
<br>

<!---INDENT_REFS--->

<hr width="33%" align="left">
<a name="INDENT_REFS"><h3><u>Manage the second-line indent of references</u></h3></a>
<p>

<nobr>Macro: <strong>INDENT_REFS</strong> FOOTNOTE | ENDNOTE | BIBLIO &lt;indent&gt; </nobr>
<br>
<em>*&lt;indent&gt; requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
<p>
Proper MLA-style references should have their second, and subsequent
lines, if any, indented.  Since <strong>mom</strong> formats
references in MLA style, she automatically indents second lines.
By default, the indent for the second line of references,
regardless of whether the references appear in footnotes, endnotes,
or bibliographies, is 1.5
<a href="definitions.html#TERMS_EM">ems</a>
for
<a href="docprocessing.html#PRINTSTYLE">PRINSTYLE</a>
<strong>TYPESET</strong>
and 2 ems for
<a href="docprocessing.html#PRINTSTYLE">PRINSTYLE</a>
<strong>TYPEWRITE</strong>.
<p>
If you'd like to change the indent for footnotes, endnotes or
bibliographies, just invoke <strong>INDENT_REFS</strong> with a
first argument telling <strong>mom</strong> for which you want the
indent changed, 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
<a href="definitions.html#TERMS_PICAS_POINTS">picas</a>,
<p>
<pre>
	.INDENT_REFS BIBLIO 3P
</pre>

is how you'd set it up.
<p>
<strong>Tip:</strong> if you are identifying endnotes by line
number
(<a href="docelement.html#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a> <strong>LINE</strong>)
and you have instructed <strong>mom</strong> to put references
bracketed by
<a href="#REF">REF</a>
into endnotes (with
<a href="#ENDNOTE_REFS">ENDNOTE_REFS</a>),
you will probably want to adjust the second-line indent for
references in endnotes, owing to the way <strong>mom</strong>
formats line-numbered endnotes.  Study the output of such
documents to see whether an indent adjustment is required.
<br>

<!---HYPHENATE_REFS--->

<hr width="33%" align="left">
<a name="HYPHENATE_REFS"><h3><u>Enable/disable hyphenation of references</u></h3></a>
<p>

<nobr>Macro: <strong>HYPHENATE_REFS</strong> &lt;toggle&gt;</nobr>
<p>
If you have hyphenation turned on for a document (see <a
href="typesetting.html#HY">HY</a>),
and in most cases you probably do, <strong>mom</strong> will
hyphenate references bracketed by the
<a href="#REF">REF</a>
macro.  Since references typically contain quite a lot of proper
names, which shouldn't be hyphenated, you may want to disable
hyphenation for references.
<p>
<strong>HYPHENATE_REFS</strong> is a toggle macro;
invoking it by itself will turn automatic hyphenation of
<strong>REF</strong>-bracketed references on (the default).
Invoking it with any other argument (<strong>OFF</strong>,
<strong>NO</strong>, <strong>X</strong>, etc.) will disable
automatic hyphenation for references bracketed by
<strong>REF</strong>.
<p>
An alternative to turning reference hyphenation off is to prepend
to selected proper names in your <strong>refer</strong> database
the <strong>groff</strong>
<a href="definitions.html#TERMS_DISCRETIONARYHYPHEN">discretionary hyphen</a>
character, <strong>\%</strong>.  (See
<a href="#REF_DISC_HY">here</a>
in the tutorial for an example.)
<p>
<strong>Note:</strong> references embedded in the body of a document
with
<a href="#BRACKET_REFS">REF</a><strong>&lt;bracket&nbsp;type&gt;</strong>
are considered part of
<a href="definitions.html#TERMS_RUNNING">running text</a>,
and are hyphenated (or not) according to whether hyphenation
is turned on or off for running text.  Therefore, if you want to
disable hyphenation for such references, you must do so
temporarily, with <strong>HY</strong>, like this:
<p>
<pre>
	.HY OFF
	.REF(
	.[
	keyword(s)
	.]
	.REF)
	.HY
</pre>

Alternatively, sprinkle your database fields liberally with
<strong>\%</strong>.
<br>

<!---BIBLIOGRAPHY--->

<hr width="33%" align="left">
<a name="BIBLIOGRAPHY"><h3><u>Begin a bibliography page</u></h3></a>
<p>

Macro: <strong>BIBLIOGRAPHY</strong>
<br>
<p>
If you want to append a bibliography to your document, all you need
do is invoke <strong>BIBLIOGRAPHY</strong> at the place you want
it.  <strong>BIBLIOGRAPHY</strong> breaks to a new page, prints the
title (BIBLIOGRAPHY by default, but that can be changed), and awaits
<strong>refer</strong> instructions.  How to create bibliographies
is covered in the tutorial section,
<a href="#BIBLIO_REF">Creating bibliography pages</a>.
<p>
See the
<a href="#BIBLIO_CONTROL">Bibliography page style control macros</a>
for macros to tweak, design and control the appearance of
bibliography pages.
<br>

<!---BIBLIOGRAPHY_TYPE--->

<hr width="33%" align="left">
<a name="BIBLIOGRAPHY_TYPE"><h3><u>Plain, or numbered list bibliography</u></h3></a>
<p>

<nobr>Macro: <strong>BIBLIOGRAPHY_TYPE</strong> PLAIN | LIST [ &lt;list separator&gt; ] [ &lt;list prefix&gt; ]</nobr>
<p>
<strong>Mom</strong> offers two styles of bibliography output: plain,
or numbered list style.  With <strong>PLAIN</strong>, bibliography
entries are output with no enumerators.  With <strong>LIST</strong>,
each entry is numbered.  
<p>
Entering <kbd>.BIBLIOGRPHY_TYPE PLAIN</kbd> gives you a plain
bibliography.
<p>
Entering <kbd>.BIBLIOGRAPHY_TYPE LIST</kbd> gives you an enumerated
bibliography.  The two optional arguments,
<strong>&lt;list&nbsp;separator&gt;</strong> and
<strong>&lt;list&nbsp;prefix&gt;</strong> have the same meaning as
the equivalent arguments to
<a href="docelement.html#LIST">LIST</a>
(i.e. <strong>&lt;separator&gt;</strong> and <strong>&lt;prefix&gt;</strong>).
<p>
You may enter <strong>BIBLIOGRAPHY_TYPE</strong> either before or
after <strong>BIBLIOGRAPHY</strong>.  It must, however, always come
before the <strong>refer</strong> command to output bibliographies.
(See the tutorial section,
<a href="#BIBLIO_REF">Creating bibliography pages</a>,
for instructions on how to output bibliographies.)
<p>
<strong>Mom</strong>'s default <strong>BIBLIOGRAPHY_TYPE</strong>
is <strong>LIST</strong>, with a period (dot) as the separator, and
no prefix.

<br>

<!---BIBLIO_CONTROL--->

<hr width="66%" align="left">
<a name="BIBLIO_CONTROL"><h3><u>Bibliography page style control</u></h3></a> 

<p>
<strong>Mom</strong> processes bibliography pages in a manner very
similar to the way she processes endnotes pages.  The bibliography
page control macros, therefore, behave in the same way as their
endnotes pages equivalents.
<br>
<ol>
	<li><a href="#BIBLIO_GENERAL"><strong>General bibliography page style control</strong></a>
		<ul>
			<li><a href="#BIBLIO_STYLE">Base family/font/quad for bibliographies</a>
			<li><a href="#BIBLIO_PT_SIZE">Base point size for bibliographies</a>
			<li><a href="#BIBLIO_LEAD">Leading of bibliographies</a>
			<li><a href="#SINGLESPACE_BIBLIO">Singlespace bibliographies (for TYPEWRITE only)</a>
			<li><a href="#BIBLIO_NO_COLUMNS">Turning off column mode during bibliography output</a>
			<li>Pagination of bibliographies:
			<ul>
				<li><a href="#BIBLIO_PAGENUM_STYLE">Bibliography pages page numbering style</a>
				<li><a href="#BIBLIO_FIRST_PAGENUMBER">Setting the first page number of bibliography pages</a>
				<li><a href="#BIBLIO_NO_FIRST_PAGENUM">Omitting a page number on the first page of bibliographies</a>
			</ul>
			<li><a href="#SUSPEND_PAGINATION">Suspending pagination of bibliographies</a>
		</ul>
	<li><a href="#BIBLIO_HEADER_CONTROL"><strong>Bibliography pages header/footer control</strong></a>
		<ul>
			<li><a href="#BIBLIO_MODIFY_HDRFTR">Modifying what goes in the bibliography pages header/footer</a>
			<li><a href="#BIBLIO_HDRFTR_CENTER">Enabling a header/footer centre when doctype is CHAPTER</a>
			<li><a href="#BIBLIO_ALLOWS_HEADERS">Allow headers on bibliography pages</a>
		</ul>
	<li><a href="#BIBLIO_MAIN_TITLE"><strong>Bibliography page head (i.e. the title at the top) control</strong></a>
		<ul>
			<li><a href="#BIBLIO_STRING">Creating/modifying the bibliography page head</a>
			<li><a href="#BIBLIO_STRING_CONTROL">Bibliography page head control</a>
			<li><a href="#BIBLIO_STRING_UNDERSCORE">Bibliography page head underscoring</a>
			<li><a href="#BIBLIO_STRING_CAPS">Bibliography page head capitalization</a>
		</ul>
    </ul>
</ol>
<hr>

<a name="BIBLIO_GENERAL"><h2><u>1. General bibliography page style control</u></h2>

<a name="BIBLIO_STYLE"><h3><u>*Bibliography family/font/quad</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.BIBLIOGRAPHY_FAMILY    default = prevailing document family; default is Times Roman
.BIBLIOGRAPHY_FONT      default = roman
.BIBLIOGRAPHY_QUAD*     default = justified

*Note: BIBLIOGRAPHY_QUAD must be set to either L or J
</pre>

<!---BIBLIO_PT_SIZE--->

<a name="BIBLIO_PT_SIZE"><h3><u>*Bibliography point size</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_PT_SIZE</strong> &lt;base type size of bibliography&gt;</nobr>

<p>
Unlike most other control macros that deal with size of document
elements, <strong>BIBLIOGRAPHY_PT_SIZE</strong> takes as its argument an
absolute value, relative to nothing.  Therefore, the argument represents
the size of bibliography type in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>,
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
	.BIBLIOGRAPHY_PT_SIZE 12
</pre>

sets the base point size of type on the bibliography page to 12
points, whereas
<p>
<pre>
	.BIBLIOGRAPHY_PT_SIZE .6i
</pre>

sets the base point size of type on the bibliography page to 1/6 of an
inch.
<p>
The type size set with <strong>BIBLIOGRAPHY_PT_SIZE</strong> 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.
<p>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is 12.5 points (the same default size used in the body of the document).
<p>

<!---BIBLIO_LEAD--->

<a name="BIBLIO_LEAD"><h3><u>*Bibliography lead</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_LEAD</strong> &lt;base leading of bibliographies&gt; [ ADJUST ]</nobr>
<br>
<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>

<p>
Unlike most other control macros that deal with leading of document
elements, <strong>BIBLIOGRAPHY_LEAD</strong> takes as its argument an
absolute value, relative to nothing.  Therefore, the argument represents
the
<a href="definitions.html#TERMS_LEADING">leading</a>
of endnotes in
<a href="definitions.html#TERMS_PICASPOINTS">points</a>
unless you append an alternative
<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
For example,
<p>
<pre>
	.BIBLIOGRAPHY_LEAD 14
</pre>

sets the base leading of type on the bibliography page to 14
points, whereas
<p>
<pre>
	.BIBLIOGRAPHY_LEAD .5i
</pre>

sets the base leading of type on the bibliography page to 1/2 inch.
<p>
If you want the leading of bibliographies adjusted to fill the page,
pass <strong>BIBLIOGRAPHY_LEAD</strong> the optional argument
<strong>ADJUST</strong>.  (See
<a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
for an explanation of leading adjustment.)
<p>
The default for
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
is 14 points, adjusted.
<p>
<strong>NOTE:</strong> Even if you give <strong>mom</strong> a
<strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by
default, adjust bibliography leading.  You MUST enter
<strong>BIBLIOGRAPHY_LEAD &lt;lead&gt;</strong> with no
<strong>ADJUST</strong> argument to disable this default behaviour.
<p>

<!---SINGLESPACE_BIBLIO--->

<a name="SINGLESPACE_BIBLIO"><h3><u>*Singlespace bibliographies (TYPEWRITE only)</u></h3></a>
<p>
<nobr>Macro: <strong>SINGLESPACE_BIBLIOGRAPHY</strong> &lt;toggle&gt;</nobr>

<p>
If your 
<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a>
is <strong>TYPEWRITE</strong> and you use TYPEWRITE's default
double-spacing, bibliographies are double-spaced.  If your document
is single-spaced, bibliographies are single-spaced.
<p>
If, for some reason, you'd prefer that bibliographies be single-spaced
in an otherwise double-spaced document (including double-spaced
<a href="rectoverso.html#COLLATE">collated</a>
documents), invoke <strong>SINGLESPACE_BIBLIOGRAPHY</strong> with
with no argument.
<p>

<!---BIBLIO_SPACING--->

<a name="BIBLIO_SPACING"><h3><u>*Adjusting the space between bibliography entries</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_SPACING</strong> &lt;amount of space&gt; </nobr>
<br>
<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>

<p>
By default, <strong>mom</strong> inserts 1 linespaces between
bibliography entries on bibliography pages.  If you'd prefer she
add a different amount of space, instruct her to do so with the
macro, <strong>BIBLIOGRAPHY_SPACING</strong>.  Say, for example,
you'd prefer only 1/2 linespace.  That would be done with
<p>
<pre>
	.BIBLIOGRAPHY_SPACING .5v
</pre>

As with endnotes pages, owing to the space inserted between bibliography
entries, bibliography pages may have hanging bottom margins.
Unlike endnotes pages, <strong>mom</strong> is sad to report that
there's nothing you can do about this, except a) pray things work
out, or b) set your <strong>BIBLIOGRAPHY_SPACING</strong> to zero.

<!---BIBLIO_NO_COLUMNS--->

<a name="BIBLIO_NO_COLUMNS"><h3><u>*Turning off column mode during bibliography output</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_NO_COLUMNS</strong> &lt;toggle&gt;</nobr>

<p>
By default, if your document is
<a href="columns.html#COLUMNS">set in columns</a>,
<strong>mom</strong> 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 <strong>BIBLIOGRAPHY_NO_COLUMNS</strong> with no
argument.  The bibliography pages will be set to the full page measure
of your document.
<p>
If you output bibliographies at the end of each document in a
<a href="rectoverso.html#COLLATE">collated</a>
document set in columns, column mode will automatically
be reinstated for each document, even with
<strong>BIBLIOGRAPHY_NO_COLUMNS</strong> turned on.
<p>

<!---BIBLIO_PAGENUM_STYLE--->

<a name="BIBLIO_PAGENUM_STYLE"><h3><u>*Bibliography-page page numbering style</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_PAGENUM_STYLE</strong> DIGIT | ROMAN | roman | ALPHA | alpha</nobr>

<p>
Use this macro to set the page numbering style of bibliography pages.
The arguments are identical to those for
<a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a>.
The default is <strong>digit</strong>.  You may want to change it
to, say, <strong>alpha</strong>, which you would do with
<p>
<pre>
	.BIBLIOGRAPHY_PAGENUM_STYLE alpha
</pre>

<!---BIBLIO_FIRST_PAGENUMBER--->

<a name="BIBLIO_FIRST_PAGENUMBER"><h3><u>*Setting the first page number of bibliography pages</u></h3></a>
<p>
<nobr>Macro: <strong>BIBILOGRAPHY_FIRST_PAGENUMBER</strong> &lt;page # that appears on page 1 of bibliographies&gt;</nobr>

<p>
Use this macro with caution.  If all bibliographies for several
<a href="rectoverso.html#COLLATE">collated</a>
documents are to be output at once, i.e. not at the end of each
separate doc, <strong>BIBLIOGRAPHY_FIRST_PAGENUMBER</strong> tells
<strong>mom</strong> what page number to put on the first page of
the bibliography.
<p>
If you set <strong>BIBLIOGRAPHY_FIRST_PAGENUMBER</strong> in collated
documents where the bibliographies are output after each separate doc,
you have to reset every separate document's first page number after
<a href="rectoverso.html#COLLATE">COLLATE</a>
and before
<a href="docprocessing.html#START">START</a>.
<p>

<!---BIBLIO_NO_FIRST_PAGENUN--->

<a name="BIBLIO_NO_FIRST_PAGENUM"><h3><u>*Omitting a page number on the first page of bibliographies</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_NO_FIRST_PAGENUM</strong> &lt;toggle&gt;</nobr>

<p>
This macro is for use only if <strong>FOOTERS</strong> are on.  It
tells
<a href="#BIBLIOGRAPHY">BIBLIOGRAPHY</a>
not to print a page number on the first bibliography page.
<strong>Mom</strong>'s default is to print the page number.
<p>

<!---SUSPEND_PAGINATION--->

<a name="SUSPEND_PAGINATION"><h3><u>*Suspending pagination of bibliography pages</u></h3></a>
<p>
Macro: <strong>SUSPEND_PAGINATION</strong>
<br>
Macro: <strong>RESTORE_PAGINATION</strong>

<p>
<strong>SUSPEND_PAGINATION</strong> doesn't take an argument.
Invoked immediately prior to
<a href="#BIBLIOGRAPHY">BIBLIOGRAPHY</a>,
it turns off pagination for the duration of the bibliography.
<strong>Mom</strong> continues, however to increment page numbers
silently.
<p>
To restore normal document pagination after bibliographies, invoke
<strong>RESTORE_PAGINATION</strong> (again, with no argument)
immediately after you've finished with your bibliography.

<a name="BIBLIO_HEADER_CONTROL"><h2><u>2. Bibliography page header/footer control</u></h2></a>
<p>
<a name="BIBLIO_MODIFY_HDRFTR"></a>
If you wish to modify what appears in the header/footer that appears
on bibliography pages, make the changes before you invoke
<a href="#BIBLIOGRAPHY">BIBLIOGRAPHY</a>,
not afterwards.
<p>
Except in the case of
<a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>,
<strong>mom</strong> prints the same header or footer used throughout
the document on bibliography pages.  Chapters get treated differently
in that, by default, <strong>mom</strong> 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
<em>not</em> want <strong>mom</strong> to remove the centre string from
the bibliography pages headers/footers, invoke
<a href="#BIBLIOGRAPHY_HDRFTR_CENTER">BIBLIOGRAPHY_HEADER_CENTER</a>
with no argument. 
<p>
An important change you may want to make is to put the word
&quot;Bibliography&quot; in the header/footer centre position.
To do so, do
<p>
<pre>
	.HEADER_CENTER "Bibliography"
	           or
	.FOOTER_CENTER "Bibliography"
</pre>

prior to invoking <strong>.BIBLIOGRAPHY</strong>.  If your
<a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
is <kbd>CHAPTER</kbd>, you must also invoke
<a href="#BIBLIOGRAPHY_HDRFTR_CENTER">BIBLIOGRAPHY_HEADER_CENTER</a>
for the <strong>HEADER_CENTER</strong> to appear.
<p>

<a name="BIBLIO_HDRFTR_CENTER"><h3><u>*Bibliography page header/footer centre string</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_HEADER_CENTER</strong> toggle</nobr>

<p>
If your
<a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include
a centre string in the headers/footers that appear on bibliography pages,
invoke <strong>BIBLIOGRAPHY_HEADER_CENTER</strong> (or
<strong>BIBLIOGRAPHY_FOOTER_CENTER</strong>) with no argument.
<strong>Mom</strong>'s default is NOT to print the centre string.
<p>
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 (<strong>OFF, QUIT, Q, X</strong>...).
<p>

<a name="BIBLIO_ALLOWS_HEADERS"><h3><u>*Allow headers on bibliography pages</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_ALLOWS_HEADERS</strong> &lt;none&gt; | ALL</nobr>

<p>
By default, if <strong>HEADERS</strong> are on, <strong>mom</strong>
prints page headers on all bibliography pages except the first.  If you
don't want her to print headers on bibliography pages, do
<p>
<pre>
	.BIBLIOGRAPHY_ALLOWS_HEADERS OFF
</pre>

If you want headers on every page <em>including the first</em>, do
<p>
<pre>
	.BIBLIOGRAPHY_ALLOWS_HEADERS ALL
</pre>

<strong>NOTE:</strong> If <strong>FOOTERS</strong> are on,
<strong>mom</strong> prints footers on every bibliography page.  This is
a style convention.  In <strong>mom</strong>, there is no such beast
as <strong>BIBLIOGRAPHY_ALLOWS_FOOTERS OFF</strong>.
<p>

<a name="BIBLIO_MAIN_TITLE"><h2><u>3. Bibliography page first page head (title) control</u></h2>

<!---BIBLIO_STRING--->

<a name="BIBLIO_STRING"><h3><u>*Bibliography pages first page head (title) string</u></h3></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_STRING</strong> &quot;&lt;head to print at the top of bibliography pages&gt;&quot;</nobr>

<p>
By default, <strong>mom</strong> prints the word &quot;BIBLIOGRAPHY&quot;
as a head at the top of the first page of a bibliography.  If you want her
to print something else, invoke <strong>BIBLIOGRAPHY_STRING</strong> with
the bibliography page head you want, surrounded by double-quotes.  If
you don't want a head at the top of the first bibliography page, invoke
<strong>BIBLIOGRAPHY_STRING</strong> with a blank argument (either two
double-quotes side by side -- <kbd>&quot;&quot;</kbd> -- or no argument
at all).
<p>

<!---BIBLIO_STRING_CONTROL--->

<a name="BIBLIO_STRING_CONTROL"><h3><u>*Bibliography page first page head (title) control</u></h3></a>
<p>
See
<a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
<p>
<pre>
.BIBLIOGRAPHY_STRING_FAMILY    default = prevailing document family; default is Times Roman
.BIBLIOGRAPHY_STRING_FONT      default = bold
.BIBLIOGRAPHY_STRING_SIZE*     default = +1
.BIBLIOGRAPHY_STRING_QUAD      default = centred

*Relative to the size of the bibliography text (set with BIBLIOGRAPHY_PT_SIZE)
</pre>

<!---BIBLIO_STRING_UNDERSCORE--->

<a name="BIBLIO_STRING_UNDERSCORE"><h3><u>*Bibliography-page head (title) underscoring</h3></u></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_STRING_UNDERSCORE</strong> toggle | 2</nobr>

<p>
Invoked by itself, <strong>BIBLIOGRAPHY_STRING_UNDERSCORE</strong> will
underscore the bibliography page head.  Invoked with the argument 2
(i.e. the digit 2), <strong>BIBLIOGRAPHY_STRING_UNDERSCORE</strong> will
double-underscore the head.  Invoked with any other argument, the macro
disables underscoring of the head.
<p>
<strong>Mom</strong>'s default is to double-underscore the
head, therefore if you want no underscoring, you must insert
<kbd>.BIBLIOGRAPHY_STRING_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
NONE,</kbd> etc.) into your document prior to outputting a
bibliography with
<a href="#BIBLIOGRAPHY">BIBLIOGRAPHY</a>.

<!---BIBLIO_STRING_CAPS--->

<a name="BIBLIO_STRING_CAPS"><h3><u>*Bibliography-page head (title) automatic capitalization</h3></u></a>
<p>
<nobr>Macro: <strong>BIBLIOGRAPHY_STRING_CAPS</strong> toggle</nobr>

<p>
Invoked by itself, <strong>BIBLIOGRAPHY_STRING_CAPS</strong> will
automatically capitalize the bibliography page head.  Invoked with any
other argument, the macro disables automatic capitalization of the
head.
<p>
If you're generating a table of contents, you may want the
bibliography page head string in caps, but the toc entry in caps/lower
case.  If the argument to
<a href="#BIBLIOGRAPHY_STRING">BIBLIOGRAPHY_STRING</a>
is in caps/lower case and <strong>BIBLIOGRAPHY_STRING_CAPS</strong> is
on, this is exactly what will happen.
<p>
<strong>Mom</strong>'s default is to capitalize the bibliography-page
head string.
<p>

<br>

<hr>
<a href="letter.html#TOP">Next</a>&nbsp;&nbsp;
<a href="cover.html#TOP">Prev</a>&nbsp;&nbsp;
<a href="#TOP">Top</a>&nbsp;&nbsp;
<a href="toc.html">Back to Table of Contents</a>
</body>
</html>