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

   1 The files in this directory show mom in action.  I haven't included
   2 PostScript output from the files because I want to keep the mom
   3 archive as lean as possible.  In order to see the PostScript output of
   4 these files, process them with groff, sending the output either to a
   5 separate file for previewing with gv (ghostview) or to your printer.
   6 I don't recommend previewing with gxditview because it doesn't render
   7 some of mom's effects properly.
   8
   9 All the files are set up for 8.5ix11i paper.
  10
  11 macros.mom
  12 ----------
  13
  14 This file demonstrates the use of typesetting tabs, string tabs,
  15 line padding, multi-columns and various indent styles, as well as
  16 some of the refinements and fine-tuning available via macros and
  17 inline escapes.
  18
  19 Because the file also demonstrates a "cutaround" using a small picture
  20 (of Tux), the PostScript file has been included in the directory.
  21
  22 typeset.mom
  23 -----------
  24
  25 This file contains samples of three of the document styles available
  26 with the document processing macros, as well as demonstrating the
  27 use of COLLATE.  The relatively rare BREAK_QUOTE macro is also used.
  28 The PRINTSTYLE of this file is TYPESET, letting you get a look at mom's
  29 default behaviour when she typesets a document.  The last sample,
  30 set in 2 columns, shows a few of the ways in which you can modify
  31 mom's behaviour.
  32
  33 typewrite.mom
  34 -------------
  35
  36 Using the first two samples from typeset.mom, this file shows what
  37 "typewritten, double-spaced" documents (PRINTSTYLE TYPEWRITE) look
  38 like.
  39
  40 letter.mom
  41 ----------
  42
  43 This is just the tutorial example from the momdocs, ready for
  44 previewing.
  45
  46 elvis_syntax
  47 ------------
  48
  49 For those who use the vi clone, elvis, you can paste this file into
  50 your elvis.syn file.  Provided your mom documents have the extension
  51 .mom, they'll come out with colorized syntax highlighting.  The rules
  52 in elvis_syntax aren't exhaustive, but they go a LONG way to making mom
  53 files more readable.
  54
  55 I'll be very happy if someone sends me syntax highlighting rules for vim
  56 and emacs. :)