An attribute such as xlink:href=”” refers to an arbitrary URL. This is similar to the DocBook 4 ulink element, which was removed in DocBook 5. ULink — A link that addresses its target by means of a URL (Uniform Resource Because DocBook is harmonizing towards XML, this restriction cannot easily be. Keywords: external links, simple XLinks, xlink:href, ulink . if you want to insert a book title with an additional link, in DocBook 4 it has to be written like this.

Author: Tetaxe Duk
Country: Pacific Islands
Language: English (Spanish)
Genre: History
Published (Last): 4 September 2010
Pages: 64
PDF File Size: 7.58 Mb
ePub File Size: 9.5 Mb
ISBN: 276-9-62113-597-1
Downloads: 66868
Price: Free* [*Free Regsitration Required]
Uploader: Jura

Either direction is sufficient to establish the association. Regardless of the text content, you have to choose between the attributes xlink: However, if you put an xlink: Because these attributes are in their own namespace, they do not interfere with any native attributes declared for an element. The link element is completely empty: The disadvantage is that they will not be validated by the parser, but then they will also not generate validation errors dochook they are not stored in the same file.

Generally you should set ulink. Semantically equivalent to an xref internal link.

Note, validation is only performed when using linkendnot with xlink: Using linkend leads always to an internal link and is semantically equivalent to xref.

It could just as well have been placed in the book element’s info element, in an appendix element, or anywhere else in the document, and it would have the same association. These attributes are in their own namespace named http: That standard says that any XML element can become the source or target of a link if it has the universal XLink attributes on it.


The ulink tag: Linking to a Web page

ulikn Knowing the Properties of the xlink: Compare these two equivalent documents, one using the default namespace and the other using a prefix:.

In DocBook 4, a title element is permitted as a child of chapterbut also as a child of chapterinfo. For FO output, you can choose whether the url attribute value for the ulink is printed. Regardless of the parameter settings, if the URL exactly matches the ulink cocbook string or the ulink element is empty, which produces the same resultthen the stylesheet does not repeat the same URL in brackets or a footnote.

docbook message

The olink element itself is retained in DocBook 5. As such, avoid the following notation when the URL in xlink: DocBook 5 also adds new concepts. Otherwise, the element cannot be resolved during processing and and the link will be broken.

Links With Content Using xlink: An element’s annotations attribute accepts multiple space-separated values, so any element can be associated with more than one annotation.

For example, you can turn a command element into a link that targets the reference page for the command. So it can contain any number of paragraphs, lists, admonitions, etc.

It is quite easy to customize in order to extend or subset the DocBook schema. The following is an example of an annotation element associated with a chapter element:. Note that the root element is now d: Use this code to create an internal link cross reference.


Writing documentation with DocBook-XML 4.3

If your application requires annotations to work, then be sure your stylesheets check the integrity of the associations. The annotation element’s annotates attribute accepts multiple space-separated values, so any annotation can be associated with more than one annotated element.

Internal link with literal text.

URL link with literal text. Use the link [4] element. The XML parser can only validate a xsd: In print output, long URLs that start near the end of a line may need to be broken to format nicely. Fortunately, a guide and conversion stylesheet exist to help transition DocBook 4 documents to DocBook5.

If you want to express linking from a block element, you will have to customize the stylesheet to do so, perhaps by putting a clickable icon in the margin.

In fact, there is no implied association based on element position, proximity, or lineage, such as parent-child. Instead of ulinkuse a link element with a URL in its xlink: DocBook 5 introduces a general purpose annotation mechanism that allows you to associate information with any element. Note the absense of the character. DocBook 5 introduces two major changes to the handling of metadata:. The only difference of the previous example is the ID cha.

It adds the following two new elements and defines the semantics of associating an annotation with an element.

Subscribe US Now