From 908e2c7fd1b749ec60acde3fc9306211fb7839d2 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Sat, 10 Jan 2009 04:40:08 +0000 Subject: [PATCH] Add file to explain SGML linking options, for use by SGML document writers. --- doc/src/sgml/README.links | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 doc/src/sgml/README.links diff --git a/doc/src/sgml/README.links b/doc/src/sgml/README.links new file mode 100644 index 0000000000..961f86ea7c --- /dev/null +++ b/doc/src/sgml/README.links @@ -0,0 +1,34 @@ + + +Linking within SGML documents can be confusing, so here is a summary: + + +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 + http://www.oasis-open.org/docbook/documentation/reference/html/xref.html + + + allows link text to be supplied, requires + http://www.oasis-open.org/docbook/documentation/reference/html/link.html + + +linkend= + controls the target of the link/xref + +endterm= + allows the text of the link/xref to be taken from a different + link target; endterm in a overrides the supplied text + + +External Linking +---------------- + + like , but uses a URL (not a document target); requires + ; 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 to specify the URL