Tech Write Tips

July 11, 2006

Best Practice: Flare 2 – Automated Themed Topic Types

Filed under: Best Practice,Future-proofing,Information Types,Madcap Flare — AndyR @ 12:38 pm

As we suggested in our previous topic types post, to ensure you are ready for future help formats it is advisable that your topics provide information in clearly defeind types. This post considers how you can present these topics in an HTMLHelp in such a way that it is clear what sort of information is being communication.

Topic Titles
The first step in this task is to ensure that you have consistently named your topics, as we discussed in our delicious topic title post. You need to define a set of rules that specifies how you name your topics and then stick to it.

One rule could be to always title concept topics ‘Concepts:…’. Another might be to always include the control type in your software screen focused topics, for example ‘Select Window’, ‘Open Frame’ or ‘Close Tool’.

Dynamic Header
The next step is to include a .js file in your Flare project to output content at the top of your topic. It is advisable for this to be directly after the <Body> tag, and referenced as follows:

<script language=”JavaScript1.2″ type=”text/javascript” src=”Head.js” mce_src=”Head.js”></script>

Detect Topic Type
This head.js javascript then need to interrogate the title of the html file, (document.title) then check it:

  1. If it contains concepts, then output a concept header.
  2. If it contains Window, Frame etc, then output a software control header.
  3. Otherwise output a procedural header.

The content of the header will need to be output with the following javascript:

document.write(‘<H1 class=”topic_type1″>’+document.title + ‘</H1>’)

In this example we are using the heading one class to apply the format, which is controlled in our .css file in flare. This can make use of colours and icons to make it clear what sort of information is being provided.

The beauty of this approach is that should you need to change the criteria or the look and feel of each topic, you simply update your one .js file.

Advertisements

5 Comments »

  1. What advantages would this would have over just having a separate CSS for each type of topic?

    Comment by Dave — March 7, 2007 @ 10:59 am | Reply

  2. I think having a CSS for each topic is an interesting idea and would have benefits of its own.

    The dynamic header javascript approach has the benefit of automatically detecting the type of topic from the document title. This both saves time (and avoids mistakes) applying the correct style, and also enables you to split up your topics into different types in the future by changing the tone .js file.

    Perhaps a combination of the two approaches would be ideal. Applying a css style to the heading based on the document title.

    Comment by AndyR — March 15, 2007 @ 10:22 am | Reply

  3. Hello! I am Anna, Russian porn star. I like group sex, anal end lesbians.
    Download FREE my erotic end very good porn videos – this link

    Comment by RussianSexiGirls — October 10, 2007 @ 7:36 pm | Reply

  4. wtrwtwtwt

    Comment by maha — October 11, 2007 @ 6:17 am | Reply

  5. very nice

    Comment by maha — October 11, 2007 @ 6:18 am | Reply


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Create a free website or blog at WordPress.com.

%d bloggers like this: