many contrib links are broken

Started by Peter Eisentrautalmost 15 years ago4 messagesdocs
Jump to latest
#1Peter Eisentraut
peter_e@gmx.net

The commit 159e3d86292cfec2a2828f9f69ac7a6cb1be242d created some funny
business out of many links to contrib modules. Take a look at this
page:

http://developer.postgresql.org/pgdocs/postgres/log-shipping-alternative.html

It now reads: "See the Section F.31 module for a reference
implementation of this." (where it previously said "the pg_standby
module") There are many other places like that now.

I don't think the toolchain changed in this area, so the whole change
was broken to begin with. The idea is sound, IMO, but the
implementation needs to be reevaluated.

#2Bruce Momjian
bruce@momjian.us
In reply to: Peter Eisentraut (#1)
Re: many contrib links are broken

Peter Eisentraut wrote:

The commit 159e3d86292cfec2a2828f9f69ac7a6cb1be242d created some funny
business out of many links to contrib modules. Take a look at this
page:

http://developer.postgresql.org/pgdocs/postgres/log-shipping-alternative.html

It now reads: "See the Section F.31 module for a reference
implementation of this." (where it previously said "the pg_standby
module") There are many other places like that now.

I don't think the toolchain changed in this area, so the whole change
was broken to begin with. The idea is sound, IMO, but the
implementation needs to be reevaluated.

Yep, this clearly needs cleanup. The README.links file I wrote says:

<xref>
use to get link text from the title of the target link; has no
close tag
http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

Is that not true? The URL seems to suggest that the title is used if
there is no xreflabel, though it suggests the the supplied text is
"Chapter ##: title". Of course, we are not seeing that behavior so
maybe README.links is wrong.

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

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

#3Peter Eisentraut
peter_e@gmx.net
In reply to: Bruce Momjian (#2)
Re: many contrib links are broken

On lör, 2011-05-07 at 14:28 -0400, Bruce Momjian wrote:

Yep, this clearly needs cleanup. The README.links file I wrote says:

<xref>
use to get link text from the title of the target link; has no
close tag

http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

Is that not true?

It is not true in general.

The URL seems to suggest that the title is used if
there is no xreflabel, though it suggests the the supplied text is
"Chapter ##: title". Of course, we are not seeing that behavior so
maybe README.links is wrong.

Using xreflabel might be the fix, but you'll have to try it to see if it
comes out OK.

#4Bruce Momjian
bruce@momjian.us
In reply to: Peter Eisentraut (#3)
Re: many contrib links are broken

Peter Eisentraut wrote:

On l?r, 2011-05-07 at 14:28 -0400, Bruce Momjian wrote:

Yep, this clearly needs cleanup. The README.links file I wrote says:

<xref>
use to get link text from the title of the target link; has no
close tag

http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

Is that not true?

It is not true in general.

The URL seems to suggest that the title is used if
there is no xreflabel, though it suggests the the supplied text is
"Chapter ##: title". Of course, we are not seeing that behavior so
maybe README.links is wrong.

Using xreflabel might be the fix, but you'll have to try it to see if it
comes out OK.

Thanks for the help. I added xreflabels to the contrib module pages and
that fixed the item you showed me, so we should be good now. I also
updated README.links to accurately descripbe xref. Applied patch
attached.

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

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

Attachments:

/rtmp/difftext/x-diffDownload+104-104