The Configuration page displays all the properties grouped by type. Setting any property from this tab sets the property for the Site level. Properties can also be set at the Template level and the Data Definition level. If conflicting values are set for a property at each level, the Template level will take precedence, followed by the Data Definition level, then the Site level.
For information on setting properties at the Template level, see Setting Runtime Properties for a Template. For information on setting properties at the Data Definition level, see Setting Runtime Properties for a Data Definition.
In previous releases of XML Publisher these properties could only be set using a configuration file (xdo.cfg). You can still use the configuration file to set these properties, and if already installed, the values will be respected. If values are entered in the Administration interface, however, these will take precedence.
The xdo configuration file must be used to set parameters specific to a server. For example, to specify different temporary directories for each server, you must use the xdo.cfg file instead of specifying it as a site-level parameter in the Administration interface.
Several properties are not available from the Administration interface. These must be set using the configuration file. For a list of these properties, see Properties Defined Only in the Configuration File.
See XML Publisher Configuration File for details on setting up this file.
The property available from the General heading is:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Temporary directory | system-temp-dir | N/A | Enter the directory path for the temporary directory to be used by the FO Processor when processing large files. It is strongly recommended that you set a temporary directory to avoid "Out of Memory" errors.
Note: To set different directories for different servers, you must use the configuration file to set this property at the server level. See XML Publisher Configuration File for details on setting up this file. |
The following properties are available for PDF output:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Compress PDF output | pdf-compression | True | Specify "True" or "False" to control compression of the output PDF file. |
| Hide PDF viewer's menu bars | pdf-hide-menubar | False | Specify "True" to hide the viewer application's menu bar when the document is active. |
| Hide PDF viewer's tool bars | pdf-hide-toolbar | False | Specify "True" to hide the viewer application's toolbar when the document is active. |
| Replace smart quotes | pdf-replace-smartquotes | True | Set to "False" if you do not want curly quotes replaced with straight quotes in your PDF output. |
Use the following properties to control the security settings for your output PDF documents:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Enable PDF Security | pdf-security | False | If you specify "True," the output PDF file will be encrypted. You must also specify the following properties:
|
| Open document password | pdf-open-password | N/A | This password will be required for opening the document. It will enable users to open the document only. This property is enabled only when "Enable PDF Security" is set to "True". |
| Modify permissions password | pdf-permissions-password | N/A | This password enables users to override the security setting. This property is effective only when "Enable PDF Security" is set to "True". |
| Encryption level | pdf-encryption-level | 0 - low | Specify the encryption level for the output PDF file. The possible values are:
This property is effective only when "Enable PDF Security" is set to "True". When Encryption level is set to 0, you can also set the following properties:
When Encryption level is set to 1, the following properties are available:
|
| Disable printing | pdf-no-printing | False | Permission available when "Encryption level" is set to 0. When set to "True", printing is disabled for the PDF file. |
| Disable document modification | pdf-no-changing-the-document | False | Permission available when "Encryption level" is set to 0. When set to "True", the PDF file cannot be edited. |
| Disable context copying, extraction, and accessibility | pdf-no-cceda | False | Permission available when "Encryption level" is set to 0. When set to "True", the context copying, extraction, and accessibility features are disabled. |
| Disable adding or changing comments and form fields | pdf-no-accff | False | Permission available when "Encryption level" is set to 0. When set to "True", the ability to add or change comments and form fields is disabled. |
| Enable text access for screen readers | pdf-enable-accessibility | True | Permission available when "Encryption level" is set to 1. When set to "True", text access for screen reader devices is enabled. |
| Enable copying of text, images, and other content | pdf-enable-copying | False | Permission available when "Encryption level" is set to 1. When set to "True", copying of text, images, and other content is enabled. |
| Allowed change level | pdf-changes-allowed | 0 | Permission available when "Encryption level" is set to 1. Valid Values are:
|
| Allowed printing level | pdf-printing-allowed | 0 | Permission available when "Encryption level" is set to 1. Valid values are:
|
The following properties can be set to govern RTF output files:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Enable change tracking | rtf-track-changes | False | Set to "True" to enable change tracking in the output RTF document. |
| Protect document for tracked changes | rtf-protect-document-for-tracked-changes | False | Set to "True" to protect the document for tracked changes. |
The following properties can be set to govern HTML output files:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Base image URI | html-image-base-uri | N/A | Base URI which is inserted into the src attribute of the image tag before the image file name. This works only when the image is embedded in the template. |
| Image file directory | html-image-dir | N/A | Enter the directory for XML Publisher to store the image files that are embedded in the template. |
| Base CSS URI | html-css-base-uri | N/A | Base URI which is inserted into the HTML header to specify where the cascading stylesheets (CSS) for your output HTML documents will reside. You must set this property when make-accessible is true. |
| CSS file directory | html-css-dir | N/A | The CSS directory where XML Publisher stores the css file. You must set this property when make-accessible is true. |
| Show header | html-show-header | True | Set to "False" to suppress the template header in HTML output. |
| Show footer | html-show-footer | True | Set to "False" to suppress the template footer in HTML output. |
| Replace smart quotes | html-replace-smartquotes | True | Set to "False" if you do not want curly quotes replaced with straight quotes in your HTML output. |
| Character set | html-output-charset | UTF-8 | Specify the output HTML character set. |
| Make HTML output accessible | make-accessible | False | Specify true if you want to make the HTML output accessible. |
The following properties can be set to govern FO processing:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Font mapping set | N/A | N/A | Select the Font Mapping Set from the list. This will be used for mapping fonts from RTF and XSL-FO templates to output PDF documents. See Creating a Font Mapping for more information. |
| Currency format Set | N/A | N/A | Select the Currency Mapping Set from the list. Use a currency mapping if you want to use specific currency format masks in your templates. A currency mapping can be used for RTF and XSL-FO templates only. See Defining Currency Formats for more information. |
| Bidi language digit substitution type | digit-substitution | None | Valid values are "None" and "National". When set to "None", Eastern European numbers will be used. When set to "National", Hindi format (Arabic-Indic digits) will be used. This setting is effective only when the locale is Arabic, otherwise it is ignored. |
| Pages cached during processing | system-cache-page-size | 50 | This property is enabled only when you have specified a Temporary Directory (under General properties). During table of contents generation, the FO Processor caches the pages until the number of pages exceeds the value specified for this property. It then writes the pages to a file in the Temporary Directory. |
| Disable variable header support | fo-prevent-variable-header | False | If "True", prevents variable header support. Variable header support automatically extends the size of the header to accommodate the contents. |
| Add prefix to IDs when merging FO | fo-merge-conflict-resolution | False | When merging multiple XSL-FO inputs, the FO Processor automatically adds random prefixes to resolve conflicting IDs. Setting this property to "True" disables this feature. |
| Use XML Publisher's XSLT processor | xslt-xdoparser | True | Controls XML Publisher's parser usage. If set to False, XSLT will not be parsed. |
| Enable scalable feature of XSLT processor | xslt-scalable | False | Controls the scalable feature of the XDO parser. The property "Use XML Publisher's XSLT processor" must be set to "True" for this property to be effective. |
The following properties can be set to govern RTF templates:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Extract attribute sets | rtf-extract-attribute-sets | Auto | The RTF processor will automatically extract attribute sets within the generated XSL-FO. The extracted sets are placed in an extra FO block, which can be referenced. This improves processing performance and reduces file size. Valid values are:
|
| Enable XPath rewriting | rtf-rewrite-path | True | When converting an RTF template to XSL-FO, the RTF processor will automatically rewrite the XML tag names to represent the full XPath notations. Set this property to "False" to disable this feature. |
| Characters used for checkbox | rtf-checkbox-glyph | Default value: Albany WT J;9746;9747/A | The XML Publisher default PDF output font does not include a glyph to represent a checkbox. If your template contains a checkbox, use this property to define a Unicode font for the representation of checkboxes in your PDF output. You must define the Unicode font number for the "checked" state and the Unicode font number for the "unchecked" state using the following syntax: fontname;<unicode font number for true value's glyph >;<unicode font number for false value's glyph> Example: Albany WT J;9746;9747/A Note that the font that you specify must be made available to XML Publisher at runtime. |
The following properties can be set to govern PDF templates:
| Property Name | Default Value | Description |
|---|---|---|
| Font mapping set | N/A | Select the Font Mapping Set. This will be used for mapping fonts from PDF templates to output PDF documents. See Creating a Font Mapping for more information. |
The following properties can be set to govern XLIFF extraction:
| Property Name | Internal Name | Default Value | Description |
|---|---|---|---|
| Translation expansion percentage | xliff-trans-expansion | 150 (percentage) | This property determines the maximum percent expansion of an extracted translation unit. For example, if set to 200, the XLIFF extractor will allow expansion by 200% - that is, a 10-character element will have a maximum width of 30 characters. |
| Minimum translation length | xliff-trans-min-length | 15 (characters) | Sets a minimum length in characters for the extracted translation unit. For example, the default expansion of a 4-character field is 10 characters (based on the default setting of Translation expansion percentage of 150). If the Minimum translation length is 15, this field will be reset to 15 characters. |
| Maximum translation length | xliff-trans-max-length | 4000 (characters) | Sets a limit to the calculated expansion of the translation unit (in characters). For example, the default maximum expansion of 100 characters is 250 characters. Setting Maximum translation length to 200 would limit this expansion to 200 characters. |
| Extract white space | xliff-trans-null | False | Instructs the XLIFF extractor to create a translation unit for a record that contains only spaces (is null). Set to "True" to generate the translation unit. |
| Extract sections without letters | xliff-trans-symbol | False | Instructs the XLIFF extractor whether to extract symbol characters. If set to "False" only A-Z and a-z will be extracted. |
| Extract words with underscores | xliff-trans-keyword | True | If set to "False", words with underscores will not be extracted. |