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

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