postgres.git / summary / log / commit / refs

commit    59fa7eb60364b8e71fe0f515d6ad87c274af839b
Author:   Bruce Momjian <bruce@momjian.us>
Date:     Thu Jun 11 22:44:49 2020 +0000
First released in: 14.0

    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 <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.


[parent: 0dd1eb3aea63]