VideosWorking with DITA Reusable Components View


This demonstration shows you how to use the DITA Reusable Components view that was introduced in version 19.0.


00:00:07In this demonstration, I will show you how to use the DITA Reusable Components view that
00:00:12was introduced in version 19.0 of the oXygen XML Editor.
00:00:17This view is hidden by default, so it can be opened by selecting it from the Window -> Show View menu.
00:00:27It has a tabular structure with columns that display the key names, their descriptions,
00:00:33the href where the keys point to, and the location of the ditamap files where the keys are defined.
00:00:41This view is helpful for DITA documentation projects that utilize a large number of keys.
00:00:47It collects all the keys that are defined in the root map and presents them in a dynamic
00:00:52table where you can easily locate and insert references to them as links or variables.
00:00:59A cool feature that helps you to see where the keys are defined is the ability to group
00:01:04them by definition location.
00:01:06To demonstrate this view, I am using the oXygen user's manual project,
00:01:12which contains hundreds of key definitions.
00:01:14I have a topic opened where I've identified some content that needs to be replaced with
00:01:19keys and I'm going to show you several different ways to insert them using this view.
00:01:25First off, I've noticed that the name of our product appears at the beginning of the first paragraph.
00:01:30I already have a key defined for it and I'm using the Search filter to look for this particular key.
00:01:36I do not know the exact name of the key, so I will search for the "oxygen xml editor" keyword...
00:01:43Notice that the DITA Reusable Components contextual menu includes a "Show Definition" action that
00:01:50allows you to see where the key is defined.
00:01:55Now I'm going to remove the product name from my topic and I'll replace it with a key reference
00:02:01using the DITA Reusable Components view.
00:02:04To do this, I'll just drag and drop the key into my document.
00:02:11I'll briefly switch to Full Tags with Attribute mode just to show you that oXygen inserted
00:02:16a "ph" element because our "product" key contains only a description.
00:02:21Next, I've noticed that I have the word "perspectives" wrapped in a 'term' element.
00:02:27I know that I have a glossary term for this word defined as a key and in the output I
00:02:33want that term to be a link to that key reference.
00:02:36So, I'm going to select the whole 'term' element and now I just need to find that specific
00:02:42key in the Reusable Components view.
00:02:45In our documentation project, all keys that were created for glossary terms have the same
00:02:50naming convention.
00:02:52They all begin with "glossentry", so this is the keyword I search for...
00:02:57As you can see ... all of our glossary terms are listed and sorted alphabetically.
00:03:03By the way, you can change the sorting of any of the columns in this view simply by
00:03:08clicking on the column header.
00:03:11Now I want to show the second method for inserting the key references, so I'll scroll down and
00:03:17locate my "perspective" glossary term...
00:03:20... then double-click the key.
00:03:23I'll briefly switch to Full Tags with Attributes mode just to show you that oXygen inserted
00:03:28an "xref" element.
00:03:30This happened because the "glossentry_perspective" key has an Href attribute defined.
00:03:37There is one more method for using this view to insert key references, which is using actions
00:03:42found in its contextual menu.
00:03:45I have another instance of the word "perspective" and I want to replace it with a "term" element
00:03:50that references the same "perspectives" glossary entry.
00:03:54I'll select that word and remove it.
00:03:57...this time I'm going to right-click that key in the Reusable Components view...
00:04:02...and notice that there are several options I can choose from...
00:04:06...for my purposes, I'll select "Insert as Keyref"...
00:04:10...notice that this option presents a submenu that lists all the elements that can be inserted
00:04:16at the current cursor position.
00:04:18I want it inserted in a "term" element so I'll scroll to "more" and select that element.
00:04:23Notice that this time oXygen inserted the word with the "term" element containing the
00:04:28keyref attribute.
00:04:29I'll switch again to Full Tags with Attributes mode just to show you the newly inserted "term" element.
00:04:39And this concludes our demonstration.
00:04:41Thanks for watching!