24.08.2015 Views

Oxygen XML Author plugin 13.2.0

Oxygen XML Author plugin 13.2.0

Oxygen XML Author plugin 13.2.0

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

TemplatesDefault templates are available in the New File wizard and can be used for easily creating a skeletal form of a DocBook5 book or article. These templates are stored in the ${frameworks}/docbook/templates/DocBook 5 folder.Here are some of the DocBook 5 templates available when creating new documents from templates.• Article• Article with MathML• Article with SVG• Article with XInclude• Book• Book with XIncludeInserting olink Links in Docbook DocumentsAn olink is a type of link between two Docbook <strong>XML</strong> documents.The olink element is the equivalent for linking outside the current Docbook document. It has the attribute targetdocfor the document ID that contains the target element and the attribute targetptr for the ID (the value of an id orxml:id attribute) of the target element. The combination of those two attributes provides a unique identifier to locatecross references.For example, the Administrator Guide is a book with the document ID MailAdminGuide and it contains a chapterabout user accounts like the following:Administering User Accountsblah blah...You can form a cross reference to that chapter by adding an olink in the User Guide like the following:You may need to update youruser accountswhen you get a new machine.1. Decide what documents are included in the domain for cross referencing.An ID should be assigned to each document that will be referenced with an olink. Usually it is added as an id orxml:id attribute to the root element of the document. A document ID is a string that is unique for each documentin your collection. For example the documentation may include a user's guide, an administrator's guide, and a referencedocument. These could have simple IDs like ug, ag, and ref or more specific IDs like MailUserGuide,MailAdminGuide, and MailReference.2. Decide the output hierarchy.For creating links between documents, the relative locations of the output documents must be known. Generally theHTML files for multiple documents are output to different directories if chunking is used. Before going further youmust decide the names and locations of the HTML output directories for all the documents from the domain. Eachdirectory will be represented by an element in the target database document.In the example from the next step the hierarchy is documentation/guides/mailuser,documentation/guides/mailadmin, documentation/guides/reference.3. Create the target database document.Predefined Document Types | 141Each collection of documents has a master target database document that is used to resolve all olinks from thatcollection. The target database document is an <strong>XML</strong> file that is created once. It provides a framework that pulls in

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!