Add-ons
Oxygen version
This add-on contributes actions in the Tools menu and contextual menu to
enable batch conversion between various formats:
Word to XHTML/DITA/DocBook
HTML to XHTML/DITA/DocBook
Markdown to XHTML/DITA/DocBook
Excel to DITA
OpenAPI to DITA
Confluence to DITA
DocBook to DITA
XML to JSON/YAML
JSON to XML
YAML to JSON/XML
JSON to YAML
XSD to JSON Schema
For more details see https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html
What's new in version 6.0.0
You can now convert XSD to JSON Schema (version 2020-12).
Improvements were implemented related to lists with custom styles processing for Word to HTML/DITA conversions.
Updated the Apache POI library (used for conversions from Word and Excel) to version 5.2.5.
What's new in version 5.3.0
The Markdown to DITA conversion was updated to be compatible with all enhancements made in version 5.5.0 of the org.lwdita DITA OT plugin.
Increased the minimum required version of Oxygen to 26.0.
What's new in version 5.2.0
OpenAPI to DITA
Fixed an issue where the OpenAPI to DITA conversion failed when the document contained the "*/*" MIME type.
Fixed invalid IDs on topics resulting from OpenAPI tags that contained multiple words separated by spaces.
Fixed a case where the description from responses was lost during the conversion of OpenAPI v2.
Word to HTML/DITA
Added 'frame', 'rowsep', and 'colsep' attributes to tables from the resulting DITA documents.
Fixed a case where the resulting tables had duplicate IDs.
Added a default configuration for codeblocks in the Word Styles Mapping table.
Fixed a case where the custom styles based on a normal style that didn't have a Word style mapping were not properly reported as unknown.
Confluence to DITA
Fixed an XSLT error that occurred when converting Confluence documents with duplicate IDs.
Removed queries from image paths. This prevents publishing errors caused by the presence of a query component in the URI.
Others
Updated the JTidy library to version 1.0.4.
Increased the minimum required version of Oxygen to 25.1.
Removed the Jackson libraries because these are already available in Oxygen.
What's new in version 5.1.0
Added two new conversions: YAML to XML and XML to YAML.
Word to HTML/DITA
The processing of table captions was improved. The table is now obtained
with a caption child in HTML or with a title in DITA.
The width of table columns is now preserved.
The processing of figure captions was improved. For XHTML, a
<figure> element is obtained with a
<figcaption> child element. For DITA, a
<fig> element is obtained with a <title>
child element.
The saving of images was improved and the name from the Word internal
structure is preserved.
Fixed an issue where the content was incorrectly merged between two
different unordered lists.
Others
Removed the SnakeYAML library because this is already available in Oxygen.
Increased the minimum required version of Oxygen to 23.1.
Removed some Flexmark Java Extension libraries that are not used when converting Markdown.
What's new in version 5.0.1
Fixed an issue with Word to HTML/DITA conversions where content was incorrectly merged between two different lists.
What's new in version 5.0.0
OpenAPI to DITA
You can now convert JSON or YAML files that use and conform to the OpenAPI specification (versions 2.0, 3.0, or 3.1) to DITA documents and there is a 'Create DITA maps from OpenAPI documents' option that can be selected to instruct the converter to split the documents into separate topics that are referenced in a DITA map.
Word to HTML/DITA
Improved the Word styles mapping configuration by inheriting the style configuration of the custom style from the base style.
SVG images embedded in Word documents are preserved as SVG.
IDs that result from image and table bookmarks are now handled better to find the correct location.
Improved the IDs generation on topics and sections by using the text from headings.
Improved the handling of tables by preserving header row information during the conversion.
Fixed a case where a list that contains content between list items was broken into multiple lists.
Fixed a case where multiple ordered lists were merged into one.
Fixed a case where the conversion failed when the document contains duplicate mappings between numberings and styles.
Fixed a case where WMF images were not handled by the converter.
Fixed a case where the DITA result contained an invalid MathML equation.
Fixed a case where the DITA result contained images wrapped in the 'b' element.
Fixed a case where the value edited in the Word Styles Mapping table from the preferences page was not saved.
Updated the Java-Mammoth library used for Word to HTML/DITA conversions to version 1.5.0.
HTML to DITA
Improved the conversion of object elements from HTML by adding a proper 'outputclass' attribute in the DITA result.
Added an option in the conversion dialog box that allows you to decide whether or not the 'div' elements will be ignored.
Fixed a case where 'id' and 'class' attributes were lost when breaking paragraphs by processing the 'br' elements.
Markdown to DITA
Added support for the Markdown abbreviations.
Improved the handling of the local references.
Improved the conversion to allow processing of headings specified as HTML in the Markdown documents.
Improved the handling of the HTML anchor elements in the Markdown documents.
Others
The formatting of 'pre' elements are prevented when converting HTML to XHTML.
Fixed the layout of the preferences page because it was not entirely visible on low resolution screens.
What's new in version 4.0.0
Added a Confluence to DITA conversion.
Added a DocBook to DITA conversion.
Improved the name of the extracted DITA topic files when converting to a DITA map with topics.
Improved the title extraction of the DITA map when converting to a DITA map with topics.
The 'alt' attributes from images are now handled properly when converting HTML to DITA.
What's new in version 3.2.1
Critical/Security: The add-on no longer distributes Apache Log4j
libraries to avoid the Log4Shell exploit. For more info see: CVE-2021-44228.
Audio, video, picture, object, and iframe elements are handled when
converting HTML to DITA.
Fixed a case where the table of contents was not ignored when converting
Word to DITA.
What's new in version 3.2.0
Added a preferences page that contains:
An option for customizing the conversions from Word (Word to
HTML/DITA/DocBook) by mapping Word styles to HTML elements.
Added an option for choosing the maximum heading level for
creating nested topics or separate DITA topic files when
converting Word/HTML to DITA.
Warnings are now presented if unrecognized Word styles are found when
converting Word documents.
Improved the hierarchy level obtained in conversions from Word/HTML to
DITA maps.
All 'class' attributes are converted from the intermediary HTML
into DITA 'outputclass' attributes when processing Word to
DITA.
Added an 'outputclass' attribute with an "endnote" value
on the 'fn' DITA elements that resulted from Word endnotes.
The file name is used as the title when the document doesn't contain
headings in Word/HTML to DITA conversions.
The table of contents is ignored when converting Word to HTML/DITA.
Copied relative resources into the output folder in HTML to DITA
conversions.
Superscript and subscript are allowed when converting Markdown to
DITA.
Fixed some cases where internal references were not converted properly
in Word to HTML/DITA conversions.
Fixed a case where equations were not converted in Word to HTML/DITA
conversions.
Fixed an issue where a space between underline elements and other inline
elements was ignored.
Fixed an error in HTML to XHTML conversions when processing elements
with whitespace content.
What's new in version 3.1.0
Cross-references are now handled properly when converting Word to
HTML/DITA.
Index entries, footnotes and endnotes are now handled properly when
converting Word to DITA.
References to local HTML documents are now automatically updated when
converting HTML to DITA.
Fixed an issue with HTML to DITA/DocBook conversions where extra new
lines were added when converting "pre" elements.
Fixed an issue with Excel to DITA conversions that sometimes resulted in
table elements with invalid IDs (#51).
Fixed an issue with Word/HTML to DITA/DocBook conversions that caused
spaces between inline elements to be removed.
Updated the Java Mammoth library to version 1.4.2.
Updated the jTidy library to version 1.0.2.
What's new in version 3.0.0
Added two new conversions: YAML to JSON and JSON to
YAML.
Added import actions to the Append child, Insert Before,
and Insert After sub-menus from the DITA Maps Manager's
contextual menu. They convert documents and automatically insert them in
the DITA map.
Added the converter actions to the File->Import/Convert->Additional
conversions sub-menu.
Re-organized the converter actions for easier access.
What's new in version 2.1.0
Added a new option for converting Markdown documents with multiple
headings into DITA maps with referenced DITA topics (Markdown to
DITA).
Added a new option for creating DITA short description elements
in the Markdown to DITA conversion.
Improved the Markdown to DITA conversion to allow conversions of
documents that start with a high heading level or increase the heading
level with more than one unit.
Added a new option for converting HTML documents with multiple headings
into DITA maps with referenced DITA topics(HTML to DITA).
Fixed various small bugs in the HTML to DITA and Word to DITA
conversions.
Read MorePlugin
This add-on installs the "Feedback Comments Manager" view that can be used to see feedback posted in WebHelp Responsive output directly in Oxygen XML Editor/Author. You can react to this feedback by making corrections and updating the source content without leaving the application.
Read MorePlugin
This addon uses the Oxygen AI Positron service to help technical documentation writers generate content.
Read MorePlugin
This add-on installs a Git Client in Oxygen. It contributes multiple
side-views, each one specialized for various Git operations. The main one is called the
Git Staging view. Using the Git Client add-on, various Git operations can be
performed, such as committing changes into the local repository, pushing/pulling changes
to/from the remote repository, creating, checking out and deleting branches, showing the
history of the repository resources, and more. The add-on also includes a built-in tool
for comparing and merging changes.
What's new in version 5.3.0
Oxygen project detection has been improved when opening a new repository in the Staging view.
Submodules in parent repositories are now checked out at the index defined in the parent repository when checking out a branch. This ensures that the submodules reflect the actual state of the parent repository at that time.
What's new in version 5.2.0
Large File Support (LFS) is now supported. This means that if you have installed LFS and defined the tracked large files in your repository, they will be automatically detected and handled properly.
Improved various messages in the user interface.
Improved repository cloning process to automatically detect and load *.xpr files.
The absolute path to the working copy is now displayed in the tooltip of the Git Staging view's working copy combo.
Enhanced remote change detection and refresh in History view for improved performance.
An issue has been fixed where untracked files were not being restored from a stash.
The integrated JGit library was upgraded to version 6.5.
Other bug fixes.
What's new in version 5.1.1
Corrected a message that created confusion in the Merge branches dialog box.
Fixed an issue where Oxygen failed to start when there was no project open in the Project view.
Implemented other bug fixes.
What's new in version 5.1.0
A new options page was added for SHH Connections to control SSH agent usage.
Fixed an issue in which SSH agent was not used by default.
The commit dot in the Git History graph associated with the head of the current branch is now painted differently to make it easier to see.
The Oxygen project change detection mechanism was improved. It is now faster and the Git Staging view no longer needs to be displayed.
The presentation of the labels associated with a commit in the Git History view has been improved to avoid truncation of names when it is not necessary.
The "List stashes" dialog box now allows you to resize the tables for "Stashes" and "Affected files" without resizing the entire dialog box.
The "Open" action from the contextual menu in the Git Staging view now uses the URL of the current local working copy as much as possible.
A problem was solved where after the discard action on an untracked/added file was still presented in the Git Staging view even though it was deleted on disk.
Implemented various bug fixes and performance improvements.
What's new in version 5.0.0
A new Validate each file before committing option was added in the Git Client preferences page. Selecting this option enables automatic validation of each file before each commit.
A new Validate all files from the project's "Main Files" folder before pushing option was added in the Git Client preferences page. Selecting this option enables automatic validation of the files located in the Main Files folder before the push operation processes.
The integrated JGit library was upgraded to version 6.3, which brings support for ssh-agent forwarding.
An option has been added that automatically detects Oxygen projects from opened working copies to quickly open them in the Project View.
Added a Squash merge "SELECTED_BRANCH" into "CURRENT_BRANCH" action in the contextual menu for local branches in the Git Branch Manager. This will add all changes from the "SELECTED_BRANCH" to the "CURRENT_BRANCH" in a single new commit.
By default, the History view presents commits from all branches (both remote and local).
Tags can be deleted even if they have already been pushed to the remote repository.
If the local branch has not been published yet, the push button will be decorated with a + symbol and will have a tooltip to explain the context.
A more helpful message is displayed when pulling and the local branch doesn't track a remote.
In tree view mode, if there are no changes, the empty folder with the name of the repository will no longer be displayed.
The Git Staging view now has a busy cursor when an operation is in progress.
Fixed an issue when authentication tokens were lost from options.
Some dialogues have been improved to make them easier to understand.
Bug fixes and performance improvements.
What's new in version 4.0.2
Fixed an issue that made the Pull(rebase) action from the Git Staging view be disabled at all times.
What's new in version 4.0.1
Fixed a small problem where the UI would sometimes freeze when returning to Oxygen after going to another application.
Fixed an exception that appeared under certain conditions and made the Git support unusable.
What's new in version 4.0.0
The History view now includes a new revision graph that helps you to understand how commits connect with one another.
You now have the ability to manage remote repositories (add, edit or delete), track a remote branch for the current branch, or to edit the repository's configuration file.
A new Git menu that contains various Git actions was added in the main menu bar.
In the History view you can choose which branches will have the history shown. You have the following options: Current branch, Current local branch, All branches, All local branches.
A new Checkout action was added in the History view contextual menu to checkout a branch
at a specific commit (either in detached head form or by creating a new branch at that commit).
A combo box was added in the Git staging view to switch between local branches.
The Git Staging view toolbar was simplified to only include the most important actions (while all actions are available in a new three vertical dots menu).
Performance was improved by optimizing the process of checking the status of the repository.
The Stash dialog box now has a column that shows the creation time for each stash.
Fixed an issue where the index got reset after pulling changes from the remote.
What's new in version 3.0.0
You can save the uncommitted changes into stashes, reapply or delete the stashed
changes.
You can create new tags from the Git History contextual menu. In the Git
Staging toolbar, there is an action to list all the tags. Tags from the local
repository can be deleted or pushed to the remote repository.
Added a Merge "SELECTED_BRANCH" into "CURRENT_BRANCH" action in the
contextual menu for local branches in Git Branch Manager .
When showing the history for a directory in the affected files section, the files
that are descendants of the directory are presented on top and the files that are
outside it are grayed out.
Added a Revert commit action in the contextual menu for commits from the
Git History view. It creates a new commit that reverts all the changes from
the selected commit.
Added a Reset file to this commit action to the contextual menu for
resources associated to a revision in the Git History view. It checks out the
selected version of the file.
Added an Open working copy version action to the contextual menu for
resources associated to a revision in the Git History view.
A warning message is now displayed when trying to use the Mark as resolved
action on a file that contains conflict markers.
A message prompt is now displayed if you try to switch the branch while there are
uncommitted changes so that you can confirm that you want to stash the changes or move
the changes to the new branch.
A new editor variables is now supported: ${git(working_copy_url)} . It is
resolved to the URL of the current working copy directory.
When hovering the cursor over the Pull and Push buttons, the
displayed tooltip now shows information about some of the incoming/outgoing commits
(such as the date, author and message).
When hovering the cursor over a branch name, a tooltip is displayed that provides
information about the last commit performed on that branch (such as the author and the
date of the commit).
An information message that is shown when starting Oxygen while being on a detached
HEAD now presents more information about the checked out commit (ID, author, date,
message).
The add-on's minimum compatible Oxygen version was increased to version 22.1.
The highlight boxes that surround branches and tags are now styled differently so
that it is easier to identify which represents a branch and which represents is a tag.
The settings in the Git client preferences page can be saved at project level. The
project can then be shared with other users and everyone will have the same Git client
settings.
Fixed an issue in where the commit details were not correctly displayed when a
filter text was active in the History view.
What's new in version 2.5.2
The JGit component included in the Git Client was updated to version 5.12.0. This
fixes the ssh without passphrase authentication which was broken in the previous 2.5.1
release.
What's new in version 2.5.1
Fixed a configuration problem caused by the selection of a branch to checkout when
cloning a repository. Because of this, remote changes could not be detected.
The JGit component included in the Git Client was updated to version 5.11.0.
What's new in version 2.5.0
Added a new field in the login dialog box for authentication using a personal
access token. Note that from August 13, 2021, GitHub will no longer accept
password-based authentication (
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations
).
After a repository that contains submodules is cloned, all submodules are also
automatically initialized and cloned.
When pulling the remote changes for a repository that contains submodules, the
submodules are updated as well (by default). This behavior depends on the Update
all submodules after pulling changes from the remote repository option from the
Git Client preferences page in Oxygen.
If a submodule appears as changed in the Unstaged files area, you can open
it using the Open action from the contextual menu.
The tooltip shown for a modified submodule from the Ustanged files area now
presents information about the currently and previously tracked commits.
Branches created from other local branches are now automatically checked out. This
behavior can be disabled by deselecting the Checkout branch option in the
Create branch dialog box.
The Git Staging side-view has been slightly redesigned and now has a cleaner
look.
Added support for Dutch localization.
Fixed an issue where debugging the Git Client using Apache Log4j did not work.
Fixed an issue where opening submodules that required authentication was not
possible.
Fixed various other bugs and added several small UX improvements.
What's new in version 2.4.0
Added an "Abort merge" button for when conflicts result after a Pull (merge)
operation. It allows you to abort the current conflict resolution process.
Added a set of options in the Git Client preferences page that can be used to decide
whether to always switch to a newly detected working copy from a project, to never
switch, or to always ask.
Added a "Preferences" action in the Settings menu that acts as a shortcut to the Git
Client preferences page.
Fixed an issue where pushing to a remote branch did not work when local and upstream
branch had diffenrent names.
Integrated numerous other bug fixes, UI improvements, and speed improvements.
The JGit component included in the Git Client was updated to version 5.10.0.
What's new in version 2.3.1
Fixed some performance problems introduced by version 2.3.0.
Fixed an issue where branches removed from the remote repository were still
presented in the Git Branch Manager view even after refreshing it.
What's new in version 2.3.0
The Git Client now contributes a new side-view, called the Git Branch Manager
, which presents all the local and remote branches as a tree. Actions were added
to the tree's contextual menu to make it very easy to check out branches, and to
create or delete branches.
You can now easily switch between local branches using a drop-down menu in the
top-right corner of the Git Staging view or by using the Git Branch Manager.
A new action ( Reset "[branch_name]" to this commit ) was added in the
history table that can be used to undo changes by moving the HEAD of the current
branch to the selected commit.
Some editor variables are now supported, including:
${git(working_copy_name)}
${git(working_copy_path)}
${git(short_branch_name)}
${git(full_branch_name)}
The Git History view now has better automatic refresh support.
A confirmation dialog box has been added for instances when you try to commit
without a message.
The add-on now contributes a preferences page (Options / Preferences / Plugins / Git
Client) that contains a "Notify me about new commits in the remote repository" option.
When this option is selected, Oxygen will show notification messages when it detects
that new commits have been pushed to the remote repository.
Support for French localization was added.
The JGit component included in the Git Client was updated to version 5.9.0.
Various other minor improvements and bug fixes were implemented.
For more information about the add-on's features, see the
README document .
What's new in version 2.2.0
Added the possibility to amend the last commit.
Added the possibility to automatically push changes to the remote repository when
committing.
Added the possibility to create a new branch starting from the selected commit in
the History table, by using the "Create branch" contextual action.
Added the possibility to compare two revisions of the same file from the Git History
view, by using the "Compare with each other" action in the contextual menu of the
history table.
Added the possibility to reset the stored credentials, by using the "Reset
credentials" action in the Settings menu from the main toolbar.
If you have a local branch that is not tracking a remote branch, the push button
tooltip suggests that you push to create a remote branch with the same name as the
local one.
Incoming and outgoing commits are marked in the history table with corresponding
arrow characters.
Improved local repository detection when selecting a project.
Updated JGit to version 5.7.0 (which, among other things, fixes client-side hooks
execution).
Fixed a bug where failing commits did not show any messages to the user.
Fixed other small bugs.
For more information about the add-on's features, see the
README document .
What's new in version 2.1.1
Fixed a bug where the Text/Author page contextual menu was not shown when the opened
document was remote (e.g. from a WebDAV server).
What's new in version 2.1.0
Updated the JGit library to version 5.6.
Added a "Clear history" action in the working copies combo box.
Added the "Show history" and "Show blame" actions to the contextual menus of the
resources from the Project view and of the Text and Author editor pages.
Implemented renaming detection in the Git History view. Renamed resources are
presented using a suggestive icon (containing the "R" letter). All the actions from
the Git History view take into account the entire history of a resource, including
renames and path changes.
Numerous bug fixes and small improvements.
What's new in version 2.0.0
Added a new Git History side-view, available from the toolbar for the entire
repository, or from the contextual menu for each unstaged resource.
Added a Show blame action in the contextual menu of unstaged resources. This
action works in conjunction with the Git History side-view, where the revision
highlighted in the main editor is selected for presenting more details.
Added a Pull (rebase) action in the toolbar.
Added more 2X icons for high resolution screens.
Fixed UI freeze issues when working with large repositories.
Fixed some UI glitches such as unintended borders, lack of padding, crowded
components, etc.
Improved speed when performing various operations, such as committing or changing
the repository.
Other small bug fixes.
What's new in version 1.5.2
Updated to JGit version 5.4.2 which comes with various bug fixes:
https://projects.eclipse.org/projects/technology.jgit/releases/5.4.2/review
Fixed issue: Oxygen freezes on start-up.
Fixed issue: Opening a Git repository fails with a java.lang.NullPointerException.
What's new in version 1.5.1
Updated to JGit 5.4.0.
Fixed issue: switching between flat mode and tree mode didn't always work.
Fixed issue: authentication through SSH using a passphase was broken in the previous
build.
Other bug fixes
What's new in version 1.5.0
Updated to JGit 5.3.1.
The add-on now works with more kinds of SSH keys, by using JGit's new SSH session
factory based on 'Apache MINA sshd' by default. See
https://wiki.eclipse.org/JGit/New_and_Noteworthy/5.2 for a full list of
benefits.
The tooltips of the push/pull buttons and the branch label now also present the
remote repository.
Bug fixes
Speed improvements
What's new in version 1.4.0
Update to JGit 5.2.1.
Performance improvements when checking the status of the repository.
Fixed bug that led to file loss when changing the letter case in a file name.
Better error message when the working copy is locked.
When closing, Oxygen will wait for Git commands to complete to avoid possible side
effects such as leaving the worky copy locked.
What's new in version 1.3.2
Initalize and update submodules if needed when the user opens a submodule.
What's new in version 1.3.1
Present an error message when Pull fails because local changes would be overwritten
by merge.
What's new in version 1.2.11
Various performance optimizations, bug fixes and the ability to check out a specific
branch when cloning a repository.
What's new in version 1.2.10
Speed improvement when invoking the contextual menu the Project view.
What's new in version 1.2.9
Fixed various issues encountered while working with resources in the tree view.
What's new in version 1.2.6
Bug fix: The contextual menu didn't show when running Oxygen on Mac OS X (broken in
version 1.2.5)
Improved the calculation of pull behind and push ahead counters
What's new in version 1.2.5
Bug fixes
Performance improvements
Using the plugin
Note: After installing the plugin, if the Git Staging view is not visible,
you can open it from the Window / Show View menu.
For information about how to use the Git Client, please see the README document on
GitHub:
https://github.com/oxygenxml/oxygen-git-plugin/blob/master/README.md .
Read MorePlugin
Contribute jcgm library to Oxygen which make it possible to render CGM images in Author mode. This product includes software developed in part by support from the Defense Advanced Research Project Agency (DARPA). ...
Read MorePlugin
This add-on contributes contextual menu actions that help you
build a translation package for DITA files that can be sent to
translators. You can also extract the changed files back into your
project once you receive the package back from the translators.
It contributes a sub-menu
named "Translation Package Builder" in the
DITA Maps Manager
's contextual menu. The
actions present in this group are:
Generate Milestone
- this action is the first one to use. It will generate an unique
hash
for each documentation resource. This information will be used by
the second action to detect which files
have been modified. A milestone file should be generated the first
time you install this plugin and, afterwards,
after each package sent to translators.
Create Modified Files Package
- this action detects which files have been
changed since the last generated milestone. These files are packed
insdie a ZIP
file that can be send to translators. After doing this you can also
generate a
new milestone so that the next package will contain just the new
changes.
This
action also creates a report with the modified resources
(
modified_resources_report.xhtml
). If your translation agency is
DITA-aware you can opt to send him the entire DITA project together with
this report.
Apply Package
- when the translated files arrive from the translator you should
open the DITA map
that corresponds to the received language (open
dita-map-french.ditamap if the package contains the french
translation).
Invoking this action will extract the changed files inside map's
directory.
Read MorePlugin
Side view in Oxygen XML Editor which shows all outgoing
references (image references, links, content references) for the
current opened DITA topic.
For more details see
https://github.com/oxygenxml/oxygen-dita-outgoing-references-view
What's new in version 2.0.1
Incoming references are now grouped into three categories:
Map, Cross, and Content.
You can copy the location of the reference target by using
Ctrl/Cmd+C on the reference.
Fixed an issue where an infinite incoming reference loop was
created when a peer map reference was used.
What's new in version 2.0.0
Added a new tab where incoming references are presented for
the current DITA topic (Oxygen 23 or newer).
Added support for translating the view's user interface in
English, German, French, Japanese, or Dutch.
Fixed various small bugs.
Read MorePlugin
This add-on contributes a JSON Schema Validator that can be used for validating JSON documents against Draft 2020-12 JSON schemas. The validation engine is based on json-sKema library (https://github.com/erosb/json-sKema). To use the validator, you need to create a validation scenario by selecting the Configure Validation Scenario(s) from the Validation toolbar drop-down menu, or from the Document > Validate menu (or the Validate submenu when invoking the contextual menu on ...
Read MorePlugin
This plugin installs an external Saxon 11.6 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 11.6.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possibilities to use Saxon 11.6 for validating XSLT:
To set Saxon 11.6 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 11.6 (External) as the validation engine..
If you prefer to use Saxon 11.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 11.6 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 11.6 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 11.6 allows one to export the compiled form of a stylesheet as a JSON or as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possibilities to use Saxon 11.6 for validating XQuery:
To set Saxon 11.6 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 11.6 (External) as the validation engine..
If you prefer to use Saxon 11.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 11.6 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 11.6 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon-sql-11.jar that is located in [PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
MS Writing Style Guide Vale Rules based on the "Microsoft Writing Style Guide" for the "Terminology Checker" add-on
IMPORTANT! The "Terminology Checker" add-on must also be installed in order for this add-on to work.
This add-on contributes Microsoft Writing Style Guide Vale rules for the Terminology Checker add-on.
This add-on contains a Vale-compatible (https://github.com/errata-ai/vale) implementation of the
Microsoft Writing Style Guide (https://learn.microsoft.com/en-us/style-guide/welcome/)
as provided by the errata-ai's open source project https://github.com/errata-ai/Microsoft.
Please note that this project is neither maintained nor endorsed by Microsoft.
Microsoft is a trademark of the Microsoft group of companies.
Software from the following projects is included:
errata-ai/Microsoft
Site: https://github.com/errata-ai/Microsoft
License: MIT License (https://github.com/errata-ai/Microsoft/blob/master/LICENSE)
Microsoft Writing Style Guide
Site: https://docs.microsoft.com/en-us/style-guide/welcome
License: Creative Commons Attribution 4.0 International (https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/LICENSE)
Read MorePlugin
This plugin installs an external Saxon 9.9 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 9.9.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 9.9 for validating XSLT:
To set Saxon 9.9 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 9.9.1.8 (External) as the validation engine..
If you prefer to use Saxon 9.9 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 9.9.1.8 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 9.9.1.8 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 9.9 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 9.9 for validating XQuery:
To set Saxon 9.9 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 9.9.1.8 (External) as the validation engine..
If you prefer to use Saxon 9.9 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 9.9.1.8 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 9.9.1.8 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon9-sql.jar that is located in [OXYGEN_INSTALL_DIR]/lib/ or
[PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
Oxygen XML Editor provides a tool for converting an XML Schema file (XSD) to a JSON Schema file. The XSD to JSON Schema action for invoking the tool can be found in the Tools > JSON Tools menu. It requires an additional add-on to be installed, so the first time you invoke the action, Oxygen XML Editor will present a dialog box asking if you want to install it. ...
Read MorePlugin
This plugin installs an external Saxon 9.6 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 9.6.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
The Saxon 9.6 XSLT and XQuery Transformer plugin does not work with XQuery 3.1. If possible, you can use the 9.7 or 9.8 plugin instead.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 9.6 for validating XSLT:
To set Saxon 9.6 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 9.6.0.10 (External) as the validation engine..
If you prefer to use Saxon 9.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 9.6.0.10 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 9.6.0.10 (External) as the engine and associate it with the stylesheet.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 9.6 for validating XQuery:
To set Saxon 9.6 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 9.6.0.10 (External) as the validation engine..
If you prefer to use Saxon 9.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 9.6.0.10 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 9.6.0.10 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon9-sql.jar that is located in [OXYGEN_INSTALL_DIR]/lib/ or
[PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
Setup
Download and unzip the proper Vale executable
for your OS. On Linux and Mac, you need to give executable permission to the
Vale executable. You can do this by opening a console in the Vale directory
and running:
chmod u+x vale
Go to Options -> Preferences..., go to the plugin's preferences page
(Plugins / Oxygen Vale Validation) and specify the path to the
previously downloaded Vale executable.
In the same preferences page you can also specify a path to a Vale configuration file
(.vale.ini). Vale auto detects this
file by looking 6 levels up in the current file's ancestor directories, but you can also impose one.
Vale Styles
Vale uses collections of individual YAML files (or "rules") to enforce particular
writing constructs. These collections are referred to as styles and are
organized in a nested folder structure at a user-specified location. The
.vale.ini
file is
where you'll control the majority of Vale's behavior, including what files to lint
and how to lint them. Vale auto detects
.vale.ini, but you can also specify the path to .vale.ini from
the plugins preferences page (Options -> Preferences..., page Plugins /
Oxygen Vale Validation ).
Third-party styles
Vale has a growing selection of pre-made styles available for download from its style library.
Read MorePlugin
This add-on is used for generating documentation for OpenAPI (https://spec.openapis.org/oas/v3.0.3) components in HTML format, including annotations and cross references. The documentation displays information about the servers, paths, components and tags defined in the OpenAPI documents and it is presented in a visual diagram style with various sections, hyperlinks, and filtering options. What's new in version 3.0.0 An option was added to transform the OpenAPI content into PDF output. What's ...
Read MorePlugin
This plugin installs an external Saxon 9.8 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 9.8.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 9.8 for validating XSLT:
To set Saxon 9.8 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 9.8.0.15 (External) as the validation engine..
If you prefer to use Saxon 9.8 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 9.8.0.15 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 9.8.0.15 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 9.8 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 9.8 for validating XQuery:
To set Saxon 9.8 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 9.8.0.15 (External) as the validation engine..
If you prefer to use Saxon 9.8 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 9.8.0.15 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 9.8.0.15 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon9-sql.jar that is located in [OXYGEN_INSTALL_DIR]/lib/ or
[PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
Terminology Checker
This add-on contributes a terminology checker to Oxygen XML Editor/Author.
What's new in version 4.1.1
Improved sentences detection for Vale rules.
What's new in version 4.1.0
Security/Component Update: The SnakeYAML library was updated to version 1.31 - CVE-2022-25857
Any Oxygen add-on can contribute terminology files that will be used by the Terminology Checker.
The contributed terminology files will be loaded and used if the contributor add-on is enabled.
Extended support for Vale occurrence extension point, by implementing the sentence scope.
Added an option that stops presenting errors related to Vale rules (such as unsupported extension points or invalid properties) in Results view.
Updated colors in Terminology Checker view for better experience with Graphite theme.
Fixed an issue that could cause contextual menu to became to large.
Fixed an issue that caused the Terminology Checker view to became to large.
What's new in version 4.0.0
XPath context: Define simple XPath expressions for particular defined rules to match or skip specific elements.*
Part of speech tagging: When scanning for terminology problems, the problem is presented only if the term's part of speech matches the one specified on the defined rule (available only for the English language).
Phases: Set in the terminology configuration file the phase in which incorrect terms are applied: always/editing/validation.
Performance improvements when checking files.
The feature marked with * are available from Oxygen 24.1 build 2022062007 and newer.
What's new in version 3.0.0
Actions to check terminology for multiple selected resources are now available in the
DITA Maps Manager and Project view contextual menus.*
Terminology Checker can be used as a Validation Engine when creating Validation
Scenarios. This allows a validation scenario applied when editing content or
when batch validating resources in the Project view to contain a
terminology checking stage.*
The Terminology Checker preferences page can be saved at project level.*
Added a setting (checked by default) to preserve the case (capitalization) when
matches are replaced.
Added support for Vale
Conditional and Repetition extension points.
Specify the language for which the terms should be applied in an XML terminology file
by using the lang attribute on the incorrect-terms root
element.
Added in the XML terminology file the possibility to specify a link for each incorrect
term. The link can point to a web page where more details are available for
the rule and is presented in the Terminology Helper side view and when
hovering the highlighted problems.
The Terminology Helper side view has been redesigned for better
interaction.
Avoid presenting problems in read-only elements and in content deleted with Track
Changes.
Many bug fixes and small improvements.
The features marked with * are available from Oxygen 24.0 and newer.
What's new in version 2.0.1
Performance improvements when checking large files.
Fixed an unhandled exception that appeared when a terminology rule's message doesn't exist.
What's new in version 2.0.0
Load Vale files from yml files and highlight matching rules.
Side view that gives an overview of the terminology problems. Clicking in the
side view on the incorrect term will focus the matching term in Editor.
Use capturing groups in the suggestions and messages in your custom term rules
using the term match regular expression.
Share favorite rules with the team: define a folder oxygen-term-checker in
the root of your project and terms will be automatically loaded, without
defining another terms directory in plugin's Preferences page.
Match user defined custom terms at word level, character or write a regular
expression.
Insert suggestion value as plain-text or as XML fragment.
Set severity of custom incorrect terms.
Configure highlight colors and decoration of matching terms.
Quickly enable/disable add-on from the tool bar without restarting Oxygen.
Version 1.0.1:
Add-on highlights matched terms in the Author visual editing mode
Right click the highlights to access various actions allowing you to replace each individual highlight with suggestions or to apply the same suggestion in multiple places in the opened document
How to start:
Load Vale terminology files or use the File / New dialog wizard to create a new Terminology File, edit that file and add mappings between matched terms and their suggested replacements
Go to the Preferences / Plugins / Terminology Checker page and refer in the Terminology Folder text field to that folder where your terminology files are located
The incorrect terms which have been previously configured should now be highlighted in current editor in the Author visual editing mode
Read MorePlugin
This add-on contributes a toolbar button that provides the
ability to validate DocBook files. It reports issues such as
broken internal and external links, problems with images, or
profiling conditions that conflict with profiling preferences.
For more details, see:
https://github.com/oxygenxml/oxygen-docbook-validate-check-completeness
Read MorePlugin
ASD Simplified Technical English Specification Writing Style Guide Rules
by Syncro Soft
Version 1.0.0
Oxygen Version: 22.0+
ASD Simplified Technical English Specification (ASD-STE100) Writing Style Guide Rules for the "Terminology Checker" add-on
IMPORTANT! The "Terminology Checker" add-on must also be installed in order for this add-on to work.
This add-on contributes ASD Simplified Technical English Specification (ASD-STE100) rules for the Terminology Checker add-on.
This project is neither maintained nor endorsed by ASD.
This repository contains a compatible implementation of the ASD Simplified Technical English Specification (ASD-STE100).
Software from the following projects is included:
ASD-STE100
Site: https://asd-ste100.org
License: ASD Simplified Technical English, ASD-STE100, is a Copyright and a Trade Mark of ASD, Brussels, Belgium.
Read MorePlugin
This plugin installs an external Saxon 12.4 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 12.4.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possibilities to use Saxon 12.4 for validating XSLT:
To set Saxon 12.4 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 12.4 (External) as the validation engine..
If you prefer to use Saxon 12.4 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 12.4 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 12.4 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 12.4 allows one to export the compiled form of a stylesheet as a JSON or as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possibilities to use Saxon 12.4 for validating XQuery:
To set Saxon 12.4 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 12.4 (External) as the validation engine..
If you prefer to use Saxon 12.4 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 12.4 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 12.4 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon-sql-12.jar that is located in [PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
This plugin installs an external Saxon 10.9 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 10.9.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possibilities to use Saxon 10.9 for validating XSLT:
To set Saxon 10.9 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 10.9 (External) as the validation engine..
If you prefer to use Saxon 10.9 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 10.9 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 10.9 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 10.9 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 10.9 for validating XQuery:
To set Saxon 10.9 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 10.9 (External) as the validation engine..
If you prefer to use Saxon 10.9 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 10.9 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 10.9 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon-sql-10.jar that is located in [PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
An Oxygen XML Editor plugin used to generate the documentation for JSON Schema. ...
Read MorePlugin
This add-on contributes a Translator Helper to Oxygen XML Editor/Author.
Features:
You can translate content using Google Translate or DeepL Translator to various languages:
Select the content to translate in the Author visual editing mode. You can also select the contents of the entire document.
Right-click, select "Translate", and choose the target translator and language.
Copy the translated content from the open web page.
Click Replace in the Translate using Google Translate or Translate using DeepL Translator dialog box that appears.
The original content is replaced with the translated content while the original element structure and attributes remain unchanged.
In addition, you can choose to show the original document content in the Translator Helper side view.
This will allow you to correct the translation further by looking at the original text and the translated text side-by-side.
You can have your original content displayed side-by-side with the content that you are editing by right-clicking anywhere in the Author visual editing mode and selecting the Show current content in side view action.
This helps you to translate the content more accurately.
What's new in version 1.1.1
Fixed an issue where translating text with characters such as '%' and '#' did not work.
What's new in version 1.1.0
The plugin was updated to allow using the DeepL Translator in addition to Google Translate for translating content.
Read MorePlugin
This add-on contributes a side-view named 'Writer Helper' that contains various small tools intended to help technical writers:
Review - You can select folders or files in the Project view and start a review session for them. This 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. This is useful for finding possible elements that can be reused instead of being copy-pasted between documents.
Read Aloud - You can select content in the current document and use the Play button to listen to how it is read by the operating system's narrator. This is useful for those who want to review content by listening to it.
Tips - You can view a list of editing tips, tuned for technical writers. This is useful for discovering productivity tips to make your editing experience more efficient and productive.
More details about the add-on's functionality
Read MorePlugin
This add-on contributes a view in Oxygen that can be used as a testing tool for OpenAPI files (https://spec.openapis.org/oas/v3.1.0.html). The tool provides capabilities to easily inspect OpenAPI request-responses, and to make sure they work as expected. It is available for OpenAPI 3.x in both JSON and YAML format. The tester loads the selected OpenAPI document and automatically fills the corresponding fields. After clicking the Send button, it presents the ...
Read MorePlugin
Contributes JAXB-XJC library to Oxygen which makes possible the generation of Java classes from XSD files. The XJC compiler transforms a source XSD to a set of JAXB content classes in the Java programming language. It generates a class for each complex type and an additional factory class to ease the creation of JAXBElement representations. ...
Read MorePlugin
This plugin installs an external Saxon 10.3 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 10.3.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 10.3 for validating XSLT:
To set Saxon 10.3 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 10.3 (External) as the validation engine..
If you preffer to use Saxon 10.3 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 10.3 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 10.3 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 10.3 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 10.3 for validating XQuery:
To set Saxon 10.3 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 10.3 (External) as the validation engine..
If you preffer to use Saxon 10.3 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 10.3 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 10.3 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon-sql-10.0.jar that is located in [PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
This plugin installs an external Saxon 10.6 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 10.6.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 10.6 for validating XSLT:
To set Saxon 10.6 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 10.6 (External) as the validation engine..
If you preffer to use Saxon 10.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 10.6 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 10.6 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 10.6 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 10.6 for validating XQuery:
To set Saxon 10.6 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 10.6 (External) as the validation engine..
If you preffer to use Saxon 10.6 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 10.6 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 10.6 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon-sql-10.0.jar that is located in [PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
This plugin installs an external Saxon 9.7 XSLT & XQuery processor into <oXygen/>. You will be able to validate and transform XSLT/XQuery with Saxon 9.7.
Note: Debugging XSLT/XQuery transformations based on this engine is NOT supported.
XSLT Validation
After installing the plugin, there are two possiblities to use Saxon 9.7 for validating XSLT:
To set Saxon 9.7 as the default XSLT validation engine, go to XSLT Preferences and select Saxon-EE 9.7.0.21 (External) as the validation engine..
If you prefer to use Saxon 9.7 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE 9.7.0.21 (External) as the engine and associate it with whichever stylesheet you like.
XSLT Transformation
Create a Transformation Scenario that uses Saxon-EE 9.7.0.21 (External) as the engine and associate it with the stylesheet.
XSLT Compile
Saxon 9.7 allows one to export the compiled form of a stylesheet as an XML file. The plugin also contributes an action on the toolbar that will compile and export an XSLT.
XQuery Validation
After installing the plugin, there are two possiblities to use Saxon 9.7 for validating XQuery:
To set Saxon 9.7 as the default XQuery validation engine, go to XQuery Preferences and select Saxon-EE XQuery 9.7.0.21 (External) as the validation engine..
If you prefer to use Saxon 9.7 just for some specific stylesheets, then you should create either a Validation Scenario or a Transformation Scenario that uses Saxon-EE XQuery 9.7.0.21 (External) as the engine and associate it with whichever stylesheet you like.
XQuery Transformation
Create a Transformation Scenario that uses Saxon-EE XQuery 9.7.0.21 (External) as the engine and associate it with the XQuery file.
Performing Transformations with Data Extracted from a Database
This plugin will allow you to perform transformations with data extracted from a
database, but there are a few changes you will have to make to use this:
Add a copy of the database connector that is compatible with your database in
[OXYGEN_INSTALL_DIR]/lib/ or in [PLUGIN_INSTALL_LOCATION]/lib/ (you can
go to Options->Preferences->Plugins to see where the plugin is installed).
Restart the application.
Run the transformation scenario.
If this does not work, try the following:
Create a transformation scenario (see sections above) and click the
Extensions button.
Added the database connector that is compatible with your database.
Add saxon9-sql.jar that is located in [OXYGEN_INSTALL_DIR]/lib/ or
[PLUGIN_INSTALL_LOCATION]/lib/ (you can go to
Options->Preferences->Plugins to see where the plugin is installed).
Run the transformation scenario.
Read MorePlugin
This add-on allows you to upload tasks that contain documents to be reviewed on the Oxygen Content Fusion collaboration platform. Reviewers can then login to Oxygen Content Fusion to review, add comments, or contribute changes to the uploaded documents. You also have access to a Merge tool that allows you to automatically merge the changes back into Oxygen.
After installing the add-on, a new toolbar button (Show Content Fusion Tasks Manager View) will be available and clicking that button displays the Content Fusion Tasks Manager view where you can create the tasks to be uploaded to Oxygen Content Fusion.
For more information, go to http://www.oxygenxml.com/content_fusion.html.
Release Notes 5.5
Added the possibility to specify the original location of a task created using documents stored on a remote server (so that other owner than the one that created the task to be able to integrate the changes).
Release Notes 5.4
Fixed an issue where the Get Changes action fails for tasks created using documents stored on a remote server if they contained absolute references.
Release Notes 5.3
Fixed an issue where the "Add To Review Task" action was not added to the contextual menu when the "Oxygen Writer Helper" add-on was installed in the editor.
A "Mark as integrated" action was added in the contextual menu of the Content Fusion Task Manager view that allows users to mark a task as integrated, hiding it from the list of tasks.
A "Close review" action was added in the contextual menu of the Content Fusion Task Manager view that allows users to block the review for a task.
A "Reopen review" action was added in the contextual menu of the Content Fusion Task Manager view that allows the user to reopen the review for a closed task.
The "Integrating" and "Review closed" states are now shown on task cards.
Improved the text messages and labels in the "Connection status" dialog box.
A "Due Date" section was added inside the "New Task" box where users can set a deadline for when the review must be finished.
A "cf-file" protocol can be used when a customizer wants to either control the file content before it is sent to Content Fusion or when it is saved in the original files after the "Get Changes User" action is performed.
Fixed an issue where the default Java 'charset' was used when updating files after the "Get Changes" action was invoked.
Fixed an issue where some task files were wrongly identified as deleted locally, after a local base path for the task was provided.
Release Notes 5.2.1
A DITAVAL file can now be easily added as a filter in the Content Fusion Tasks Manager view by simply dragging and dropping it from the DITA Maps Manager to the DITA Context area.
Release Notes 5.2
Added the option to upload referenced files when no context DITA map is specified when creating a new task. This option is present in the upload panel and if enabled it uploads files that are directly referenced from the files to be reviewed. Referenced files are detected by looking for "href", "conref" and "conrefend" attributes but we don't look for "conkeyref" attributes.
Release Notes 5.1
Content Fusion task files that are locked by another user are opened in the editor as read-only.
When a Content Fusion task file editor becomes active, Oxygen automatically tries to regain the file lock and makes the editor editable if it acquires it.
Fixed an issue where the Undo action was enabled in a Content Fusion task file that was in a read-only state.
Fixed an issue where the editor tab displayed the old name of a Content Fusion task file after using the "Save As" action.
Improved the message displayed in the "Connection status" dialog box to offer more information about the state of the connection.
Renamed the "Open context DITA map" action in the contextual menu to "Edit context DITA map" since it more accurately describes the resulting action.
Release Notes 5.0
It is now possible to open a file directly from a Content Fusion task. The file's URL can be copied from the browser and pasted in the dialog box presented when using the "Open URL" action that is available on the toolbar and in the File menu.
A "Open context DITA map" action was added in the Content Fusion Task Manager view's contextual menu and it opens the DITA map specified as the context map for a task.
The content of the "Connection status" dialog box was updated to offer more clear information about the server status.
Release Notes 4.3.1
Fixed an issue where the logging mechanism no longer worked (a "NoSuchMethodError" warning was displayed in the console and in the generated log files).
Release Notes 4.3
The SLF4J API is now used for logging instead of Log4j 2.x.
A notification dialog box is displayed when there are read-only files that could not be updated by the "Get Changes" operation.
Release Notes 4.2
Always ignore external resource exceptions when getting task changes.
Release Notes 4.1
Added an option in the Preferences page to activate an alternate way to upload tasks. This option uploads files that are directly referenced from the files to be reviewed and all the detected DITA maps (starting from the context map). Referenced files are detected by looking for "href", "conref" and "conrefend" attributes but we don't look for "conkeyref" attributes.
Release Notes 4.0
Tested and validated the compatibility of the plugin with Oxygen XML Editor/Author 23.1.
Fixed a problem where a connection opened to the server was not properly closed.
Added an option in the plugin preferences page to skip activity checks when refreshing tasks (for performance improvements). When this option is activated, the "Get Changes" action is presented on the task box but no activity information (comments and changed files count) will be available.
Release Notes 3.1
Ensured the compatibility of the plugin with Oxygen XML Editor/Author 23.0
Moved the "Add File to Review Task" from the Author page contextual menu inside the "Review" submenu
Removed the plugin from the Oxygen XML Editor/Author kit. Added actions on the "Review" toolbar, DITA Maps Manager and Author page contextual menus that can be used to install the plugin
Release Notes 3.0
Ensured the compatibility of the plugin with Oxygen XML Editor/Author 22.1.
Before integrating the changes from a task that was created on the server, you must specify a folder where the task files can be saved.
Updated the filter buttons tooltips from "Get Changes" dialog to be more accurate.
Release Notes 2.0.1
Before integrating the changes from a task that was created on the server, you must specify a folder where the task files can be saved.
Release Notes 2.0
Introductory screen about Content Fusion, with details about the review workflow.
You can now specify a custom DITAVAL to be used for profiling in DITA tasks.
Current DITAVAL is automatically set when a new DITA task is created.
Added a mechanism that detects resource references within the files to review. You can choose to include the referred resources to the task.
You can save new files added by reviewers on a task created from documents stored on a remote server.
Fixed a problem where the editor blocked while using the Content Fusion connector.
Updated the libraries used by the plugin.
Release Notes 1.0.7
Modified the layout to allow changing the width of the tasks view to a smaller minimum value.
Release Notes 1.0.6
Content Fusion is now compatible with SDL Tridion Docs (tested with version 13 SP2).
The name of the context map is wrapped in the "New Task" view.
Fixed uploading of a context map with space characters in its file name.
Fixed icon size of the "Add file to review" action.
Fixed "Get changes" action that failed when the context map was missing locally.
Fixed action activation when hovering over a task.
Release Notes 1.0.5
Detect and warn if none of the attached files are referenced by the specified context DITA map.
Improvements for the mechanism that seeks for the proper enterprise server URL from an incorrect one.
Present the task name in the delete task dialog.
Fixed "Get Changes" dialog size on small screens.
Release Notes 1.0.4
Fixed a problem where uploading a task failed because the temporary plugins folder was deleted by the operating system.
You now have the ability to "Copy task link" directly from the contextual menu of the Tasks Manager in Oxygen, instead of having to open the task in your browser to retrieve the link.
Improved the background color of the panel in the Tasks Manager where you choose the Oxygen Content Fusion server.
Release Notes 1.0.3
Ensured the compatibility of the plugin with Oxygen XML Editor/Author 20.1.
Release Notes 1.0.2
Fixed task rendering issue after the plugin reconnects to the server.
Automatically adding "http://" protocol to the server address (if missing) before trying to establish a connection.
Release Notes 1.0.1
Added a mechanism that tests the server address when trying to connect to a Content Fusion server. If that connection cannot be established, it attempts to find a valid similar address (for example, the same address without a port number).
Read MorePlugin
Emmet is a toolkit for high-speed HTML, XML, XSL etc. coding and editing. The
core of this plugin is a powerful abbreviation engine which allows you to
expand expressions—similar to CSS selectors—into HTML code.
For more details see: docs.emmet.io.
What's new in version 24.1.1
Fixed CVE-2021-23358.
Read MorePlugin
This add-on allows end users to run live tutorials and learn to use Oxygen inside
the application. Once the Live Tutorials add-on is installed, the
Tutorials view is available by selecting it from the Window > Show
View menu. The add-on comes bundled with a set of tutorials for learning to
work with the DITA XML standard and you also have the ability to create your own
tutorials. Each tutorial contains one or more missions. A mission consists of
initial file content that is opened in the application and a set of steps and hints
for guidance. The mission is considered complete when the initial content is changed
by the end user to match an expected result.
For more information, go to Live Tutorials Add-on Documentation.
Read MorePlugin
Fluenta is a tool designed to
simplify the translation of DITA projects. It parses a DITA map, resolves the references to
all topics and subtopics, and prepares a unified XLIFF file that you can send to your
Language Service Provider. The Fluenta DITA Translation add-on allows you to
manage the Fluenta translation workflow directly from within Oxygen XML Editor.
What's new in version 3.0.0
The internal version of Fluenta has been updated to Fluenta 3.3.0.
What's new in version 2.0.0
The internal version of Fluenta has been updated to Fluenta 3.2.0, it contains various improvements, the most important being:
Allowed selection of working folders for projects and memories.
Switched to JSON format for storing project and memory data.
Updated OpenXLIFF Filters to version 2.10.0.
Added support for Lightweight DITA(XML).
Improved DITAVAL handling.
Added a preferences page where you can save the folder where the projects and translation memories are stored, as well as the possibility to choose some target languages to be prefilled when creating a new Fluenta project.
Read MorePlugin
This add-on contributes a preferences page that includes various
options for updating the "prolog" section of a DITA topic/map.
For more details, see:
https://github.com/oxygenxml/oxygen-dita-prolog-updater
What's new in version 1.1.2
Added a new option for controlling where to store the options
from the add-on preferences page (either in global options or in
project-level options).
Fixed an issue where the prolog element was inserted in
documents that do not allow it.
What's new in version 1.1.1
Fixed an issue where a 'contributor' author was inserted
instead of a 'creator' author for newly created documents that
have whitespaces in the path.
What's new in version 1.1.0
Added a new option to customize the value of the
type
attribute for the
author
element that is inserted to allow you to specify the primary (
creator
) author.
#20
Added a new option to customize the value of the
type
attribute for the
author
element that is inserted to allow you to specify an additional
author (
contributor
).
#20
Improved the process so that an additional author (
contributor
) cannot be added if they are already specified as the primary (
creator
) author.
#21
Fixed an issue where a warning message was reported even though
prolog updating was disabled.
#15
Read MorePlugin
This addon uses an external AI service (like OpenAI or MS Azure OpenAI) to help technical documentation writers generate content.
Read MorePlugin