← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/README.links

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/README.links
 
1
<!-- doc/src/sgml/README.links -->
 
2
 
 
3
Linking within SGML documents can be confusing, so here is a summary:
 
4
 
 
5
 
 
6
Intra-document Linking
 
7
----------------------
 
8
 
 
9
<xref>
 
10
        use to get link text from the title of the target link; has no
 
11
        close tag
 
12
        http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
 
13
 
 
14
<link>
 
15
        use to supply text for the link, requires </link>
 
16
        http://www.oasis-open.org/docbook/documentation/reference/html/link.html
 
17
 
 
18
linkend=
 
19
        controls the target of the link/xref, required
 
20
 
 
21
endterm=
 
22
        for <xref>, allows the text of the link/xref to be taken from a
 
23
        different link target title
 
24
 
 
25
 
 
26
External Linking
 
27
----------------
 
28
 
 
29
<ulink>
 
30
        like <link>, but uses a URL (not a document target);  requires
 
31
        </ulink>; if no text is specified, the URL appears as the link text
 
32
        http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html
 
33
 
 
34
url=
 
35
        used by <ulink> to specify the URL, required
 
36
 
 
37
 
 
38
Guidelines
 
39
----------
 
40
 
 
41
o  If you want to supply text, use <link>, else <xref>
 
42
o  Do not use text with <ulink> so the URL appears in printed output
 
43
o  You can supply text at the target location with 'xreflabel'