/contrib/groff/contrib/mom/examples/README.txt

  1The files in this directory show mom in action.
  2
  3If you have downloaded and untarrred a version of mom from her
  4homepage, you'll see that none of the example files come with
  5corresponding PostScript (.ps) files, as they do with pre-compiled
  6versions of groff, or groff built from source.
  7
  8I haven't included the PostScript output because I want to
  9keep the mom archive as lean as possible.  To view the PostScript
 10output, process the files with groff and either
 11
 12    a) send the output to a separate file for previewing with a
 13       PostScript viewer such as gv (ghostview), or
 14
 15    b) to your printer.
 16
 17Using the file sample_docs.mom as an example, you would
 18accomplish a) like this:
 19
 20    groff -mom -Tps sample_docs.mom > sample_docs.ps
 21    gv sample_docs.ps
 22
 23Accomplishing b) depends on your printer setup, but a fairly
 24standard way to do it would be
 25
 26    groff -mom -Tps sample_docs.mom | lpr
 27
 28                  or
 29
 30    groff -mom -Tps -l sample_docs.mom
 31
 32Note: I don't recommend previewing with gxditview because it doesn't
 33render some of mom's effects properly.
 34
 35The files themselves
 36--------------------
 37
 38All are set up for 8.5x11 inch paper (US letter).
 39
 40***typesetting.mom**
 41
 42The file, typesetting.mom, demonstrates the use of typesetting tabs,
 43string tabs, line padding, multi-columns and various indent styles,
 44as well as some of the refinements and fine-tuning available via
 45macros and inline escapes.
 46
 47Because the file also demonstrates a "cutaround" using a small
 48picture (of everybody's favourite mascot, Tux), the PostScript file,
 49penguin.ps has been included in the directory.
 50
 51***sample_docs.mom***
 52
 53The file, sample_docs.mom, shows examples of three of the document
 54styles available with the mom's document processing macros, as well
 55as demonstrating the use of COLLATE.
 56
 57The PRINTSTYLE of this file is TYPESET, to give you an idea of mom's
 58default behaviour when typesetting a document.
 59
 60The last sample, set in 2 columns, shows off mom's flexibility
 61when it comes to designing documents.
 62
 63If you'd like to see how mom handles exactly the same file when the
 64PRINTSTYLE is TYPEWRITE (i.e. typewritten, double-spaced), simply
 65change
 66
 67    .PRINTSTYLE TYPESET
 68
 69to
 70
 71    .PRINTSTYLE TYPEWRITE
 72
 73near the top of the file. 
 74
 75***letter.mom***
 76
 77This is just the tutorial example from the momdocs, ready for
 78previewing.
 79
 80***elvis_syntax.new***
 81
 82For those who use the vi clone, elvis, you can paste this file into
 83your elvis.syn.  Provided your mom documents have the extension
 84.mom, they'll come out with colorized syntax highlighting.  The
 85rules in elvis_syntax aren't exhaustive, but they go a LONG way to
 86making mom files more readable.
 87
 88The file elvis_syntax (for pre-2.2h versions of elvis) is no longer
 89being maintained.  Users are encouraged to update to elvis 2.2h or
 90higher, and to use elvis_syntax.new for mom highlighting.
 91
 92I'll be very happy if someone decides to send me syntax highlighting
 93rules for emacs. :)
 94
 95***mom.vim***
 96
 97Christian V. J. Brüssow has kindly contributed a set of mom syntax
 98highlighting rules for use with vim.  Copy the file to your
 99~/.vim/syntax directory, then, if your vim isn't already set up to
100do so, enable mom syntax highlighting with
101
102    :syntax enable
103
104or
105
106    :syntax on
107
108Please note: I don't use vim, so I won't be making changes to this
109file myself.  Christian Brüssow is the maintainer of the ruleset,
110which is available on the Web at
111
112    http://www.cvjb.de/comp/vim/mom.vim
113
114Contact Christian (cvjb@cvjb.de) if you have any suggestions or
115requests.