From 59fa7eb60364b8e71fe0f515d6ad87c274af839b Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Thu, 11 Jun 2020 18:44:49 -0400 Subject: [PATCH] doc: document problems with using xreflabel in XML docs Reported-by: Peter Eisentraut Discussion: https://postgr.es/m/8315c0ca-7758-8823-fcb6-f37f9413e6b6@2ndquadrant.com Backpatch-through: master --- doc/src/sgml/README.links | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/src/sgml/README.links b/doc/src/sgml/README.links index c8348896962..4181e0877b5 100644 --- a/doc/src/sgml/README.links +++ b/doc/src/sgml/README.links @@ -47,3 +47,7 @@ Guidelines usually have xreflabels. - For an external link, use , with or without link text. + +- xreflabels added to tags prevent the chapter/section for id's from being + referenced; only the xreflabel is accessible. Therefore, use xreflabels + only when linking is common, and chapter/section information is unneeded. -- 2.39.5