IPublishPostProcessPlugin - IshRunSDLXPP
Uploads the merged xml file obtained from DITA-OT together with the images to and runs the transformation to convert them to PDF
Plugin Input
Plugin configuration parameters
| Parameter | Required | Default value | Allowed values | Description |
|---|---|---|---|---|
| DITAOTOutDirectoryContextItemKey | Yes | The name of key of input parameter to get the full directory name of the out directory generated by DITA-OT | The input value with the full directory name of the out directory generated by DITA-OT will be obtained from the context.Items collection.
| |
| ScriptsFolder | Yes | Valid folder path. | The path to the folder that contains the ishrunsdlxpp.vbs script. |
Input expected in the
context.Items collection:
| Parameter | Required | Default value | Allowed values | Description |
|---|---|---|---|---|
The name of key is specified in the parameter DITAOTOutDirectoryContextItemKey | Yes | string | The out folder of DITA-OT |
Plugin Outcome
Changes made to the file system: PDF is generated in the DITA-OT out folder.
Values set in the context as a result: None.
Values set in the context.Items collection as a result: None
plugin name="ISHRUNSDLXPP" example
<plugin name="ISHRUNSDLXPP" handler="IshRunSDLXPP">
<description>
Uploads the merged xml file obtained from DITA-OT together with the images to SDL XPP and
runs the transformation to convert them to PDF
</description>
<initialize>
<parameters>
<parameter name="DITAOTOutDirectoryContextItemKey">DITAOTOutDirectory</parameter>
<parameter name="ScriptsFolder">%ISHPROJECTAPPPATH%\Utilities\PublishingService\Tools</parameter>
</parameters>
</initialize>
</plugin>
Plugin flow
The IshRunSDLXPP does the following:
- Starts a process that executes the
ishrunsdlxpp.vbsscript with the correct set of parameters (including the root export folder, theDITA-OTout folder and the root filename without extension) - This script will upload the merged xml file that is present in the
DITA-OTout folder and the images to . Then the transformation is triggered to generated a PDF file, which is then downloaded and put in theDITA-OTout folder as well.