Documentation file compilation procedures

From: Andreas Pflug <pgadmin(at)pse-consulting(dot)de>
To: pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Documentation file compilation procedures
Date: 2004-11-22 18:27:49
Message-ID: 41A22FA5.7070404@pse-consulting.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgadmin-hackers

I just found the index not matching the files; the reason is that the
HTML generated files where used instead of HTMLHELP generated. The patch
needed to generate htmlhelp compatible html files is freshly posted to
pgsql-patches.

Doc HOWTO:
- cd pgsql/doc/src/sgml
- make htmlhelp
- Change the links to pg/* in index.hhk and toc.hhc
- copy html files to en_US/pg
- if necessary, join src/sgml/index.hhk into en_US/pgadmin3.hhk and
src/sgml/toc.hhc into en_US/pgadmin3.hhc. The pg/* versions should be
removed.
- execute pgadmin's help function, in order to have pgadmin2.hhp.cached
recreated
- touch pgadmin3.hhc and pgadmin3.hhk with Html Workshop, to make sure
the format is ok (if not, it will crash when generating pgadmin3.chm)
- create en_US/pgadmin3.zip.
- create en_US/pgadmin3.chm.
- clean up: in en_US, only pgadmin3.zip and tips.txt are needed.

Regards,
Andreas

Browse pgadmin-hackers by date

  From Date Subject
Next Message Ian Barwick 2004-11-22 23:42:27 Teensy documentation patch
Previous Message Miha Radej 2004-11-22 17:51:28 Re: RFC: Update wizard