mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-09-30 18:11:18 +02:00
b060e6c1f5
The guideline to "not use text with <ulink> so the URL appears in printed output" is obsolete, since the URL appears as a footnote in printed output in that case. Reported-by: Chapman Flack <chap@anastigmatix.net> Discussion: https://www.postgresql.org/message-id/5C4B1F2F.2000106@anastigmatix.net
46 lines
1.2 KiB
Plaintext
46 lines
1.2 KiB
Plaintext
<!-- doc/src/sgml/README.links -->
|
|
|
|
Linking within DocBook documents can be confusing, so here is a summary:
|
|
|
|
|
|
Intra-document Linking
|
|
----------------------
|
|
|
|
<xref>
|
|
use to get chapter/section number from the title of the target
|
|
link, or xreflabel if defined at the target, or refentrytitle if target
|
|
is a refentry; has no close tag
|
|
http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
|
|
|
|
<link>
|
|
use to supply text for the link, requires </link>
|
|
http://www.oasis-open.org/docbook/documentation/reference/html/link.html
|
|
|
|
linkend=
|
|
controls the target of the link/xref, required
|
|
|
|
endterm=
|
|
for <xref>, allows the text of the link/xref to be taken from a
|
|
different link target title
|
|
|
|
|
|
External Linking
|
|
----------------
|
|
|
|
<ulink>
|
|
like <link>, but uses a URL (not a document target); requires
|
|
</ulink>; if no text is specified, the URL appears as the link
|
|
text
|
|
http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html
|
|
|
|
url=
|
|
used by <ulink> to specify the URL, required
|
|
|
|
|
|
Guidelines
|
|
----------
|
|
|
|
o If you want to supply text, use <link>, else <xref>
|
|
o Specific nouns like GUC variables, SQL commands, and contrib modules
|
|
usually have xreflabels
|