Tags
Language
Tags
May 2024
Su Mo Tu We Th Fr Sa
28 29 30 1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31 1

Technical Writing: Linking in DITA XML

Posted By: ELK1nG
Technical Writing: Linking in DITA XML

Technical Writing: Linking in DITA XML
Created by JPDocu School of Technical Writing | Published 7/2021
Duration: 1h 18m | 4 sections | 30 lectures | Video: 1280x720, 44 KHz | 931 MB
Genre: eLearning | Language: English

How to Manually and Automatically Create Links in DITA XML using Oxygen XML Author


What you'll learn
How to use Oxygen XML Author to create links
How to manually create links in DITA XML - to the web, to another topic, or to a section in the same topic
How to activate automatic links generation in DITA XML - using the collection-type attribute

Requirements
Knowledge in DITA XMLKnowledge in technical writing
Description
Do you wonder how to create links in software documentation written using DITA XML? Do you spend a lot of time trying to find your way through linking in DITA XML?
If yes, I can help!
DITA XML comes with great functionality that can help the technical writer and information developer to organize the documentation in an optimal way.
Any proficient technical writer will tell you that you must create and insert links to external content, such as websites, but also to reference other topics from your DITA map to have a documentation deliverable that provides excellent navigation capabilities for your readers.
But does it mean you need to waste your time to manually craft and then maintain these links? As a technical writer focused on delivering the best possible information to your readers, your time is precious! Maintaining links instead of providing valuable instructions and content for your readers is not what you should do! 
How can DITA help you with that?!
You will be surprised to find out how many technical writers do not even know that DITA XML supports automatically generated links. All you need to do is to activate the desired linking option and your links will appear automatically in the generated output!
And it gets even better, the links will appear only when there is a valid linking target!
What are the benefits for you then? Obviously:
Less time you waste on inserting links.
Fewer chances to have a broken link in the documentation - leading to higher content quality!
Better consistency of the links - you choose a linking strategy and the links appear in a consistent style across your entire documentation deliverable.
More time for you to focus on what matters most - high-quality information delivered to end-users!