WebHelp Search not working

Post here questions and problems related to oXygen frameworks/document types.
kmank
Posts: 71

WebHelp Search not working

Wed May 15, 2013 11:46 pm

I have created a webhelp transformation and placed it on our corporate server. For now, everything seems as expected except the Search functionality does not work.

It appears certain js files are not being included in the transformation.
Here is the error log from the server:
[Wed May 15 12:29:59 2013] [error] [client 192.168.119.129] File does not exist: //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide/oxygen-webhelp/search/index-1.js, referer: http://win-77k0a406p89/Help/Iramc/userguide/
[Wed May 15 12:29:59 2013] [error] [client 192.168.119.129] File does not exist: //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide/oxygen-webhelp/search/index-2.js, referer: http://win-77k0a406p89/Help/Iramc/userguide/
[Wed May 15 12:29:59 2013] [error] [client 192.168.119.129] File does not exist: //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide/oxygen-webhelp/search/htmlFileList.js, referer: http://win-77k0a406p89/Help/Iramc/userguide/
[Wed May 15 12:29:59 2013] [error] [client 192.168.119.129] File does not exist: //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide/oxygen-webhelp/search/htmlFileInfoList.js, referer: http://win-77k0a406p89/Help/Iramc/userguide/
[Wed May 15 12:29:59 2013] [error] [client 192.168.119.129] File does not exist: //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide/oxygen-webhelp/search/index-3.js, referer: http://win-77k0a406p89/Help/Iramc/userguide/

I'm not sure where to turn next. Any help is greatly appreciated!
sorin_ristache
Posts: 4144

Re: WebHelp Search not working

Thu May 16, 2013 9:22 am

Hello,

All these specific JavaScript files are needed for search. From the log messages I understand that they do not exist on disk. Is the base directory of the Webhelp deployment //WIN-77K0A406P89/NASTest/Help/IRAMC/userguide? If yes please look for these JavaScript files in the directory where the Webhelp files were generated by the Oxygen Webhelp transformation. Were they created on disk by the Oxygen Webhelp transformation?


Regards,
Sorin
kmank
Posts: 71

Re: WebHelp Search not working

Thu May 16, 2013 11:37 pm

You are correct about the base directory.
I ran a new transformation and searched for the files. The local transformation location is: C:\Dev\out\webhelp
After running a recursive search for *.js from that folder, I received a return of 25 various .js files (most in the location of C:\Dev\out\webhelp\oxygen-webhelp\resources), none of which were the missing files.

Thanks, Sorin, for the help!
sorin_ristache
Posts: 4144

Re: WebHelp Search not working

Fri May 17, 2013 9:17 am

Hello,

It seems the Webhelp pages were not indexed due to an error in the DITA Webgelp transformation. Please post here or send us using the online form the entire content of the Oxygen view called DITA OT which displays the logging messages of the Webhelp transformation. We have to check if there was an error when indexing the output pages. You can copy the content of the view DITA OT by right clicking in the view and selecting the Select All action from the popup menu, then right click again and select the Copy action.


Regards,
Sorin
MMV
Posts: 3

Re: WebHelp Search not working

Mon Mar 06, 2017 11:08 am

Hello,

I ran into the same problem using the DITA OT in Oxygen 16.1

The DITA OT view does not display any error from what I can see, but you can check it for yourself: https://drive.google.com/file/d/0B6QNAc65ZX4PUEVCN204Rjd2dkE/view?usp=sharing (couldn't include it in this message because it was too long).

Also, when I try to click on the search button in the browser, I get this message in the developer console:

Image


I would appreciate any help you can give me.
bogdan_cercelaru
Posts: 188

Re: WebHelp Search not working

Wed Mar 08, 2017 10:05 am

Hello,

I cannot see the message that you get when the "Search" button is pressed.

How are you accessing the generated WebHelp output? Is it loaded from the local file system or from a web server?
If the WebHelp is accessed from the local file system, browser security restrictions could block the search feature.
Also, please make sure that the indexer correctly generated the necessary JS files in the "${OUTPUT_DIR}/oxygen-webhelp/search" ("index-1.js", "index-2.js", "index-3.js").

Regards,
Bogdan
Bogdan Cercelaru
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
MMV
Posts: 3

Re: WebHelp Search not working

Fri Mar 10, 2017 12:49 am

I get the same error whether I try to search the local or the web hosted version of the documentation in both Chrome and Firefox.

The index.js files you mentioned are where they are supposed to be.

Let's try again with the image:
Image


Also, our documentation is publicly available here: http://cwrc.ca/Documentation/public/

Thanks,

Mihaela
bogdan_cercelaru
Posts: 188

Re: WebHelp Search not working

Fri Mar 10, 2017 3:37 pm

Hello,

Please check the file names of the topics linked in the DITA Map. It seems that you have some files that contains quotes (") in their names and it is recommended to avoid this character in a file name.
I've found the following topics that contains quotes in file name:
- Plot-It/Filter by "Event type".html
- DITA_Files-Various_Applications/Plot-It/Filter by "Event type".html

Regards,
Bogdan
Bogdan Cercelaru
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
MMV
Posts: 3

Re: WebHelp Search not working

Mon Mar 13, 2017 10:00 am

It worked! I had to manually clear the destination folders and run the transformation again, since the .js files that contained the error didn't update when I run the transformation and let the XSLT in the DITA OT to replace the output for the changed files.


Thanks for all your help.

Return to “SDK-API, Frameworks - Document Types”

Who is online

Users browsing this forum: No registered users and 0 guests