Tech Write Tips

October 27, 2006

Flare 8 – XML Editor

Filed under: Madcap Flare,Navigation,Technology,Tip — AndyR @ 12:20 pm

Now that I’m getting more at home with Flare’s XML editor, and things are holding together better, and performing a lot faster, I thought it would be useful to give a run down of some the of intricacies.

The following are useful in the non-tag view:

Red control box: Appears when you highlight a section of text. Hover to expand, then left click to access the quick copy and paste menu.


Yellow control box: Appears at the start of a tag section. Hover to expand, then left click to access the advanced tag editing menu.


Tag Start: Cursor signifies the start of a xhtml tag.


Tag Middle: Cursor signifies you are within an xhtml tag and can edit the contents.


Tag End: Cursor signifies the end of a xhtml tag.


Tag Between: Cursor signifies you are between tags. Type to enter text into the parent tag.


Tag Before – Level 1: Cursor size signifies you are in the first of a series of nested tags.


Tag Before – Level 2: Cursor size signifies you are in the second of a series of nested tags.


Tag Before – Level 3: Cursor size signifies you are in the third of a series of nested tags.


There we have it. Hopefully these details will de-mysitfy this great little editor. I just need to talk mouse pointers now.

February 14, 2006

Best Practices: Delicious Topic Name

Filed under: Best Practice,Information Types,Navigation — AndyR @ 1:06 pm

DeliciousTopic titles, you can’t live with them, you can’t live without them. But these little text strings sitting incongruously at the top of our topics have an untapped power to enable users greater access to the information contained within.It wasn’t until I was recently using that I saw how key topic titles are to accessing information in helps. If you haven’t come across it yet, “ is a social bookmarks manager. It allows you to easily add sites you like to your personal collection of links, to categorize those sites with keywords.” It has had a meteoric rise to fame the past year.

This popularity is due to the power of this categorisation. The keywords associated with each bookmark enable incredibly powerful and flexible searching. This is something we can learn from for our helps. When users are searching for topics they do a keyword search and are presented with a list of topic titles. We have the oportunity of making these titles much richer by considering them as a series of “tags” that categorise the topic content, similarly to the bookmark “tags” in employing a strict naming convention to your topic titles, you can signpost key information to your users. To achieve this, you need to do some work on the type of information that you are going to include in your help. For example, you may include topics about Dialogs, Procedures and Concepts. Here are you first three “tags”.

Next consider each of these categories of topics and consider the types of information provided in each. For example, your procedure topics may contain information about creating New records, Editing, Deleting and Copying existings record. Htere are you next subset of “tags”.

Once you have completed this for all the types of topics in your help you will have a list of tags from which to compile topic headings for each topic.

The results is a help with strictly named topics, always using the same keywords (or “tag”) to identify the information it contains.

Although this may seem trivial (and not a million miles from what we would naturally do anyway), the application from an absolutely strict set of titles means that the user always has the same textual clues when searching for information.

Additionally, this approach prepares us for distinct topic categorisation as required by DITA and MAML. We can also make use of these categories to style topics differently for each type of information, providing further visual clues about the topic.

Finally, this also enables us to use topic titles if we want to generate a set of see also topics using some scripting technology.


Create a free website or blog at