diff --git a/doc/src/sgml/README.links b/doc/src/sgml/README.links index c3a93680ab..1991c20b23 100644 --- a/doc/src/sgml/README.links +++ b/doc/src/sgml/README.links @@ -1,4 +1,4 @@ - + Linking within SGML documents can be confusing, so here is a summary: @@ -7,22 +7,20 @@ Intra-document Linking ---------------------- - used to link to a section without supplying text for the link; - text comes from the link target; has no close tag + use to get link text from the title of the target link; has no + close tag http://www.oasis-open.org/docbook/documentation/reference/html/xref.html - allows link text to be supplied, requires + use to supply text for the link, requires http://www.oasis-open.org/docbook/documentation/reference/html/link.html - linkend= - controls the target of the link/xref + controls the target of the link/xref, required endterm= - allows the text of the link/xref to be taken from a different - link target; endterm in a overrides the supplied text - + for , allows the text of the link/xref to be taken from a + different link target title External Linking @@ -34,12 +32,12 @@ External Linking http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html url= - used by to specify the URL + used by to specify the URL, required Guidelines ---------- -o Do not use endterm with because the supplied text is ignored; use - +o If you want to supply text, use , else o Do not use text with so the URL appears in printed output +o You can supply text at the target location with 'xreflabel'