Writer Helper Add-on (Experimental)
Oxygen XML Editor offers an add-on that provides support for helping technical writers. Once the add-on is installed, a Writer Helper view is available from the menu. Once opened, you can use one of its available tabs to access the functionality.
Quick Installation
You can drag the following Install button and drop it into the main editor in Oxygen to quickly initiate the installation process:
Manual Installation
To manually install the add-on, follow these instructions:
- Go to to open an add-on selection dialog box.
- Enter or paste
http://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show
add-ons from field.Note: If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
- Select the Writer Helper add-on and click Next.
- Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Finish.
- Restart Oxygen XML Editor.
Result: The Writer Helper view now be available and can be selected from the menu.
Review
You can select folders or files in the Project view and start a review session for them. By default, the review is done in random order and all reviewed documents are opened with change tracking enabled. During the review process, you can see a list of already reviewed documents and check the status of your progress.
This feature is useful for reviewing a set of documents.
Similar Content
You can select folders or files in the Project view, then choose a list of elements to check for similarity. Once you start the Find similar content processing, information from all XML, HTML, and Markdown files is gathered to determine elements that have similar text content. Once the similar matches are presented, you can click on each of them to show a detailed list of places where the matches are found.
If the Show similar content for the current file checkbox is enabled and the similar elements have been found, once you open a document, a results tab will show elements the current document has in common with all other documents that were analyzed.
This feature is useful for finding possible elements that can be reused instead of being copy-pasted between documents.
Read Aloud
Select content in the current document and use the Play button to listen to how it is read by an operating system-specific narrator.
This feature is useful to review content by listening to it.
Tips
You can view a list of editing tips, tuned for technical writers. Each tip might also have a Mode details link to open the Oxygen XML Editor user guide.
This feature is useful for discovering productivity tips to help make your editing experience more efficient and productive.