Documentation Center

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
ParameterRequiredDefault valueAllowed valuesDescription
DITAOTOutDirectoryContextItemKeyYesThe name of key of input parameter to get the full directory name of the out directory generated by DITA-OTThe input value with the full directory name of the out directory generated by DITA-OT will be obtained from the context.Items collection.
ScriptsFolderYes Valid folder path.The path to the folder that contains the ishrunsdlxpp.vbs script.
Input expected in the context.Items collection:
ParameterRequiredDefault valueAllowed valuesDescription
The name of key is specified in the parameter DITAOTOutDirectoryContextItemKeyYes stringThe 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.vbs script with the correct set of parameters (including the root export folder, the DITA-OT out folder and the root filename without extension)
  • This script will upload the merged xml file that is present in the DITA-OT out folder and the images to . Then the transformation is triggered to generated a PDF file, which is then downloaded and put in the DITA-OT out folder as well.