Touch of style - identify different apps in one help file

This forum is for all Flare issues not related to any of the other categories.
Post Reply
Cinnamon
Sr. Propeller Head
Posts: 125
Joined: Wed Sep 10, 2008 8:42 am

Touch of style - identify different apps in one help file

Post by Cinnamon »

Hi everyone
I used to have a single Flare project that compiled five CHM files, one for each of our applications.
These applications are used at different stages of a workflow and I think it would be better if the help was in one single target (this time WebHelp on the client's PC). This would let me talk about the workflow instead of things feeling so detached. However, each application would have to be clearly identified - and there's my problem.
What would be the best way to highlight that a particular instruction was for a particular application? Some topics will be used in more than one application (like connecting to the database, for example), so using color isn't going to work.
I've thought about using icons for each application and crossing out the ones that don't apply, but then I think that could be difficult to maintain and test. I thought I could list the applications at the start of each topic, but that might look horrible.
I wondered if you had any ideas or know an example where this has been done well that wouldn't be too difficult to maintain.
I'd appreciate any thoughts on this.
Many thanks

Suze
GregStenhouse
Sr. Propeller Head
Posts: 330
Joined: Tue May 13, 2008 3:27 pm
Location: Christchurch, New Zealand

Re: Touch of style - identify different apps in one help file

Post by GregStenhouse »

I think listing at the top would be OK, maybe try a look like breadcrumbs (i.e. listing the applications across rather than down, and a smaller font with a border under)

Applies to: App1, App2, App5
-----------------------------
<H1>Connecting to a database</H1>
Cinnamon
Sr. Propeller Head
Posts: 125
Joined: Wed Sep 10, 2008 8:42 am

Re: Touch of style - identify different apps in one help file

Post by Cinnamon »

Hi Greg
I like that idea. I hadn't thought of putting text above the <h1> tag. I'll give that a try.
Thank you.

Suze
Cinnamon
Sr. Propeller Head
Posts: 125
Joined: Wed Sep 10, 2008 8:42 am

Re: Touch of style - identify different apps in one help file

Post by Cinnamon »

Hi folks
Just an update on how I got on with Greg's idea and a quick request for ideas on the finishing touch.
I created a snippet "Applies to the following applications: App1 App2 App3 App4 App5", and added that to the topic template. Then I planned to convert it to text and edit the list as required.
Then, this morning, I grew a brain :D , and realised that I should use conditional snippets instead of messing around with the snippet. I've added conditions for each app and will select the snippet conditions in each topic instead of editing the original snippet. This seems to be working very well.
The finishing touch would be to include commas when multiple applications are referenced and no commas when there's just one. If anyone has ideas on that I'd be very grateful.
Hope you all have an great weekend (and that the folks moving their clocks enjoy their extra hour).
Many thanks

Suze
KevinDAmery
Propellus Maximus
Posts: 1985
Joined: Tue Jan 23, 2007 8:18 am
Location: Darn, I knew I was around here somewhere...

Re: Touch of style - identify different apps in one help file

Post by KevinDAmery »

Another thing that may help is to use a different master page / page layout for the topics depending on which app they apply to. Instructions on how to set this up are in this KB article:

http://kb.madcapsoftware.com/Content/Fl ... roject.htm

I do this here to identify which area of our application the topic pertains to - the different master pages each have a banner along the top that identifies the area, and the topic title appears below the banner.
Until next time....
Image
Kevin Amery
Certified MAD for Flare
Cinnamon
Sr. Propeller Head
Posts: 125
Joined: Wed Sep 10, 2008 8:42 am

Re: Touch of style - identify different apps in one help file

Post by Cinnamon »

Thanks Kevin.
I think that would be fine if only one application was assigned to each topic, however I'll usually have two or three.
I think your suggestion would be much neater! It could be a good solution for some other things I want to look at later. I'll give a try.
Many thanks

Suze
Post Reply