Exclude file from search result in webhelp

DocWriter
Posts: 6

Exclude file from search result in webhelp

Thu Jun 08, 2017 4:38 pm

Hi,
Oxygen 19
I use a ditafile that is outside the folder of the ditamap. I link all the uicontrols to this file via conref.
But I don't want that this file is listed in the results of the search in the responsive webhelp.
Can I exclude this file from the webhelp, without missing the uicontrols?
Or is there another workaround?
The file appears like: oxy_ex-2/!uicontrol_nl.html
Regards,
Stefaan
bogdan
Posts: 12

Re: Exclude file from search result in webhelp

Fri Jun 09, 2017 11:41 am

Hi Stefaan,

The DITA Map to WebHelp transformation scenario allows you to set a parameter (namely webhelp.search.custom.excludes.file) to an exclusion list of files. Please follow this procedure to set it:

  1. Create a simple text file that will contain your excluded file patterns. Each pattern must be on a new line. The patterns are considered to be relative to the output directory and they accept wildcards such as '*' (matches zero or more characters) or '?' (matches one character). For more information about the patterns, see https://ant.apache.org/manual/dirtasks.html#patterns
    Example: Suppose that in your project, you want to exclude all files located in the resources directory and all files located in the topics directory that have a .bak file extension. You could create a simple text file (for example, named exclude.properties), and add the following lines:

    Code: Select all

    resources/*
    topics/*.bak
  2. Edit the WebHelp transformation scenario and open the Parameters tab.
  3. Set the webhelp.search.custom.excludes.file parameter to specify the path to the file that contains the excluded file patterns (for example, exclude.properties in step 1).
  4. Run the transformation scenario.

I hope this helps.

Bogdan
Oxygen XML Editor

Return to “DITA (Editing and Publishing DITA Content)”

Who is online

Users browsing this forum: No registered users and 2 guests