Thread: BUG #1986: Please include ONE BIG .txt and .HTML file in *docs*.tar.gz

The following bug has been logged online:

Bug reference:      1986
Logged by:          Jari Aalto
Email address:      jari.aalto@cante.net
PostgreSQL version: 8.0.4
Operating system:   Windows 2000 sp 5
Description:        Please include ONE BIG .txt and .HTML file in
*docs*.tar.gz
Details:

The postgreSQL documentation archive provides *.sgml sources. Please
consider also providing following files  in the archive:

  <postgresql-N.N>/doc/html/manual.html
  <postgresql-N.N>/doc/html/manual.txt

This ONE BIG file will help loading it off-line to
a web browser (or editor *.txt), and to make quick searches on backward and
forward.

Jari

Am Freitag, 21. Oktober 2005 17:31 schrieb Jari Aalto:
> This ONE BIG file will help loading it off-line to
> a web browser (or editor *.txt), and to make quick searches on backward and
> forward.

This wouldn't be hard to implement.  Are others interested in this?

Peter Eisentraut <peter_e@gmx.net> writes:
> Am Freitag, 21. Oktober 2005 17:31 schrieb Jari Aalto:
>> This ONE BIG file will help loading it off-line to
>> a web browser (or editor *.txt), and to make quick searches on backward and
>> forward.

> This wouldn't be hard to implement.  Are others interested in this?

I'd object to bloating the tarball itself with two redundant copies of
the documentation ... especially on the basis of only one request.
But couldn't we make such a version available for separate download
by those who want it?

            regards, tom lane

> > This ONE BIG file will help loading it off-line to a web=20
> browser (or=20
> > editor *.txt), and to make quick searches on backward and forward.
>=20
> This wouldn't be hard to implement.  Are others interested in this?

The original bug talked about Windows - I'd just like to add that on
Windows we will already do this on 8.1, in the form of a CHM file.
That doesn't mean we shouldn't do sometihng for other platforms, though
;-)

//Magnus

| Peter Eisentraut <peter_e AT gmx.net> writes:
| > Am Freitag, 21. Oktober 2005 17:31 schrieb Jari Aalto:
| >> This ONE BIG file will help loading it off-line to
| >> a web browser (or editor *.txt), and to make quick searches on backward and
| >> forward.
|
| > This wouldn't be hard to implement.  Are others interested in this?
|
| I'd object to bloating the tarball itself with two redundant copies of
| the documentation ... especially on the basis of only one request.
| But couldn't we make such a version available for separate download
| by those who want it?

Thanks fo taking this issue forward. It would increase the
archive much because html and text files compress extremely
well. The logical place for the documentation, is the "doc"
package that already includes FAQ.

Perhaps you meant to separate:

- pure source (*.sgml):  *-doc-source.tar.gz
- generated files: *-doc-generated.tar.gz

Jari

| > > This ONE BIG file will help loading it off-line to a web=20
| > browser (or=20
| > > editor *.txt), and to make quick searches on backward and forward.
| >=20
| > This wouldn't be hard to implement.  Are others interested in this?
|
| The original bug talked about Windows - I'd just like to add that on
| Windows we will already do this on 8.1, in the form of a CHM file.
| That doesn't mean we shouldn't do sometihng for other platforms, though

If I mentioned Windows, that was a mistake. I was talking in general interest.

The *.chm file is no subtitute for good text editor with
excellent search capabilities like Emacs + M-x occur / C-s /
C-r with word grabbing and all other features. Emacs is
available to Win32 as well.

The BIG HTML file is user friendly for student classes,
where it it posisble to serch within the browser window with
"find" to demonstrate the various places.

The one HTML also servers as a Printer format.

Jari