contrib/mom/examples/README.txt

   1      -*- text -*-
   2     Copyright (C) 2004-2014  Free Software Foundation, Inc.
   3
   4     Copying and distribution of this file, with or without modification,
   5     are permitted in any medium without royalty provided the copyright
   6     notice and this notice are preserved.
   7
   8 ========================================================================
   9
  10 The files in this directory show mom in action.
  11
  12 If you have downloaded and untarrred a version of mom from her
  13 homepage, you'll see that none of the example files come with
  14 corresponding PDF (.pdf) files, as they do with pre-compiled
  15 versions of groff, or groff built from source.
  16
  17 I haven't included the PDF output because I want to keep the mom
  18 archive as lean as possible.  To view the PDF output, process the
  19 files with pdfmom(1).
  20
  21     pdfmom letter.mom > letter.pdf
  22     pdfmom mom-pdf.mom > mom-pdf.pdf
  23     pdfmom sample_docs.mom > sample_docs.pdf
  24     pdfmom typesetting.mom > typesetting.pdf
  25
  26 The files themselves
  27 --------------------
  28
  29 All are set up for US letter papersize except mom-pdf.mom, which
  30 uses A4.
  31
  32 ***typesetting.mom**
  33
  34 The file, typesetting.mom, demonstrates the use of typesetting tabs,
  35 string tabs, line padding, multi-columns and various indent styles,
  36 as well as some of the refinements and fine-tuning available via
  37 macros and inline escapes.
  38
  39 Because the file also demonstrates a cutaround using a small picture
  40 of everybody's favourite mascot, Tux, the PDF file, penguin.pdf has
  41 been included in the directory.
  42
  43 ***sample_docs.mom***
  44
  45 The file, sample_docs.mom, shows examples of three of the document
  46 styles available with the mom's document processing macros, as well
  47 as demonstrating the use of COLLATE.  It also shows off some of
  48 mom's PDF features, including a PDF outline and clickable links in
  49 the printable Table of Contents.
  50
  51 The last sample, set in 2 columns, demonstrates mom's flexibility
  52 when it comes to designing documents.
  53
  54 The PRINTSTYLE of this file is TYPESET, to give you an idea of mom's
  55 default behaviour when typesetting a document.
  56
  57 If you'd like to see how mom handles exactly the same file when the
  58 PRINTSTYLE is TYPEWRITE (ie typewritten, double-spaced), simply
  59 change .PRINTSTYLE TYPESET to .PRINTSTYLE TYPEWRITE near the top of
  60 the file.
  61
  62 ***letter.mom***
  63
  64 This is just the tutorial example from the momdocs, ready for
  65 previewing.
  66
  67 ***mom-pdf.mom***
  68
  69 The manual, Producing PDFs with mom and groff.
  70
  71 ***mom.vim***
  72
  73 The vim syntax highlighting rules are based on those provided by
  74 Christian V. J. Brüssow (cvjb@cvjb.de).  Copy mom.vim file to your
  75 ~/.vim/syntax directory; then, if your vim isn't already set up to
  76 do so, enable mom syntax highlighting with
  77
  78   :syntax enable
  79 or
  80   :syntax on
  81
  82 ***elvis_syntax.new***
  83
  84 For those who use the vi clone, elvis, you can paste this file into
  85 your elvis.syn.  Provided your mom documents have the extension
  86 .mom, they'll come out with colorized syntax highlighting.  The
  87 rules in elvis_syntax aren't exhaustive, but they go a long way to
  88 making mom files more readable.