Difference between revisions of "Documentation Primer/Manual/DocBook Reference/Linking"

Revision as of 10:06, 1 September 2012

Other languages:

English

Information
These pages are being transferred from UserBase. Please don't work on them until the transfer is complete, and the old UserBase pages have been removed.

The linking elements

<link linkend="">

The most common link. Use this to turn a word or phrase into a link to another part of the document. linkend is the only attribute we use.

<ulink url="">

A link that refers to a document using it's URI. Use this for websites and ftp sites, but not for email addresses, which have their own specific tag. Please do not use this to link to other documents on the local system.

<anchor id="">

Marks a place in the document, which you can use to link to. Note that the id attribute on any other element where it is valid, will automatically generate an HTML anchor in generated HTML, so you do not need to duplicate these. Use anchors only when you need to jump into the middle of a longer page, for example, to a particular menu item, or to a particular option in a preference dialog.

Note
`<anchor>` is an empty element, and must be closed with a /.

<xref linkend="">

A cross reference to another part of the document. Use this when you want to refer to the section without the name. This is one of very few unclosed elements allowed. linkend is the only attribute we currently use.

Note
`<xref>` is an empty element, and must be closed with a /.

<email>

Use this to enclose an email address. Don't add "mailto:" to the email address, and don't use <ulink url=""> for email addresses. No attributes required.

@@ Line 1: / Line 1: @@
+<languages />
+{{Transferring}}
 <translate>