Re: Change to documentation headers

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Chris Meller <chris(at)doesnthaveone(dot)com>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Change to documentation headers
Date: 2011-02-08 02:00:16
Message-ID: 201102080200.p1820GA05396@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-www

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(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ It's impossible for everything to be true. +

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2011-02-08 02:51:54 Re: Why Produce PDF files?
Previous Message Bruce Momjian 2011-02-08 01:58:08 'literal' for numbers

Browse pgsql-www by date

  From Date Subject
Next Message Magnus Hagander 2011-02-13 16:43:17 Re: Versioning policy and pg_upgrade
Previous Message Bruce Momjian 2011-02-05 15:55:05 Re: Change to documentation headers