PageRenderTime 14ms CodeModel.GetById 8ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/contrib/groff/contrib/mm/NOTES

https://bitbucket.org/freebsd/freebsd-head/
#! | 105 lines | 79 code | 26 blank | 0 comment | 0 complexity | 8bdf78df8a396c10da55fe3aa7fd877e MD5 | raw file
  1######################################################################
  2$Id: NOTES,v 2.0 2000/09/14 03:40:24 jhaegg Exp $
  3
  4Beware!
  5This may be old information. Trust only the source. :-)
  6
  7Implementation notes. (Or how to make your own national mm)
  8
  9Different commands:
 10
 11COVER [arg]
 12MT [arg [addressee]]
 13The arg is part of a filename in mm/*.MT or mm/*.cov.
 14This file is read when the macro is executed. Therefore it must be
 15put before any text output.
 16In each file there are definitions of all extra macros needed for the
 17cover sheet. MT files is only for compatibility reasons, and has several
 18limits due to that it don't know when the cover starts, and cannot
 19change sizes. Use COVER for new coversheet macros.
 20
 21But with MT it is possible to write all of the AT&T covers.
 22An example can be found in mm/0.MT.
 23
 24When writing a new cover using COVER, have in mind that the cover
 25should print the page with the COVEND macro. This macro
 26should be defined by the new macrofile.
 27
 28Here is a part of ms.cov:
 29> .\"-----------------
 30> .de COVEND
 31> .sp |4.2c
 32> .cov@print-title
 33> .cov@print-authors
 34> .cov@print-firm
 35> .cov@print-abstract
 36> .cov@print-date
 37This is important, since COVER disables the page header.
 38> .pg@enable-top-trap
 39Should begin with page one (normally).
 40> .bp 1
 41And enable the trap at the page footer.
 42> .pg@enable-trap
 43> ..
 44
 45#########################
 46
 47Variables for covers:
 48I = integer
 49S = string
 50D = diversion
 51M = macro
 52
 53Name			Type	Desc.
 54cov*au			I	The number of authors.
 55
 56cov*title		M	Title collected with .TL.
 57
 58cov*au!x!y		S	Author(s) given to .AU
 59cov*at!x!y		S	Author(s) title given to .AT
 60				x is the author-index [1-cov*au],
 61				y is the argument-index [1-9].
 62				Look at the table with indexes.
 63
 64cov*firm		I	Author(s) firm.
 65
 66cov*abs-arg		I	Argument to abstract.
 67
 68cov*abs-ind		I	Indent for abstract.
 69
 70cov*abs-name		S	The string 'ABSTRACT', changed with .AST
 71
 72cov*abstract		M	The abstract.
 73
 74cov*new-date		S	The date (todays date if ND is not used)
 75
 76cov*mt-type		S	MT type
 77cov*mt-addresse 	S	MT addressee
 78
 79
 80##########################
 81Argument-index for cov*au:
 82
 83Index		Desc.
 841		name
 852		initials
 863		location
 874		department
 885		extension
 896		room
 907		arg 7
 918		arg 8
 929		arg 9
 93
 94The location is set to the contents of string cov*location-xxxx
 95if location is equal to xxxx and cov*location-xxxx is defined
 96in the file locale.
 97
 98
 99Argument-index for cov*at:
100
101Index		Desc.
1021		title 1
103.		.
104.		.
1059		title 9