Re: [Groff] Documentation for -mom

[Peter Schaffter]

Sorry not to get back on this right away.  I've been away for a
couple of days--work and computer free!

On Fri, Sep 19, 2014, Ingo Schwarze wrote:
> >> I am loking for an "easy" documentation about -mom.
> >> This documentation should discribe how -mom macros are working.
> 
> > Have you seen http://www.schaffter.ca/mom/mom-01.html ?

This is the definitive online documentation.  The same documentation
is also always present in the download tarballs on the mom site.

  http://www.schaffter.ca/mom/mom-2.0-c.tar.gz
 
> Given that the build systems disables building HTML documentation
> when some support software is missing on the target system and
> that the main mom documentation is (very unfortunately, but that's
> the current state of affairs) HTML, we end up in a situation where
> some groff installations do not include full mom documentation.

A lot of mom users would disagree that having the documentation in
html is unfortunate. :)  However, I'm going to have a look at the
situation of disabling building html when support software is
missing.  The mom docs require no special build tools, hence there's
no reason not to include the docs in every installation.

> To mitigate that situation, i think it would help a bit to include
> a link to http://www.schaffter.ca/mom/mom-04.html (that file name
> seems a bit awkward; is it stable?) in contrib/mom/groff_mom.man
> below SEE ALSO.

Yes, that would help.  I'll get onto it.  The link should probably
point to mom-01.html, though, not mom-04.html.  And yes, the
filename is stable.  I own the domain and it's hosted on iPage, so
it's not going anywhere soon. :)

Something else that would help, too, would be converting the docs to
pdf.  It's kind of a back-burner project, though.  Although they're
written in xhtml, which will ease the process, re-organizing the
docs for print won't be quite so simple.

Cheers.

-- 
Peter Schaffter
http://www.schaffter.ca