[oXygen-user] Web Help: How to include an entire directory in the output?

Oxygen XML Editor Support (Radu Pisoi) support at oxygenxml.com
Thu Feb 6 01:24:28 CST 2020


You can use the template resource^[1] section from publishing template 
descriptor to specify a directory that will be copied to the output 
folder. The /resources/fileset/ element allow you to define one or more 
sets of additional resources to be copied to the output folder.

> *<publishing-template>*
>      ...
>      *<webhelp>*
>        ...
>        *<resources>*             
>            *<fileset>*
>                *<include*  name="common/**/*"*/>*
>                *<include*  name="JS/**/*"*/>*               
>                *<exclude*  name="**/*.svn"*/>*
Please note that all relative paths specified in the descriptor file are 
relative to the template root folder.

The resources specified in the template descriptor are copied to the 
following output folder: /[WebHelp_OUTPUT_DIR]/oxygen-webhelp/template/. 
If you want to refer them from HTML fragments you can use the 
/oxygen-webhelp-template-dir^[2] / macro:

> <link rel="stylesheet" 
> href="${oxygen-webhelp-template-dir}/custom-resources/custom.css" />

[1] - Template Resources 

[2] - WebHelp Responsive Macros 

Radu Pisoi
<oXygen/>  XML Editor, Schema Editor and XSLT Editor/Debugger

On 2/5/2020 4:26 PM, Kristen James Eberlein wrote:
> Hi,
> We need to include an entire directory of CSS and JavaScript files in 
> the Web Help output: 317 files, too many to reference by individual 
> <include> elements in the template descriptor file.
> How can we best do this?
> Previously, the team managed this by simply hacking the 
> com.oxygenxml.webhelp.responsive/oxygen-webhelp/lib directory to add 
> their directory; I very much do NOT want to do that.
> Obviously, we could handle this by a copy operation in our automated 
> build, but then we would have differences between the results of the 
> automated build and any local builds from within oXygen.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20200206/fbd9b7bc/attachment.html>

More information about the oXygen-user mailing list