00:00:06The purpose of this video is to
introduce the block-level comments
00:00:10feature that was added in Oxygen Feedback 1.4.
00:00:14This feature provides the means for your users to
add and manage comments contextually at a specific
00:00:20location within the output page,
making the feedback more precise and
00:00:24it's easier to locate the exact content
referenced in a particular comment.
00:00:29Prior to version 1.4, all comments were created
and managed using the commenting component
00:00:34located at the bottom of the output page.
00:00:45Now, a widget is displayed on the right side
00:00:48 of the page for comments added
contextually at a block-element level
00:00:52and clicking the widget displays the comment
at that location within the page.
00:01:05From a commenter's perspective, you can add a new
comment contextually by hovering over a block
00:01:11element, then click the wigdet that
appears on the right side, and then you
00:01:16can add your text and manage the comments
from that location within the page.
00:01:27The block-level comments feature is also
helpful if you use the Feedback Comments
00:01:32Manager in Oxygen to address
comments in the source.
00:01:36If I open the topic associated with a
particular comment and that comment was
00:01:40added on a block element ... the topic is opened
with the element highlighted in Author mode,
00:01:46making it very easy to locate the source element
where I would address the user's comment.
00:01:59From a technical perspective,
00:02:01the block-level comments are available
for DITA elements that have an ID.
00:02:06Oxygen Feedback creates a mapping
between the element in the output
00:02:10and the element in the source document.
Therefore, it is important to maintain the IDs
00:02:16in the source documents to ensure
that this mapping persists.
00:02:23Fortunately, Oxygen includes some options for
automatically generating IDs for certain elements.
00:02:30I'll switch to Full Tags Mode with Attributes
so that you can see the results.
00:02:35If I right-click a map in the DITA Maps
Manager, and go to Refactoring and Generate IDs,
00:02:43it opens a wizard where I can decide
which elements to generate IDs for,
00:02:47then the scope, then after previewing
the changes, I'll click Finish ...
00:02:53and you can see that it automatically
added IDs for the specified elements.
00:03:03To ensure those particular elements
always have IDs while editing going forward,
00:03:09I can select ID Options from the DITA menu.
00:03:13This opens a dialog box that includes the
option "Auto Generate IDs for Elements".
00:03:20Enabling this option means that anytime any of the
specified elements are added in a document...
00:03:26an ID attribute is automatically generated.
00:03:33If you want to use block level comments but you do not want to alter your DITA source files, a transformation parameter can be set to yes,
00:03:41in which case, the block levels comments
will not be mapped to the source element,
00:03:45but they will appear in the WebHelp output.
This concludes our introduction to the block-level
00:03:50comments feature in Oxygen Feedback.
Hopefully you and your community members will find this feature helpful.
00:03:56
Thank you for watching.