How to embed webhelp output within another site

ann.jensen
Posts: 230
Joined: Wed Jun 17, 2015 10:19 am

How to embed webhelp output within another site

Post by ann.jensen » Thu Aug 18, 2016 5:59 pm

Hi,
We want to make our system documentation generated using Oxygen Webhelp available to one of our clients. Our client uses one of our client systems with is a VS developed website. Having access control to the system documentation is very important. So the first approach we are considering is piggy backing on the existing access control within the site that they already use.
I have tried the following:
  • Pulling down webhelp site code and rendering it within the existing site...but of course the search functionality is not available.
  • Copying the webhelp-responsive generated output into a folder on the other site and navigating to it but it is not rendering properly and search functionality is not working.
  • Creating a new page on the existing site with an <iframe> and accessing the generated webhelp site from there. This is also rendering properly and search functionality is not working.
Can anyone advise on the best approach to achieving this embedding of Oxygen Webhelp output in another site so as to have some access control?
Thanks in advance,
Ann

bogdan_cercelaru
Posts: 213
Joined: Tue Jul 01, 2014 11:48 am

Re: How to embed webhelp output within another site

Post by bogdan_cercelaru » Fri Aug 19, 2016 2:45 pm

Hello,

I've tested using Oxygen v18.0 (build number 2016081012) and the search worked when the generated WebHelp Responsive were embedded into an iframe using the following code:

Code: Select all

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Embedded WebHelp</title>
<style type="text/css">
html,
body{
width:100%;
height:100%;
overflow: hidden;
margin:0;
padding:0
}
</style>
</head>
<body>
<div style="width:100%; height:10%; text-align: center; background-color: grey">
Your website header
</div>

<iframe src="index.html" style="width:100%;height:90%;border:0"></iframe>

</body>
</html>

In this case the HTML file that embed the WebHelp (iframe.html) is in the same directory as the index.html of the generated WebHelp.
Please check if the WebHelp search works if it is accessed directly from the client server (not embedded in the client website).

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

ann.jensen
Posts: 230
Joined: Wed Jun 17, 2015 10:19 am

Re: How to embed webhelp output within another site

Post by ann.jensen » Fri Aug 19, 2016 4:25 pm

Sorry Bogdan,
I am not sure what you are asking me to do.
What I have done is as follows:
  • I have a visual studio solution locally and I have copied the webhelp output into a folder in aim\web of that VS solution
  • I have run this solution and navigated to index.html of webhelp output in aim\web folder
  • This renders the index.html (almost) but search functionality does not work.
What I have also tried is as follows:
  • I have a visual studio solution locally and I have copied the webhelp output into a folder in aim\web of that VS solution
  • I have create iframe.html as you suggested. Although I am not sure what the benefit of this step.
  • I have run this solution and navigated to iframe.html in aim\web folder
  • This renders the index.html (almost) but search functionality does not work.
Since the crux of my challenge is access control and security, I cannot call out to the webhelp site on another server without adding an access control layer.

Hope this makes sense,
Regards,
Ann

bogdan_cercelaru
Posts: 213
Joined: Tue Jul 01, 2014 11:48 am

Re: How to embed webhelp output within another site

Post by bogdan_cercelaru » Mon Aug 22, 2016 12:38 pm

Hello,

The WebHelp Responsive output was tested within the following scenarios:
- when the output is accessed through one of these Web servers: Apache and IIS
- when the output is accessed directly from the local file system, using the "file://" protocol
The WebHelp Responsive can also be embedded in an iFrame, in the same circumstances.

We don't have any information about your environment and so we cannot offer you support for this particular application.
The search functionality of the WebHelp Responsive requires the JavaScript to be enabled.

Please let us know if you encounter any issue when you are using one of the tested scenarios.

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

Post Reply