Re: Switching to XML - Mailing list pgsql-docs

Peter Eisentraut wrote:
> Am Freitag, 15. Dezember 2006 03:45 schrieb Bruce Momjian:
> > I have applied the attached documentation patch to HEAD and 8.2.X to
> > document the use of Tom's patch to openjade to get ouput in a reasonable
> > amount of time.
>
> This is no longer accurate in 8.3.  A workaround has been installed in the
> stylesheets to arrive at the same result.

OK, I have talked to Peter via IM and now understand that his change to
stylesheet.dsl avoids the bug Tom found and fixed, so instead of
mentioning the patch in the SGML docs, I added a comment in the
stylesheet.dsl file and pointed to the URL.

Also, the double-run of the PDF does not fix the index.  Only a proper
bookindex.sgml does, that, so I removed the double runs and either Peter
or I will work on issuing a warning when the bookindex.sgml file isn't
proper, so people know to run it again.

Revert patch attached and applied to HEAD and 8.2.X.

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

  + If your life is a hard drive, Christ can be your backup. +
Index: doc/src/sgml/Makefile
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/Makefile,v
retrieving revision 1.85
diff -c -c -r1.85 Makefile
*** doc/src/sgml/Makefile    15 Dec 2006 01:20:59 -0000    1.85
--- doc/src/sgml/Makefile    15 Dec 2006 16:29:03 -0000
***************
*** 99,104 ****
--- 99,107 ----

  COLLATEINDEX := LC_ALL=C $(PERL) $(COLLATEINDEX) -f -g

+ # If HTML.index does not exist, create a dummy bookindex.sgml.  During the
+ # next build, create bookindex.sgml with the proper index contents.  A proper
+ # bookindex.sgml is required to have an index in the output.
  ifeq (,$(wildcard HTML.index))
  bookindex.sgml:
      $(COLLATEINDEX) -o $@ -N
***************
*** 136,164 ****

  JADE.tex.call = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d $(srcdir)/stylesheet.dsl -t tex -V tex-backend -i
output-print

! %-A4.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl
!     # multiple runs are necessary to create proper index entries
!     $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=A4 -o $@ $<
      $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=A4 -o $@ $<

! %-US.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl
!     # multiple runs are necessary to create proper index entries
!     $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=USletter -o $@ $<
      $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=USletter -o $@ $<

! %-A4.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl
!     # multiple runs are necessary to create proper index entries
!     $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=A4 -o $@ $<
      $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=A4 -o $@ $<

! %-US.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl
!     # multiple runs are necessary to create proper index entries
!     $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=USletter -o $@ $<
      $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=USletter -o $@ $<

  %.dvi: %.tex-ps
      @rm -f $*.aux $*.log
!     # multiple runs are necessary to create proper index entries
      jadetex $<
      jadetex $<
      jadetex $<
--- 139,159 ----

  JADE.tex.call = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d $(srcdir)/stylesheet.dsl -t tex -V tex-backend -i
output-print

! %-A4.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl bookindex.sgml
      $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=A4 -o $@ $<

! %-US.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl bookindex.sgml
      $(JADE.tex.call) -V texdvi-output -V '%paper-type%'=USletter -o $@ $<

! %-A4.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl bookindex.sgml
      $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=A4 -o $@ $<

! %-US.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl bookindex.sgml
      $(JADE.tex.call) -V texpdf-output -V '%paper-type%'=USletter -o $@ $<

  %.dvi: %.tex-ps
      @rm -f $*.aux $*.log
!     # multiple runs are necessary to create proper intra-document links
      jadetex $<
      jadetex $<
      jadetex $<
***************
*** 169,175 ****

  %.pdf: %.tex-pdf
      @rm -f $*.aux $*.log $*.out
!     # multiple runs are necessary to create proper index entries
      pdfjadetex $<
      pdfjadetex $<
      pdfjadetex $<
--- 164,170 ----

  %.pdf: %.tex-pdf
      @rm -f $*.aux $*.log $*.out
!     # multiple runs are necessary to create proper intra-document links
      pdfjadetex $<
      pdfjadetex $<
      pdfjadetex $<
Index: doc/src/sgml/docguide.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v
retrieving revision 1.62
diff -c -c -r1.62 docguide.sgml
*** doc/src/sgml/docguide.sgml    15 Dec 2006 02:44:28 -0000    1.62
--- doc/src/sgml/docguide.sgml    15 Dec 2006 16:29:03 -0000
***************
*** 115,123 ****
         <acronym>DSSSL</acronym> stylesheets), as well as a number of
         related tools.  <productname>Jade</productname> is now being
         maintained by the OpenJade group, no longer by James Clark.
-        (If generating Postscript or PDF output, you will need to
-        compile from source and use a special patch to get output
-        in a reasonable amount of time.)
        </para>
       </listitem>
      </varlistentry>
--- 115,120 ----
***************
*** 298,311 ****
          installed and you want to install the rest of the tool chain
          locally.)
         </para>
-
-        <para>
-         OpenJade release 1.3.2 and perhaps earlier and later releases
-         have a known bug that causes Postscript and PDF output
-         generation to take days.  This <ulink
-         url="http://archives.postgresql.org/pgsql-docs/2006-12/msg00064.php">patch</ulink>
-         fixes the problem and generates output in a few minutes.
-        </para>
        </step>

        <step id="doc-openjade-install">
--- 295,300 ----
Index: doc/src/sgml/stylesheet.dsl
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/stylesheet.dsl,v
retrieving revision 1.31
diff -c -c -r1.31 stylesheet.dsl
*** doc/src/sgml/stylesheet.dsl    10 Dec 2006 01:55:29 -0000    1.31
--- doc/src/sgml/stylesheet.dsl    15 Dec 2006 16:29:03 -0000
***************
*** 280,285 ****
--- 280,293 ----
  (define %refentry-new-page%     #t)
  (define %refentry-keep%         #f)

+ ;; Indentation of verbatim environments.  (This should really be done
+ ;; with start-indent in DSSSL.)
+ ;; Use of indentation in this area exposes a bug in openjade,
+ ;; http://archives.postgresql.org/pgsql-docs/2006-12/msg00064.php
+ ;; (define %indent-programlisting-lines% "    ")
+ ;; (define %indent-screen-lines% "    ")
+ ;; (define %indent-synopsis-lines% "    ")
+

  ;; Default graphic format: Jadetex wants eps, pdfjadetex wants pdf.
  ;; (Note that pdfjadetex will not accept eps, that's why we need to