Subject: Re: Change to documentation headers
From: Peter Eisentraut <peter_e@gmx.net>
To: Bruce Momjian <bruce@momjian.us>
Cc: Chris Meller <chris@doesnthaveone.com>, PostgreSQL-documentation
	<pgsql-docs@postgresql.org>
In-Reply-To: <201103111207.p2BC7Pm14475@momjian.us>
References: <201103111207.p2BC7Pm14475@momjian.us>
Content-Type: text/plain; charset="UTF-8"
Date: Tue, 15 Mar 2011 22:28:28 +0200
Message-ID: <1300220908.7581.36.camel@vanquo.pezone.net>
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit

On fre, 2011-03-11 at 07:07 -0500, Bruce Momjian wrote:
> Peter, any status on this?

The summary below doesn't make much sense to me.  I'll play around with
it a little more, but while I understand the goals, the concrete
solution isn't yet clear.

> 
> ---------------------------------------------------------------------------
> 
> Bruce Momjian wrote:
> > Bruce Momjian wrote:
> > > Bruce Momjian wrote:
> > > > Bruce Momjian wrote:
> > > > > Chris Meller wrote:
> > > > > > 
> > > > > > On Feb 4, 2011, at 4:23 PM, Bruce Momjian wrote:
> > > > > > 
> > > > > > > I do like the chapter title there.
> > > > > > >
> > > > > > > Looking at "Home", we actually have two of them.  The "Home" at the top
> > > > > > > left of the page links to the PG homepage, while the "Home" at the
> > > > > > > bottom goes to the top of the 9.0 documentation.  That seems odd.  Maybe
> > > > > > > we need to remove the "Home" at the bottom, or rename it.
> > > > > > >
> > > > > > > You could get away with changing "Fast Backward" to "Up" and removing
> > > > > > > "Fast Forward".
> > > > > > 
> > > > > > I like the title and chapter reference at the top. The "PostgreSQL
> > > > > > x.y.z Documentation" title serves the same purpose as 'Home' at the
> > > > > > bottom, so it should be fine as-is. Making the chapter a link to the
> > > > > > same destination as 'Up' would make sense to me... You want to go up
> > > > > > to the chapter TOC and that's what I would expect to get if I clicked
> > > > > > on a chapter link (just as if I clicked on it in the main TOC).
> > > > > 
> > > > > That is an interesting idea.  I thought we had sub-sub-pages, but we
> > > > > don't --- every subpage has a chapter that should be the same as UP.  I
> > > > > think making that title a link is a great idea.  I think we can still
> > > > > remove fast forward/backward as just being too confusing.
> > > > 
> > > > Oops, a problem.  On this chapter page:
> > > > 
> > > > 	http://www.postgresql.org/docs/9.0/static/errcodes-appendix.html
> > > > 
> > > > there is no chapter name, and hence no "up" link for us, and we need one
> > > > there.  Perhaps we need a link to "VIII. Appendixes" there.  Peter, can
> > > > that be done?
> > > 
> > > More thinking --- "PostgreSQL 9.0.3 Documentation" at the top center is
> > > already clickable, so that can act as the home.  Let's duplicate that at
> > > the bottom too.
> > 
> > OK, so here is a summary:
> > 
> > 	o  remove fast forward/backward links
> > 	o  add book title where there is no heading
> > 	o  make book and chapter titles as links
> > 	o  make the bottom footer match the top header
> > 
> > Can we backpatch this to 8.2 so all our online documentation has it?
> > 
> > -- 
> >   Bruce Momjian  <bruce@momjian.us>        http://momjian.us
> >   EnterpriseDB                             http://enterprisedb.com
> > 
> >   + It's impossible for everything to be true. +
> 
> -- 
>   Bruce Momjian  <bruce@momjian.us>        http://momjian.us
>   EnterpriseDB                             http://enterprisedb.com
> 
>   + It's impossible for everything to be true. +
>