[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Building OSKit-Mach (texinfo format)

From: Robert J. Chassell
Subject: Re: Building OSKit-Mach (texinfo format)
Date: Sat, 22 Sep 2001 13:14:35 +0000 (UTC)

   Here's the conversion to texinfo of my oskit-mach document that I promised. 
   As this is my first texi doc, please check it over for your typical newbie 
   formatting errors as well as for content. 

The document formats without reported error, except for one overfull
and one underfull hbox in the TeX dvi output.

An underful hbox is usually not a problem.  It means more whitespace
than normal between paragraphs.  On the other hand, an overfull hbox
often is a problem since it means a line sticks out into the right
margin.  I try to get rid of all overfull hboxes, and don't much worry
about underfull hboxes, although I try to avoid those, too.

(I have not looked at the document's content, nor at the actual
output, just the formatters' reports.)

It is convenient to include the following summary of shell commands at
the beginning of your Texinfo document.  This set of commands makes it
easy for reviewers and users to create the different outputs.  You can
run them in shell in Emacs, or copy them to an Xterm in X Windows.

I use these shell commands to check whether my Texinfo is free of
reported errors.  Then I concentrate on page breaks and content.  (To
ensure good page breaks, I often place an `@need 1250' command before
a line that preceeds an @example environment, such as a line on its
own that says `For example:'.)

 ## Summary of shell commands to create various output formats:

    ## Info output
    makeinfo --no-split --paragraph-indent=0 --verbose hurd-oskit-doc.texi

    ## DVI output
    texi2dvi hurd-oskit-doc.texi

    ## HTML output
    texi2html hurd-oskit-doc.texi
    makeinfo --html --no-split --verbose hurd-oskit-doc.texi

    ## Plain text output
    makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
    --verbose --no-headers --output=hurd-oskit-doc.txt hurd-oskit-doc.texi

@end ignore

Also, I find that @smallbook produces the best size printed output,
even on US letter sized paper or on A4 paper.  My eyes have an easier
time tracking `conventional book' length of lines in @smallbook and my
red editor's pen prefers the wider margins.  (If your examples are
wide, @smallbook requires that you replace @example with

    Robert J. Chassell                  bob@rattlesnake.com
    Rattlesnake Enterprises             http://www.rattlesnake.com

reply via email to

[Prev in Thread] Current Thread [Next in Thread]