11590SrgrimesThe files in this directory show mom in action.
21590Srgrimes
31590SrgrimesIf you have downloaded and untarrred a version of mom from her
41590Srgrimeshomepage, you'll see that none of the example files come with
51590Srgrimescorresponding PostScript (.ps) files, as they do with pre-compiled
61590Srgrimesversions of groff, or groff built from source.
71590Srgrimes
81590SrgrimesI haven't included the PostScript output because I want to
91590Srgrimeskeep the mom archive as lean as possible.  To view the PostScript
101590Srgrimesoutput, process the files with groff and either
111590Srgrimes
121590Srgrimes    a) send the output to a separate file for previewing with a
131590Srgrimes       PostScript viewer such as gv (ghostview), or
141590Srgrimes
151590Srgrimes    b) to your printer.
161590Srgrimes
171590SrgrimesUsing the file sample_docs.mom as an example, you would
181590Srgrimesaccomplish a) like this:
191590Srgrimes
201590Srgrimes    groff -mom -Tps sample_docs.mom > sample_docs.ps
211590Srgrimes    gv sample_docs.ps
221590Srgrimes
231590SrgrimesAccomplishing b) depends on your printer setup, but a fairly
241590Srgrimesstandard way to do it would be
251590Srgrimes
261590Srgrimes    groff -mom -Tps sample_docs.mom | lpr
271590Srgrimes
281590Srgrimes                  or
291590Srgrimes
301590Srgrimes    groff -mom -Tps -l sample_docs.mom
311590Srgrimes
321590SrgrimesNote: I don't recommend previewing with gxditview because it doesn't
331590Srgrimesrender some of mom's effects properly.
341590Srgrimes
351590SrgrimesThe files themselves
361590Srgrimes--------------------
371590Srgrimes
381590SrgrimesAll are set up for 8.5x11 inch paper (US letter).
391590Srgrimes
401590Srgrimes***typesetting.mom**
411590Srgrimes
421590SrgrimesThe file, typesetting.mom, demonstrates the use of typesetting tabs,
431590Srgrimesstring tabs, line padding, multi-columns and various indent styles,
441590Srgrimesas well as some of the refinements and fine-tuning available via
451590Srgrimesmacros and inline escapes.
461590Srgrimes
471590SrgrimesBecause the file also demonstrates a "cutaround" using a small
481590Srgrimespicture (of everybody's favourite mascot, Tux), the PostScript file,
491590Srgrimespenguin.ps has been included in the directory.
501590Srgrimes
511590Srgrimes***sample_docs.mom***
521590Srgrimes
531590SrgrimesThe file, sample_docs.mom, shows examples of three of the document
541590Srgrimesstyles available with the mom's document processing macros, as well
551590Srgrimesas demonstrating the use of COLLATE.
561590Srgrimes
571590SrgrimesThe PRINTSTYLE of this file is TYPESET, to give you an idea of mom's
581590Srgrimesdefault behaviour when typesetting a document.
591590Srgrimes
6024360SimpThe last sample, set in 2 columns, shows off mom's flexibility
611590Srgrimeswhen it comes to designing documents.
621590Srgrimes
631590SrgrimesIf you'd like to see how mom handles exactly the same file when the
641590SrgrimesPRINTSTYLE is TYPEWRITE (i.e. typewritten, double-spaced), simply
651590Srgrimeschange
661590Srgrimes
671590Srgrimes    .PRINTSTYLE TYPESET
681590Srgrimes
691590Srgrimesto
701590Srgrimes
711590Srgrimes    .PRINTSTYLE TYPEWRITE
721590Srgrimes
731590Srgrimesnear the top of the file. 
741590Srgrimes
751590Srgrimes***letter.mom***
761590Srgrimes
771590SrgrimesThis is just the tutorial example from the momdocs, ready for
781590Srgrimespreviewing.
791590Srgrimes
801590Srgrimes***elvis_syntax.new***
811590Srgrimes
821590SrgrimesFor those who use the vi clone, elvis, you can paste this file into
831590Srgrimesyour elvis.syn.  Provided your mom documents have the extension
841590Srgrimes.mom, they'll come out with colorized syntax highlighting.  The
851590Srgrimesrules in elvis_syntax aren't exhaustive, but they go a LONG way to
861590Srgrimesmaking mom files more readable.
871590Srgrimes
881590SrgrimesThe file elvis_syntax (for pre-2.2h versions of elvis) is no longer
891590Srgrimesbeing maintained.  Users are encouraged to update to elvis 2.2h or
901590Srgrimeshigher, and to use elvis_syntax.new for mom highlighting.
911590Srgrimes
921590SrgrimesI'll be very happy if someone decides to send me syntax highlighting
931590Srgrimesrules for emacs. :)
941590Srgrimes
951590Srgrimes***mom.vim***
961590Srgrimes
971590SrgrimesChristian V. J. Br�ssow has kindly contributed a set of mom syntax
981590Srgrimeshighlighting rules for use with vim.  Copy the file to your
991590Srgrimes~/.vim/syntax directory, then, if your vim isn't already set up to
1001590Srgrimesdo so, enable mom syntax highlighting with
1011590Srgrimes
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.
116