Edit online

How to Copy Additional Resources to Output Directory

You can copy additional resources (such as graphics, JavaScript, CSS, entire folders, or other resources) to the output directory either by using an Oxygen Publishing Template, the webhelp.custom.resources parameter or by referencing it in the DITA Map .

Copying Additional Resources to the Output Directory using a Publishing Template

  1. If you have not already created a Publishing Template, see How to Create a Publishing Template.
  2. Add a new <fileset> element in the resources section of the template descriptor file.
    <publishing-template>
        ...
        <webhelp>
            ...                
            <resources>            
                <fileset>
                    <include name="custom-resources/**/*"/>
                    <exclude name="**/*.git"/>
                </fileset>
    Note:
    Relative paths in the descriptor file are relative to the template root folder.
  3. Open the DITA Map WebHelp Responsive transformation scenario.
  4. Click the Choose Custom Publishing Template link and select your template.
  5. Click OK to save the changes to the transformation scenario.
  6. Run the transformation scenario.

Results: All files from the custom resources directory will be copied to the WebHelp Output Directory/oxygen-webhelp/template folder.

Copying Additional Resources to the Output Directory using a Transformation Parameter

  1. Place all your resources in the same directory.
  2. Edit the DITA Map WebHelp Responsive transformation scenario and open the Parameters tab.
  3. Edit the value of the webhelp.custom.resources parameter and set it to the absolute path of the directory in step 1.
  4. Click OK to save the changes to the transformation scenario.
  5. Run the transformation scenario.

Results: All files from the new directory will be copied to the root of the WebHelp output directory.

Copying Additional Resources to the Output Directory using DITA Map reference

  1. Place the resources in the ditamap directory or in a folder under it.
  2. Open your ditamap file and declare the resource to be copied:
    <topicref href="path/to/manual.pdf" format="pdf" processing-role="resource-only"/>
  3. Run the transformation scenario.

Result: All files referenced this way will be copied at the path indicated by @href in the ditamap.