Technically Speaking

When you are writing content in Flare, you may decide that you want to re-use some content that you previously added to another topic.

We’ve discussed before how the best way to do this is to use a snippet, which essentially is a really long, formatted variable.

To do this in Flare, you create a new snippet, then you locate the text you want to re-use, and copy the text out of that topic and paste it into the snippet. Then you replace the text in the original topic with the snippet, then insert the snippet into the new location.

This isn’t too hard, but I’ve long wanted to use a nifty shortcut, but couldn’t figure out how to make it work. See, when you are writing in the XML editor, there is an option on the context menu (right-click) menu that allows you to create a snippet from an existing block. That works great if all you want to add to the snippet is a single paragraph, but it doesn’t work if you want to add multiple block-level elements into the snippet.

Today I thought of a way to do this quickly and easily, even with multiple blocks.

Here is what you do.

1. Open the topic that contains the text that you want to turn into a snippet.
2. Select the blocks that you want to re-use.
3. From the Format menu, select Group.
4. From the pop-up, select the div option. (This groups the selected content into a single block, the DIV block.)
5. Now, right click on the DIV block, and select “Create Snippet”.
6. Give the snippet a name and click the Create button. The snippet is created and inserted into the original topic
7. Go to your new topic and insert the snippet into it.

If you are creating Word or Framemaker output, you may need to change one additional thing:

1. Right click on the snippet block, and select “Open Link”. The snippet file itself opens.
2. Right click on the div block, and from the Edit menu, select “Unbind”.

This removes the div, which can cause positioning problems in Word and Framemaker outputs. (I don’t actually know if you NEED to do this extra step, but it isn’t a bad idea.)

Using a div to create a snippet is much faster, in my opinion, when you are trying to create a snippet from a multi-block selection. Try it, and I think you’ll agree.

—–

(This article has been cross-posted on DocGuy Training.)

If you’ve been following my blog recently, you’re already aware that I’ve received MadCap Certified Instructor status from MadSkills, the MadCap-owned company that provides training on MadCap products. I created a company for my consulting and writing work (I’m currently in the process of writing several books on Flare). Thus, I’m pleased to announce my company’s new website, docguytraining.com.

DocGuy Training’s website will give you tips and tricks on using MadCap products, as well as info on  my upcoming MadCap books. It is where I will discuss training events and other help-authoring tool information.

When you go to the website, you’ll see several different sections. The website is powered by wordpress, and each of the different sections show the most recent post(s) in a specific category. The bottom of the site has a link to the site’s feed; when you subscribe to the feed, you subscribe to posts from all categories, so you’ll be caught up on the latest information, if that is the route you want to go.

Don’t worry that I’m abandoning this site. I’ll still use Technically Speaking to cover lots of general technical writing information, and I’ll occasionally cross post informaiton on both sites.

Come check out my new digs at docguytraining.com and let me know what you think!

I just got the following e-mail from MadCap Software today, encouraging me to purchase Flare. Check out the second link in the message. That made me laugh:

Hi Paul,

I hope all is well.

As a current Flare user, I thought you would be interested in learning that we have just released Flare v4.0 and Blaze v1.0! Blaze is our new print-only solution, while Flare remains the premier tool for printed document and web help authoring. I encourage you to download the new trials and give them a spin: http://www.madcapsoftware.com/downloads/

In addition, please visit this site for a blog article with great insight on Flare 4 you may enjoy: http://blog.paulpehrson.com/2008/09/02/madcap-flare-4-preview/

Finally, and the last link I swear – a newly recorded demo by V.P. Mike Hamilton about the new features in Flare V4: : http://www.madcapsoftware.com/training/demos/flareV4Signup.aspx

[...]

Let me know if you would like additional details or if there is anything that comes up that I can assist with. I look forward to hearing from you.

Best regards,
[MadCap Representative]

Pretty cool, eh?

This post is for recovering Frame users who have switched to Flare, or users of Frame who are authoring in Frame, but are publishing with Flare.

I’m working on a book that will address importing projects from FrameMaker to Flare/Blaze, and I’d like to get your input on what struggles you had when you were (or when you are) importing Frame files into Flare so that I can address these trouble areas specifically.

Anybody who sends an idea that I use will get acknowledged in the book, and I’ll be sending out two free copies of the completed book to randomly-selected people whose contributions I use.

I’m not a MadCap employee; just an aficionado, so there are no restrictions on who can send me information, or who can win the free copies.

Anything you submit becomes my property to use (or not use) in the book, but I do promise attribution for anything I use.

Please send submit your comments via my website’s contact form. Please use the subject “BOOK SUGGESTION”; that will ensure your submission doesn’t get filtered to my spam box.

Thanks for your help.

Speaking of Flare 4, Tom Johnson is giving away a free copy of Flare 4 (full version, retail value near $900). To enter, all you have to do is leave a comment on his giveaway post.

Good Luck!