link

The <link> element defines a relationship to another topic. Links represent the types and roles of topics in a web of information, and therefore represent navigational links within that web. Links are typically sorted on output based on their attributes. The optional container elements for link (<linkgroup> and <linklist>) allow authors to define groups with common attributes, or to preserve the authored sequence of links on output.

Contains

( (linktext) (optional) then (desc) (optional) )

Contained by

related-links, linklist, linkpool

Inheritance

topic/link

Attributes

Name	Description	Data Type	Default Value	Required?
href	A hyperlink to an external Web page (URL) or other non-DITA resource, or to another DITA topic in the same file or in another file. The format attribute identifies the format of the target. Non-DITA targets use standard URL syntax. DITA topics are targetted as follows: Target elsewhere in the same file: href="#topicid" First topic in different file: href="filename.dita" Specific topic in different file: href="filename.dita#topicid" If the URL contains an ampersand character, the ampersand symbol (&) should be used to indicate that character	CDATA	#IMPLIED	No
keyref	Currently not implemented in DITA processors. Provides a key that a process can use to look up associated information.	NMTOKEN	#IMPLIED	No
%rel-atts; (type, role, otherrole)	A set of related attributes, described at %rel-atts;	parameter entity	PE not applicable	Not applicable
%select-atts; (platform, product, audience, otherprops, importance, rev, status)	A set of related attributes, described at %select-atts;	parameter entity	PE not applicable	Not applicable
format	The format attribute identifies the format of the resource being cross referenced. The default format is "dita". Possible values include: dita The destination uses DITA topic markup, or markup specialized from a DITA topic. Unless otherwise specified, the corresponding default type will be treated as "topic." html The format of the linked-to resource is HTML or XHTML. pdf The format of the linked-to resource is PDF (opens a new window). ditamap The linked-to resource is a DITA map. It represents a referenced hierarchy at a position within referencing hierarchy, and a referenced relationship table included outside the referencing hierarchy (no value) Defaults to "dita" For other formats, you can use the file extension without the "." (for example, in a link to file "readme.txt", use "txt" as the value)	CDATA	#IMPLIED	No
scope	The scope attribute identifies the closeness of the relationship between the current document and the target resource. Set scope to `local` when the resource is part of the current set of content, and should be accessed and copied to the output directory. Set scope to `peer` when the resource is part of the current set of content but is not accessible at build time. Set scope to `external` when the resource is not part of the current information set and should open in a new browser window. The default is `local`.	(local \| peer \| external)	#IMPLIED	No
query	Lists query criteria, or uses metadata as query criteria. The query pulls in matching topics under the current element if the current element has a title or href; otherwise references to the matching topics replace the element at the current location.	CDATA	#IMPLIED	No
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes

Example

<related-links>
<linkgroup type="concept">
<link href="czover.htm#sqljsupp"/>
<link href="czesqlj.htm#sqljemb/>
</linkgroup>
<related-links>