Include or exclude DITA elements used for Approvals and Collaborative Reviews

By default, some DITA elements are included in Collaborative Review, but not in Approvals.

Within Collaborative Reviews, the required-cleanup and draft-comment DITA elements are visible by default. Within Approvals, they are turned off by default, and are not visible to the person reviewing the item for approval.

To change this default behavior, you need to create a new transformation scenario for Collaborative Reviews, Approvals or both. You can create this transformation scenario by creating new targets based on the dita2xhtmlcr and dita2xhtmlapproval targets and new preprocessors based on the dita2xhtmlcr and dita2xhtmlapproval preprocessors.

These steps describe creating a new preprocessor and target for Approvals to enable display of required-cleanup and draft-comment.

  1. In preprocessors.xml, copy the dita2xhtmlapproval preprocessor and add it to your client preprocessors.xml file.
  2. Do not rename the copy.
  3. In conductor-ixia-cr.xml, copy the dita2xhtmlapproval target and add it to your conductor-client.xml file.
  4. Rename the copy to something like acme.dita2xhtmlapproval.
  5. Edit the new preprocessor as follows:
    <preprocessor name="dita2xhtmlapproval" class="com.ixiasoft.outputgenerator.preprocessor.AntProcessor" >
    	<parameters>
    		<system>
    			<parameter name="buildfile" value="/conductor-client.xml"/>
    			<parameter name="target" value="acme.dita2xhtmlapproval"/>
    			<parameter name="clean" value="job_postprocess"/>
    			<parameter name="keep.log.files" value="true"/>
    		</system>
    	</parameters>
    </preprocessor
  6. Edit the new target as follows:
    <target name="acme.dita2xhtmlapproval" depends="default_dependencies, dita2xhtmlcr.init, flatten, resolve_container_keyref, extract_LowRes_images">
    	<echostart>acme.dita2xhtmlapproval</echostart>
    
    	<ot_build_add_ditaval_ifpresent/>
    	<ot_build_clean_ot_temp/>
    
    	<ot_build_set_parameter name="transtype" value="xhtml-cr"/>
    	<ot_build_set_parameter name="args.draft" value="yes"/>
    
    	<dita_startcmd_ot_build/>
    
    	...
    
    	<echoend>acme.dita2xhtmlapproval</echoend>
    </target>

    You do not need to create a new output type. The existing Dita2xhtmlapproval output type automatically calls your new preprocessor which in turn calls your new target.

    In addition to setting the args.draft parameter, you can add any other DITA-OT or custom build parameters to your new target, just as you would for any other target.

    Note: Any output type, preprocessor, or target in your client files automatically replaces an output type, preprocessor, or target of the same name in the default copies of the outputtypes.xml, preprocessors.xml, or conductor files.
  7. Restart the Ixiasoft Output Generator service.