Horton

Thread

Commits

  1. doc: Don't hide the "Up" link when it is the same as "Home"

  2. Add Up/Home link to the top of the HTML doc output.

  1. Missing "Up" navigation link between parts and doc root?

    Fabien COELHO <coelho@cri.ensmp.fr> — 2020-06-21T07:19:27Z

    Hello devs,

I've been annoyed that the documentation navigation does not always has an 
"Up" link. It has them inside parts, but the link disappears and you have 
to go for the "Home" link which is far on the right when on the root page 
of a part?

Is there a good reason not to have the "Up" link there as well?

-- 
Fabien.

  2. Re: Missing "Up" navigation link between parts and doc root?

    Bruce Momjian <bruce@momjian.us> — 2020-06-22T15:26:11Z

    On Sun, Jun 21, 2020 at 09:19:27AM +0200, Fabien COELHO wrote:
> 
> Hello devs,
> 
> I've been annoyed that the documentation navigation does not always has an
> "Up" link. It has them inside parts, but the link disappears and you have to
> go for the "Home" link which is far on the right when on the root page of a
> part?
> 
> Is there a good reason not to have the "Up" link there as well?

Yes, please. I asked for this feature in December of 2018 but have not
gotten around to implementing it:

	https://www.postgresql.org/message-id/flat/20181231235858.GB3052%40momjian.us

Can someone make this improvement?

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EnterpriseDB                             https://enterprisedb.com

  The usefulness of a cup is in its emptiness, Bruce Lee

  3. Re: Missing "Up" navigation link between parts and doc root?

    Peter Eisentraut <peter.eisentraut@2ndquadrant.com> — 2020-07-03T08:59:36Z

    On 2020-06-21 09:19, Fabien COELHO wrote:
> I've been annoyed that the documentation navigation does not always has an
> "Up" link. It has them inside parts, but the link disappears and you have
> to go for the "Home" link which is far on the right when on the root page
> of a part?
> 
> Is there a good reason not to have the "Up" link there as well?

The original stylesheets explicitly go out of their way to do it that 
way.  We can easily fix that by removing that special case.  See 
attached patch.

That patch only fixes it for the header.  To fix it for the footer as 
well, we'd first need to import the navfooter template to be able to 
customize it.  Not a big problem though.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

  4. Re: Missing "Up" navigation link between parts and doc root?

    Tom Lane <tgl@sss.pgh.pa.us> — 2020-07-03T13:45:31Z

    Peter Eisentraut <peter.eisentraut@2ndquadrant.com> writes:
> On 2020-06-21 09:19, Fabien COELHO wrote:
>> I've been annoyed that the documentation navigation does not always has an
>> "Up" link. It has them inside parts, but the link disappears and you have
>> to go for the "Home" link which is far on the right when on the root page
>> of a part?
>> 
>> Is there a good reason not to have the "Up" link there as well?

> The original stylesheets explicitly go out of their way to do it that 
> way.

Can we find any evidence of the reasoning?  As you say, that clearly was
an intentional choice.

			regards, tom lane

  5. Re: Missing "Up" navigation link between parts and doc root?

    Alvaro Herrera <alvherre@2ndquadrant.com> — 2020-07-03T19:57:44Z

    On 2020-Jul-03, Tom Lane wrote:

> Peter Eisentraut <peter.eisentraut@2ndquadrant.com> writes:
> > On 2020-06-21 09:19, Fabien COELHO wrote:
> >> I've been annoyed that the documentation navigation does not always has an
> >> "Up" link. It has them inside parts, but the link disappears and you have
> >> to go for the "Home" link which is far on the right when on the root page
> >> of a part?
> >> 
> >> Is there a good reason not to have the "Up" link there as well?
> 
> > The original stylesheets explicitly go out of their way to do it that 
> > way.
> 
> Can we find any evidence of the reasoning?  As you say, that clearly was
> an intentional choice.

If it helps, this seems to have been first introduced in commit b8691d838be.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

  6. Re: Missing "Up" navigation link between parts and doc root?

    Fabien COELHO <coelho@cri.ensmp.fr> — 2020-07-04T06:44:03Z

    >> The original stylesheets explicitly go out of their way to do it that
>> way.
>
> Can we find any evidence of the reasoning?  As you say, that clearly was
> an intentional choice.

Given the code, my guess would be the well-intentioned but misplaced 
desire to avoid a redundancy, i.e. two links side-by-side which point to 
the same place.

-- 
Fabien.

  7. Re: Missing "Up" navigation link between parts and doc root?

    Fabien COELHO <coelho@cri.ensmp.fr> — 2020-07-04T06:47:53Z

    Hello Peter,

> The original stylesheets explicitly go out of their way to do it that way. 
> We can easily fix that by removing that special case.  See attached patch.
>
> That patch only fixes it for the header.  To fix it for the footer as well, 
> we'd first need to import the navfooter template to be able to customize it.

Thanks for the patch, which applies cleanly, doc compiles, works for me 
with w3m.

> Not a big problem though.

Nope, just mildly irritating for quite a long time:-) So I'd go for back 
patching if it applies cleanly.

-- 
Fabien.

  8. Re: Missing "Up" navigation link between parts and doc root?

    Bruce Momjian <bruce@momjian.us> — 2020-08-25T19:48:51Z

    On Sat, Jul  4, 2020 at 08:47:53AM +0200, Fabien COELHO wrote:
> 
> Hello Peter,
> 
> > The original stylesheets explicitly go out of their way to do it that
> > way. We can easily fix that by removing that special case.  See attached
> > patch.
> > 
> > That patch only fixes it for the header.  To fix it for the footer as
> > well, we'd first need to import the navfooter template to be able to
> > customize it.
> 
> Thanks for the patch, which applies cleanly, doc compiles, works for me with
> w3m.
> 
> > Not a big problem though.
> 
> Nope, just mildly irritating for quite a long time:-) So I'd go for back
> patching if it applies cleanly.

Can we get Peter's patch for this applied soon?  Thanks.  Should I apply
it?

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EnterpriseDB                             https://enterprisedb.com

  The usefulness of a cup is in its emptiness, Bruce Lee

  9. Re: Missing "Up" navigation link between parts and doc root?

    Peter Eisentraut <peter.eisentraut@2ndquadrant.com> — 2020-09-06T14:59:11Z

    On 2020-08-25 21:48, Bruce Momjian wrote:
> On Sat, Jul  4, 2020 at 08:47:53AM +0200, Fabien COELHO wrote:
>>
>> Hello Peter,
>>
>>> The original stylesheets explicitly go out of their way to do it that
>>> way. We can easily fix that by removing that special case.  See attached
>>> patch.
>>>
>>> That patch only fixes it for the header.  To fix it for the footer as
>>> well, we'd first need to import the navfooter template to be able to
>>> customize it.
>>
>> Thanks for the patch, which applies cleanly, doc compiles, works for me with
>> w3m.
>>
>>> Not a big problem though.
>>
>> Nope, just mildly irritating for quite a long time:-) So I'd go for back
>> patching if it applies cleanly.
> 
> Can we get Peter's patch for this applied soon?  Thanks.  Should I apply
> it?

I have made the analogous changes to the footer as well and committed this.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

  10. Re: Missing "Up" navigation link between parts and doc root?

    Bruce Momjian <bruce@momjian.us> — 2020-09-08T19:10:53Z

    On Sun, Sep  6, 2020 at 04:59:11PM +0200, Peter Eisentraut wrote:
> On 2020-08-25 21:48, Bruce Momjian wrote:
> > On Sat, Jul  4, 2020 at 08:47:53AM +0200, Fabien COELHO wrote:
> > > 
> > > Hello Peter,
> > > 
> > > > The original stylesheets explicitly go out of their way to do it that
> > > > way. We can easily fix that by removing that special case.  See attached
> > > > patch.
> > > > 
> > > > That patch only fixes it for the header.  To fix it for the footer as
> > > > well, we'd first need to import the navfooter template to be able to
> > > > customize it.
> > > 
> > > Thanks for the patch, which applies cleanly, doc compiles, works for me with
> > > w3m.
> > > 
> > > > Not a big problem though.
> > > 
> > > Nope, just mildly irritating for quite a long time:-) So I'd go for back
> > > patching if it applies cleanly.
> > 
> > Can we get Peter's patch for this applied soon?  Thanks.  Should I apply
> > it?
> 
> I have made the analogous changes to the footer as well and committed this.

I see this only applied to master.  Shouldn't this be backpatched?

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EnterpriseDB                             https://enterprisedb.com

  The usefulness of a cup is in its emptiness, Bruce Lee

  11. Re: Missing "Up" navigation link between parts and doc root?

    Peter Eisentraut <peter.eisentraut@2ndquadrant.com> — 2020-09-10T14:00:47Z

    On 2020-09-08 21:10, Bruce Momjian wrote:
> On Sun, Sep  6, 2020 at 04:59:11PM +0200, Peter Eisentraut wrote:
>> I have made the analogous changes to the footer as well and committed this.
> 
> I see this only applied to master.  Shouldn't this be backpatched?

I wasn't planning to.  It's not a bug fix.

Other thoughts?

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

  12. Re: Missing "Up" navigation link between parts and doc root?

    Fabien COELHO <coelho@cri.ensmp.fr> — 2020-09-11T12:58:51Z

    > On 2020-09-08 21:10, Bruce Momjian wrote:
>> 
>> I see this only applied to master.  Shouldn't this be backpatched?
>
> I wasn't planning to.  It's not a bug fix.
>
> Other thoughts?

Yep. ISTM nicer if all docs have the same navigation, especially as 
googling often points to random versions. No big deal anyway, in six year 
all supported versions will have a up link on the part level! :-)

-- 
Fabien.

  13. Re: Missing "Up" navigation link between parts and doc root?

    Peter Eisentraut <peter.eisentraut@2ndquadrant.com> — 2020-09-12T18:37:52Z

    On 2020-09-11 14:58, Fabien COELHO wrote:
> 
>> On 2020-09-08 21:10, Bruce Momjian wrote:
>>>
>>> I see this only applied to master.  Shouldn't this be backpatched?
>>
>> I wasn't planning to.  It's not a bug fix.
>>
>> Other thoughts?
> 
> Yep. ISTM nicer if all docs have the same navigation, especially as
> googling often points to random versions. No big deal anyway, in six year
> all supported versions will have a up link on the part level! :-)

Okay, backpatched to PG10.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services