summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Momjian2020-06-11 22:44:49 +0000
committerBruce Momjian2020-06-11 22:44:49 +0000
commit59fa7eb60364b8e71fe0f515d6ad87c274af839b (patch)
tree8f1ea9335a9cc90fc732442231d814d27689b418
parent0dd1eb3aea636c0b28a18e1290ef108629e5eddd (diff)
doc: document problems with using xreflabel in XML docs
Reported-by: Peter Eisentraut Discussion: https://postgr.es/m/[email protected] Backpatch-through: master
-rw-r--r--doc/src/sgml/README.links4
1 files changed, 4 insertions, 0 deletions
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 <ulink>, 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.