Webhelp refresh

Having trouble installing <oXygen/>? Got a bug to report? Post it all here.
syed
Posts: 49
Joined: Tue Nov 14, 2017 8:34 pm

Webhelp refresh

Post by syed » Mon Jan 13, 2020 7:47 pm

Hello,

The Webhelp output files are hosted on AWS S3 bucket. When we refresh the files, it is observed that the users have to clear the browser cache to view the updates. Is this expected? We use Oxygen Author 21.

I was reading this blog that suggests adding a couple of entries to the meta data of the Webhelp output. Because the blog looks old, can somebody confirm if the suggestion is still valid?

https://blog.oxygenxml.com/2014/06/how- ... pages.html

Thanks...
Syed

ionela
Posts: 319
Joined: Mon Dec 05, 2011 6:08 pm

Re: Webhelp refresh

Post by ionela » Wed Jan 15, 2020 12:51 pm

Hi,

Could you please provide us more details about the context of this problem?
Does this problem occurred after an upgrade of the oXygen XML WebHelp plugin to a new version? Or the problem occurred between two deployments with your customization and the same version of the WebHelp plugin?
Also, could please specify how you include the customizations to the WebHelp Responsive output?

Regards,
Ionela
Ionela Istodor
oXygen XML Editor and Author Support

syed
Posts: 49
Joined: Tue Nov 14, 2017 8:34 pm

Re: Webhelp refresh

Post by syed » Fri Jan 17, 2020 5:14 pm

Hi Ionela,

The Webhelp plugin has not changed. The problem is observed when the content gets updated and deployed.

Can you please elaborate your second question? From what i understood, we have a header, footer, and an .opt file. Here's the list of parameters:

<parameters>
<parameter name="webhelp.show.indexterms.link" value="no" type="string"/>
<parameter name="webhelp.show.main.page.tiles" value="yes"/>
<parameter name="webhelp.show.main.page.toc" value="yes"/>
<parameter name="args.figurelink.style" value="TITLE"/>
<parameter name="args.gen.task.lbl" value="YES"/>
<parameter name="args.tablelink.style" value="TITLE"/>
<parameter name="webhelp.navigation.links" value="no"/>
<parameter name="force-unique" value="yes"/>
<parameter name="webhelp.show.child.links" value="yes"/>
<parameter name="webhelp.fragment.footer" value="/opt/build/git/footer.xml"/>
<parameter name="webhelp.fragment.before.body" value="/opt/build/git/header.xml"/>
<parameter name="webhelp.top.menu.depth" value="3"/>
</parameters>

Here's the URL - https://help.hcltechsw.com/bigfix/9.5/p ... index.html

Syed

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

Re: Webhelp refresh

Post by bogdan_cercelaru » Mon Jan 20, 2020 5:56 pm

Hi,

We thought that you are referring to CSS or JS customization, not to the content that is not updating without clearing your browser cache.
In this case you could use the following meta information to disable cache:

Code: Select all

<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Expires" content="-1" />
but you have to add them using the

Code: Select all

${webhelp.fragment.head}
parameter from the transformation scenario (instead of editing other WebHelp plugin files indicated in the blog post).
Please note that even if you are using the <meta/> elements, any web proxies between the site/server and the user/browser will completely ignore them. You should always use a real HTTP header for headers such as Cache-Control and Pragma.

See also the following topics that explain how the Amazon S3 caching works:
- Why is CloudFront serving outdated content from Amazon S3?
- Managing How Long Content Stays in an Edge Cache (Expiration)

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

syed
Posts: 49
Joined: Tue Nov 14, 2017 8:34 pm

Re: Webhelp refresh

Post by syed » Tue Jan 21, 2020 9:30 am

Thanks Bogdan.

Post Reply