Embedding an Edit Link that will Launch Web Author

Edit online

https://www.oxygenxml.com/oxygen-xml-web-author/

• url - The OXY-URL that identifies the file to be opened.
• folderUrl - You can use this parameter to navigate to the Dashboard with the corresponding repository tab opened and the content of the specified folder displayed.
• author - The author name.
• autoSaveInterval - The interval of time (in seconds) to wait until an auto-save is performed. If <= 0 or false, auto-save is disabled.
• ccOnEnter - If set to true, the content completion popup window is displayed when the user presses Enter. If set to false, the Enter key works similar to the behavior in normal word processors.
• hideBreadcrumb - If set to true, the breadcrumb will not be displayed in the interface.
• lang - You can use this parameter to impose a specific language for the Oxygen XML Web Author interface. The possible values are:
  • en_US - English
  • de_DE - German
  • fr_FR - French
  • ja_JP - Japanese
  • nl_NL - Dutch
• spell.check.language - Specifies the default language used for spell checking in the document. The value must be in either a 2-digit or 4-digit language code format (for example, en or en_US).
• trackChanges - Flag that controls whether or not the editor should track changes. The possible values are:
  • default - The status of change tracking is determined by the server's global options.
  • enabled - Change tracking is enabled but the user can disable it using a toolbar action.
  • forced - Change tracking is enabled and the user cannot disable it. The user can reject their own changes, but cannot accept or reject changes made by others.
  If you use an option other than default, the server change tracking status (as configured in the Administration Page) should not be "Stored in the document". For more information about this parameter, see Control Change Tracking State
• ditamap - (DITA-specific Parameter) The OXY-URL of the DITA Map to use as a context for resolving keys.
• dita.val.url - (DITA-specific Parameter) The OXY-URL of a DITAVAL filter. It is used for resolving keys whose values depend on profiling conditions and it grays out content that is excluded by the DITAVAL filter.
• KeyscopeStack - (DITA-specific Parameter) Used for resolving keys when DITA 1.3 key scopes are defined in the DITA map. The value looks like this:

  a b c,d e f

  for a DITA map that has the key scope defined like this:

  <topicref keyscope="a b c"><topicref keyscope="d e f"/></topicref>

• expandTopicRefs - (DITA-specific Parameter) If set to true, when a DITA map is opened in Oxygen XML Web Author, the content of all topics referenced in the map will be presented.
• contentType - For cases where Web Author cannot open a document that has an unrecognized file extension, you can use this parameter as a loading option to pass a specific file type so that client-side editing support can be used for editing the document. You can also specify an encoding type. Examples for values:
  • image/png
  • application/xml
  • application/markdown;charset=utf-8

http://www.example.com/web-author-component-integration/

http://www.example.com/web-author-component-integration/app/oxygen.html
?url=http%3A%2F%2Fwww.test.com%2Ftopics%2Ftopic.xml
&ditamap=http%3A%2F%2Fwww.test.com%2Fmap.xml
&author=John%20Doe

1. In Oxygen XML Editor/Author, edit a DITA Map WebHelp Responsive or DITA Map PDF transformation scenario and open the Parameters tab.
2. Set values for the following parameters:
   • editlink.remote.ditamap.url - The custom OXY-URL of the DITA Map suitable for opening in Oxygen XML Web Author.
   • editlink.web.author.url - The URL of the Web Author installation (for example: https://www.oxygenxml.com/oxygen-xml-web-author/).
3. Run the transformation scenario.

1. Add the following import <xsl:include href="../../com.oxygenxml.editlink/pdf5.xsl"/> in the com.antennahouse.pdf5.ml/customization/dita2fo_custom.xsl file of the PDF5 plugin.
2. In the com.oxygenxml.editlink/plugin.xml file, uncomment the lines that configure the parameters for the PDF5 plugin:

   <feature extension="com.antennahouse.pdf5.ml.param" value="params.xml" type="file"/>
   <feature extension="com.antennahouse.pdf5.ml.saxon.param" value="params.xml" type="file"/>
   <feature extension="com.antennahouse.pdf5.ml.psmi.param" value="params.xml" type="file"/>

3. In Oxygen XML Editor/Author, edit a DITA Map PDF5 transformation scenario and open the Parameters tab.
4. Set values for the following parameters:
   • editlink.remote.ditamap.url - The custom OXY-URL of the DITA Map suitable for opening in Oxygen XML Web Author.
   • editlink.web.author.url - The URL of the Web Author installation (for example: https://www.oxygenxml.com/oxygen-xml-web-author/).
5. Run the transformation.