8000 doc: document problems with using xreflabel in XML docs · postgres/postgres@59fa7eb · GitHub
[go: up one dir, main page]
Skip to content

Commit 59fa7eb

Browse files
bmomjianbmomjian
committed
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
1 parent 0dd1eb3 commit 59fa7eb

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

‎doc/src/sgml/README.links

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,7 @@ Guidelines
4747
usually have xreflabels.
4848

4949
- For an external link, use <ulink>, with or without link text.
50+
51+
- xreflabels added to tags prevent the chapter/section for id's from being
52+
referenced; only the xreflabel is accessible. Therefore, use xreflabels
53+
only when linking is common, and chapter/section information is unneeded.

0 commit comments

Comments
 (0)
0