Documentation Center

IPublishPostProcessPlugin - IshRunJarPlugin

Compile the content of the output directory into a jar file.

Plugin Input

Plugin configuration parameters
ParameterRequiredDefault valueAllowed valuesDescription
FolderContextItemsKeyYesValid key name, present in items collectionItem key of the item containing the full file path DITA-OT output folder.
JarFileNameYesValid file nameName to be given to the jar file.

Plugin Outcome

Jar file with the given name created in the DITA-OT output folder with the complete content of the DITA-OT output folder

plugin name="ISHRUNJAR" example


<plugin name="ISHRUNJAR" handler="IshRunJar">
  <description>Compile the content of the output directory into a jar file.</description>
  <initialize>
	<parameters>
	  <parameter name="FolderContextItemsKey">DITAOTOutDirectory</parameter>
	  <parameter name="JarFileName">result.jar</parameter>
	</parameters>
  </initialize>
</plugin>
			

Plugin flow

IshRunJarPlugin does the following:
  • Find the jar.exe using the environment variable JAVA_HOME which is configured in the BackgroundTask.exe.config and automatically set on any background task
  • Generate a jar file with the given name in the DITA-OT output folder containing the complete content of the DITA-OT output folder