Re: code example wrapping - Mailing list pgsql-docs

Alvaro Herrera wrote:
> Bruce Momjian wrote:
> > Tom Lane wrote:
> > > Bruce Momjian <bruce@momjian.us> writes:
> > > > Also, is there any way to get a report of the lines that are too long?
> > >
> > > grep "Overfull hbox" from the tex log ...
> >
> > Can someone who can build the PDF docs post the output showing these
> > lines?  I can't build the PDF docs here.
>
> There are 1853 such reports in the output I have for a US run, but they
> reference a line number in the TeX source not SGML, so it's not easy to
> see what they are referring to.  For example
>
> Overfull \hbox (141.59937pt too wide) in paragraph at lines 65564--65564
> Overfull \hbox (28.1995pt too wide) in paragraph at lines 65612--65612
> Overfull \hbox (11.99951pt too wide) in paragraph at lines 65702--65702
> Overfull \hbox (17.3995pt too wide) in paragraph at lines 68738--68738
> Overfull \hbox (28.1995pt too wide) in paragraph at lines 68739--68739
>
>
> I think we could script extracting the TeX source that it refers to with
> some scripting.
>
> For now, the reports that are 4 digits or more points overfull are in
> paragraph at lines 268934 and following, which is just after this text:
>
>     view is restricted to show only
>     rows about tables that the current user can read.)
>     For example, we might do:
>
> This is a very wide table in perform.sgml, lines 556ff.  Maybe it can be
> displayed in \x for better formatting ... but then, the widest column is
> already too wide so maybe there's no point.

I have applied the attached documentation patch to explain how to find
TeX overflow boxes.

--
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + None of us is going to be here forever. +

Index: doc/src/sgml/docguide.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v
retrieving revision 1.81
diff -c -c -r1.81 docguide.sgml
*** doc/src/sgml/docguide.sgml    17 Mar 2010 17:12:31 -0000    1.81
--- doc/src/sgml/docguide.sgml    31 May 2010 22:13:00 -0000
***************
*** 643,648 ****
--- 643,668 ----
  save_size.pdfjadetex = 15000
  </programlisting>
     </para>
+
+   </sect2>
+
+   <sect2>
+    <title>Overflow Text</title>
+
+    <para>
+     Occasionally text is too wide for the printed margins, and in
+     extreme cases, too wide for the printed page, e.g.  non-wrapped
+     text, wide tables.  Overly wide text generates <quote>Overfull
+     hbox</quote> messages in the TeX log output file, e.g.
+     <filename>postgres-US.log</> or <filename>postgres-A4.log</>.
+     There are 72 points in an inch so anything reported as over 72
+     points too wide will probably not fit on the printed page (assuming
+     one inch margins).  To find the <acronym>SGML</acronym> text
+     causing the overflow, find the first page number mentioned above
+     the overflow message, e.g.  <literal>[50 XXX]</> (page 50), and look
+     at that page in the <acronym>PDF</acronym> file to see the overflow
+     text and adjust the <acronym>SGML</acronym> accordingly.
+    </para>
    </sect2>

    <sect2>