public inbox for [email protected]  

help / color / mirror / Atom feed

From: Bruce Momjian <[email protected]>
To: Bruce Momjian <[email protected]>
Cc: Chris Meller <[email protected]>
Cc: PostgreSQL-documentation <[email protected]>
Subject: Re: Change to documentation headers
Date: Mon, 7 Feb 2011 21:00:16 -0500 (EST)
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

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  <[email protected]>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

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

view thread (19+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Change to documentation headers
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox