00:00:05The purpose of this video is to show you how
easy it is to install the Oxygen Feedback
00:00:10commenting component in WebHelp output. I
will demonstrate this from the perspective
00:00:15of someone who generates WebHelp output using
a transformation scenario in Oxygen XML Editor,
00:00:21but who is new to Oxygen Feedback.
00:00:24The basic process will involve creating a site
configuration in the Feedback administration
00:00:29interface, copying a generated installation
fragment into the WebHelp transformation
00:00:35scenario in Oxygen XML Editor, and running
the transformation to produce the output.
00:00:44To access the administration interface, I need
to navigate to the feedback url in my browser.
00:00:51Note that if you're using the Enterprise
distribution, you'll have a unique URL.
00:00:56First, I need to create an account,
00:00:58so I'll go to the Sign Up tab, and
I need to choose an organization ID.
00:01:10Then after submitting the rest of my info, an
email will be sent to me and I'll need to confirm
00:01:15the email address, which I already did behind the
scenes ... So now I can log on for the first time.
00:01:23Note that Cloud users are automatically granted
a 30-day free trial. Also, since I created the
00:01:32organization account, I'm automatically
assigned as the organization 'Owner'.
00:01:36Only users with a role of organization 'Owner'
or 'Admin' can create site configurations.
00:01:43When I log on, I'm taken to the Dashboard
page within the administration interface.
00:01:48Notice that the stripe on the left contains
links to various organization-level
00:01:52admin pages ... and the center area contains a
Get Started pane that provides easy access to
00:01:59the most common actions for new users. I want
to create a site configuration to define some
00:02:04settings and to generate an installation fragment
so I'll click the 'Create first site' button.
00:02:10Creating a site configuration
consists of a 3-step wizard.
00:02:15The Settings page is the first part of the
wizard. Here, you must enter a Name for your
00:02:19site configuration and a description. Optionally,
you can add a logo and set other options.
00:02:26Next is the Version page.
First, you'll specify the
00:02:30version in the "Name" field.
This is helpful if you'll have
00:02:33multiple versions for your output.
For example, if your output is documentation
00:02:37for a product with multiple released versions,
each one probably has it's own unique version
00:02:42of the documentation, and each will need
it's own configuration since the version
00:02:46and base URL will be different for each.
Then, enter the base URL for the website where
00:02:52your output is published. For example, the
URL where the WebHelp output is deployed.
00:02:58Note that comments will only be displayed on pages
within the hierarchy of the specified base URL.
00:03:05The final wizard page is the Installation
page. Here you can choose between 3 options.
00:03:11You can choose to install Oxygen Feedback using a
transformation scenario in Oxygen XML Editor or Author,
00:03:18or with a commnd-line transformation script
using the Oxygen XML WebHelp plugin,
00:03:24or you can choose to install it
on any HTML-based web page.
00:03:29For this video, I'll select the
Oxygen XML Editor option.
00:03:34Notice that the installation steps are
listed here for each installation option.
00:03:39I will show you the steps in Oxygen XML
Editor, but from here I need to copy
00:03:45the generated installation fragment.
Then, in Oxygen, I'll open the Configure
00:03:52Transformation Scenarios dialog box and duplicate
the DITA Map WebHelp Responsive scenario.
00:04:03Notice there is a Feedback tab where I can
paste the copied installation fragment.
00:04:14Then I just need to run the transformation
and deploy the WebHelp output to a web server.
00:04:24If I go to the WebHelp output, you will
see that the Oxygen Feedback commenting
00:04:28component is now embedded in each topic.
00:04:32Note that an add-on is also available that
00:04:34contributes a side-view in Oxygen XML
Editor or Author where you can see
00:04:39all the comments that were added in the
output for a particular topic or map.
00:04:44The add-on can be installed from the Install
new add-ons dialog box that can be accessed
00:04:49from the Help menu or by right-clicking inside
the DITA Maps Manager and selecting the "Show
00:04:54Feedback Comments Manager" action. More
details are available in the User Guide.
00:05:00This concludes the video demonstration.
Thank you for watching.