History | Edit

Oxygen XML Web Author supports some of the options used by Oxygen XML Editor/Author. The supported options are applied for all Web Author users. The options are stored in an XML file with the following format:
<?xml version="1.0" encoding="UTF-8"?>
<serialized version="18.1" xml:space="preserve">
  <map>   
    <entry>
      <String>author.show.comments</String>
      <Boolean>true</Boolean>       
    </entry>
  </map>
</serialized>
For each option, an additional entry should be added in this file.
Table 1. Oxygen XML Author Options Supported in Oxygen XML Web Author
Key Type Description
dita.ot.directory String The directory path to the default DITA OT installation.
track.changes.initial.state Integer Option for track changes initial state.
  • 0 - Initial state stored in document.
  • 1 - Track changes always on.
  • 2 - Track changes always off.
automatically.accept.certificates boolean Option that controls if Oxygen will accept all HTTPS certificates.
additional.frameworks.directories See example entry below

An array of java.lang.String objects representing paths to the additional frameworks folders (may also contain editor variables).

WEBAPP_SHOW_ADMIN_PAGE_LINK boolean true to display the admin page link on the dashboard.
ADMIN_PAGE_IS_DISABLED boolean true to disable the Administration Page completely.
author.convert.external.content.on.paste boolean

Option that controls whether or not the content pasted in Author mode should be converted to match the destination styles.

author.convert.external.content.space.preserve boolean

Option that controls whether or not the content pasted in Author mode should be converted to match the destination styles in space-preserved elements.

http.read.timeout.seconds Integer An integer number that configures the timeout used when waiting for an HTTP request.
http.proxy.system boolean "True" to detect HTTP proxy from system.
http.proxy.set boolean HTTP proxy uses manual configuration.
http.proxy.port Integer Proxy port.
http.proxy.host String Proxy hostname or IP address.
http.proxy.user String Proxy user.
http.proxy.password String Proxy password.
http.proxy.direct String Comma separated list of hosts for which the proxy is bypassed.
http.max.simultaneous.connections.per.host Integer Limits the number of connections the HTTP client can open to the same server host.
author.show.comments boolean Show the comment nodes in the author page.
author.show.processing.instructions boolean Show the pi nodes in the author page.
autocorrect.feature.state boolean Used to enable/disable the auto-correct feature.
autocorrect.use.suggeestions.from.spell.check.dicts boolean Used to enrich the auto-correct suggestions with entries from spell checking dictionaries.
author.format.compatibility Integer Possible values include: 0, 1, 2

0: Nothing special is done for compatibility purpose.

1: Do not break lines, do not indent.

2: Break lines only after elements displayed as blocks, do not indent.

dita.fill.link.format.attribute boolean Use true to force the insertion of the format attribute when inserting a link in DITA even when the attribute has a default value.
dita.fill.link.scope.attribute boolean Use true to force the insertion of the scope attribute when inserting a link in DITA even when the attribute has a default value.
dita.fill.link.type.attribute boolean Use true to force the insertion of the type attribute when inserting a link in DITA even when the attribute has a default value.
auto.correct.single.quotes See example entry below If set, Web Author automatically replaces single quotes with the specified quotation symbols.
auto.correct.double.quotes See example entry below If set, Web Author automatically replaces double quotes with the specified quotation symbols.
author.image.width.autoscale.limit 1024 If set to a value greater than 0, images wider than this number of pixels will be resized.
Example entry for additional.frameworks.directories option:
<entry>
  <String>
   additional.frameworks.directories
  </String>
  <String-array>
    <String>
     /path/to/frameworks
    </String>
  </String-array>
</entry>
Example entry for auto.correct.single.quotes and auto.correct.double.quotes option:
<entry> 
  <String>auto.correct.single.quotes</String> <!–- or auto.correct.double.quotes  -->
  <autoCorrectQuotes>
    <field name="enabled">
      <Boolean>true</Boolean>
    </field>
    <field name="startQuote">
      <Character>‘</Character>
    </field>
    <field name="endQuote">
      <Character>’</Character>
    </field>
  </autoCorrectQuotes>
</entry>