Highlighted

Using a script to display product-specific content

Explorer ,
May 18, 2016

Copy link to clipboard

Copied

Dear RH experts,

I'm creating an HTML5 Help system for a web-based software application that has two versions: Cloud and On-premise. The Help systems will have some shared content and some product-specific content. I could set conditions on the topics and generate two separate Help systems. But my developers would like a more elegant solution. They don't want duplicated content. Instead, they want a single output, and they want to use scripts and tags in topics to identify content that should be displayed or hidden dynamically, depending on the product version. The script would run when the Help system is launched, and the appropriate content would be displayed based on the tags.

Does anyone know how to do this?

Would this have any implications for Search? For example, would search results include items that are hidden based on tags and scripts?

Thank you!

-Kate

Environment:

RH 2015 on Windows 7

Content in FrameMaker

Just another thought: If you enable filters, you can HIDE the filter selector from the sidebar. That way, your readers won't be able to change the filter conditions themselves.

Topics

HTML5 layout

Views

227

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more

Using a script to display product-specific content

Explorer ,
May 18, 2016

Copy link to clipboard

Copied

Dear RH experts,

I'm creating an HTML5 Help system for a web-based software application that has two versions: Cloud and On-premise. The Help systems will have some shared content and some product-specific content. I could set conditions on the topics and generate two separate Help systems. But my developers would like a more elegant solution. They don't want duplicated content. Instead, they want a single output, and they want to use scripts and tags in topics to identify content that should be displayed or hidden dynamically, depending on the product version. The script would run when the Help system is launched, and the appropriate content would be displayed based on the tags.

Does anyone know how to do this?

Would this have any implications for Search? For example, would search results include items that are hidden based on tags and scripts?

Thank you!

-Kate

Environment:

RH 2015 on Windows 7

Content in FrameMaker

Just another thought: If you enable filters, you can HIDE the filter selector from the sidebar. That way, your readers won't be able to change the filter conditions themselves.

Topics

HTML5 layout

Views

228

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Adobe Community Professional ,
May 19, 2016

Copy link to clipboard

Copied

I'm not quite sure how it would work with Fm as your source but in RoboHelp with the use of Build Expressions and Tags you can create Dynamic Filtered Content. That is described in the Employee Care 3 topic with a small demo output. The Travel the Whirls demo has a more complex output.

That would create one output and users would have the option to filter content according to their requirements. I believe Willam van Weelden has already covered how your developers can call that help so that one of the filters is already applied. Note though that the user could then change the filter so that may not be quite what you want. It is, however, as near as you can get to what you want from one output without using RoboHelp Server. There I believe you can restrict topics in the way you want. That assumes your users can view the source from the same server and you are OK with the extra cost.

The search and so on would be based on the filters applied (or not) at the time of the search.


See www.grainge.org for RoboHelp and Authoring information

@petergrainge

www.grainge.org for free RoboHelp & Authoring info. Use the blue Reply button at the top to help me help you.
The black Reply link nests replies and they sort out of order.

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...
LEGEND ,
May 19, 2016

Copy link to clipboard

Copied

The FM output works the same as the RoboHelp output, so you're save with the Dynamic Filters. Just apply the tags in FM and set up the filter in the publishing pod.

Point your developer to this page for more info on calling the help and setting the filters: https://www.wvanweelden.eu/articles/context-sensitivity-responsive-and-multiscreen-html5

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...
LEGEND ,
May 19, 2016

Copy link to clipboard

Copied

Just another thought: If you enable filters, you can HIDE the filter selector from the sidebar. That way, your readers won't be able to change the filter conditions themselves.

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...
Explorer ,
May 19, 2016

Copy link to clipboard

Copied

This is awesome! Exactly what I needed. Thank you so much

One last question: how do you hide the filter selector from the sidebar? We don't want users to change the filter.

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...
LEGEND ,
May 21, 2016

Copy link to clipboard

Copied

You set this in the Screen Layout settings. Find the Screen Layout and choose to edit it. In the section Basic settings, set Show Filter to false. The filter will be available in the output, but the filter selection is hidden.

layout-customisation.png

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...