Skip site navigation (1) Skip section navigation (2)

Re: Reference manual

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Peter Eisentraut <peter_e(at)gmx(dot)net>
Cc: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>, Vince Vielhaber <vev(at)michvhf(dot)com>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Reference manual
Date: 2001-02-09 18:16:07
Message-ID: 20494.981742567@sss.pgh.pa.us (view raw or flat)
Thread:
Lists: pgsql-docs
Peter Eisentraut <peter_e(at)gmx(dot)net> writes:
> As far as the HTML-formatted docs go and as far as 7.1 (and future) goes,
> there should only be exactly one link, which points to the index.html of
> the intergrated doc.  There will no longer be separated docs, because
> that's why there's an integrated doc with a title page and all the links.

A complaint that someone made on the lists last night crystallized
something that's been bothering me for awhile now: the front page of the
integrated docs (http://www.postgresql.org/devel-corner/docs/postgres/)
is too sparse.  If you don't already understand the layout of the docs,
it's not clear where you want to go from here.

I think it would work a lot better if this page showed not just the six
top-level document names, but the first sublevel (ie, chapter headings)
within each one.  That would give people a sense of what is in each
document, and it'd also save a level of click-through in many cases,
since you could click straight to the chapter you want.  It looks like
this would expand the page from six lines to about fifty, which doesn't
seem unreasonable.

I have no idea if this is easy, hard, or impossible to do given our
current documentation tools, but if it's possible I think it would be
a good improvement.

			regards, tom lane

In response to

Responses

pgsql-docs by date

Next:From: Vince VielhaberDate: 2001-02-09 18:26:17
Subject: Re: 7.1 printed manuals
Previous:From: Bruce MomjianDate: 2001-02-09 18:15:39
Subject: Re: Open 7.1 items

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group