I'd Rather Be Writing » jquery

Madcap Flare’s Extensibility: Adding jQuery to Flare

Tom Johnson — Tue, 26 Jan 2010 15:45:44 +0000

Alistair Christie recently published a podcast about Unscripted Screencasts and Flare Extensibility. In the podcast, he considers whether scripts are necessary for corporate screencasts – a good topic for exploration and testing. But he also gets into something a little more interesting: extending Flare with jQuery.

jQuery is the new Javascript. It provides smooth functionality that shows and hides components, slides objects around, and animates graphics in a sexy way. As an example, ProPhotoBlogs’ support section incorporates jQuery functionality. And the drop-down menus on Will Sansbury’s site are also jQuery driven. Here are a few jQuery animation effects. And slide-down effects. And fade effects.

Alistair says he feels satisfied he made the right choice about adopting Flare as a help tool because of this extensibility. Because of the XML and CSS standards that Flare is built on, Alistair can add a reference to the jQuery script in the header, add functions in the page body and toolbar, and hook into other technologies to customize the display.

For detailed step-by-step instructions on inserting functions into Flare’s Webhelp toolbar, see Alistair’s post, Adding function buttons to to the Madcap Flare Web Toolbar.

I like Flare for much of the same reasons as Alistair. I haven’t integrated jQuery scripts into Flare yet. But knowing that I can do it if I wanted to is encouraging.

The next question is what functionality we’re missing from Webhelp. Is jQuery just the latest gee-whiz, bell-and-whistle technology? Or is it functionality that will persuade users that the help is worthwhile?

Alistair says he created a button that shows a direct link to the topic the user is viewing. And he hooked into a custom glossary database. He also integrated his own show/hide functionality and a bookmarks feature. Granted, some of that functionality already exists to some degree in the existing Webhelp buttons, but Alistair’s company had custom needs.

One button I’ve added to Webhelp is a Contact button that allows the user to send feedback to the project team. I would like to incorporate jQuery scripts to make screencasts pop-up in a modal that dims the background. I’d also like to make screenshots expand to full size when the user clicks them (similar to Flare’s new thumbnail feature). The way graphics slide down smoothly with jQuery is more elegant than the built-in drop-down hotspot functionality Flare provides. (I imagine you have to work in the code view to integrate all of this.)

I’m not sure to what extent other tools can hook into the same technologies. But it is important to have this potential — so that help authors can keep pace with the developments and technologies of the web.

To listen to Alistair Christie’s podcast on extending Flare with jQuery, see Unscripted Screencasts and Flare Extensibility.

Blog Sponsors

What I’ve Been Learning in Flare

Tom Johnson — Sat, 14 Nov 2009 07:41:59 +0000

Right now I’m immersed in an online help project in which I’ve been using Madcap Flare. Here a few tips I’ve picked up in the past month or so.

Embedding Video

To embed video into Flare, you have to insert the video as an image file. As long as the video is a SWF file, it embeds directly on the page. In order to keep the Flash player buttons on the video, use Camtasia Studio’s Express Show format. Express Show packages the Flash player buttons inside the SWF file, without requiring multiple files to play the video.

Note that you have to include the height and width dimensions for the “image” (which is really a video); otherwise, the video will expand to fill the entire browser. Also, the expand-to-full-frame view won’t work inside Flare — not sure why.

With the video embedded, you can easily include the video inside a drop-down hotspot. Just make sure the video is small so that it loads quickly on the page.

Relationship Tables

I’m fascinated by relationship tables. Relationship tables give you one (or more, if desired) tables where you can manage your related links. By adding topics to the same row in the relationship table, the links can become part of the same family. Links in the same family appear on the topic in a reciprocal way. You can also specify other linking options, but the family setting is easiest to maintain.

When I first created my relationship table, I styled its display to appear on the right rather than at the bottom (similar to a sidebar on a webpage). But as I looked at the help from a 1024×768 perspective, I realized that the side display crowded out too much screen real estate (leaving me with about 400 pixels after the TOC). So I moved the relationship table to the bottom of the topic.

In the master page for the project, I also added drop-down hotspot code around the relationship table code so that it would expand when clicked. I think it’s pretty cool looking. Unfortunately the project is behind a firewall and confidential, so I can’t display it without creating Greeked text and dummy screenshots, which I don’t have time to do.

Capture

I’ve been using Flare for 2 years now, and up until last week I turned up my nose at Madcap Capture. I was perfectly happy with Snagit, so why should I bother with a new screen capture tool? Now that I’ve explored and started using Capture, I’m kicking myself for not using it earlier. Capture provides you with several distinct advantages if you’re authoring in Flare:

Shapes you add to an image remain in layers. They aren’t flattened, so you can return later and update any callout or bubble text on the screen. This is a major advantage. You can also add variables and conditional text in the callouts if necessary.
You can add nice-looking callouts and bubble captions to the images. The bubbles are vectors, so they resize nicely. You can also choose to round the corners of the callout handle in a cool way. Previously, I inserted my callouts into numbered figure captions below the image. But in browsing Madcap’s help, I realized that I was drawn to the visual experience of the caption bubble directly on the image, with its handle pointing to a specific spot that the caption explains.
Capture integrates nicely with Flare. You can initiate a screen capture from within Flare, and the image is inserted at your cursor’s position. If you initiate the screen capture from Capture, it saves the image directly into your Flare project’s Resources > Images folder (as long as you indicate that path in your Capture profile). To edit the image file, just right click the image and choose to edit it in Capture. Every aspect of the image is still editable.

Capture is robust and I’m still learning how to use it. I like to take 800 x 400 pixel screenshots and resize them to 75%. You can do this by setting your background scale to .75 and your canvas crop settings to 600 x 300 in your profile. When you add a caption bubble to the screenshot, the text in the caption retains its regular size (as long as you take the screenshot with your profile that has the background scale setting). Because the text isn’t resized, it doesn’t lose crispness. By the way, it’s nice having Doc-Guy, a Flare trainer, on our team. He gave me that last tip.

Exporting to DITA, Importing to WordPress

I’ve been fixed on the idea of authoring in Flare, exporting to DITA, and importing into WordPress using a DITA Import WordPress plugin. I finally set up a test site to do that on a secure server at work. It actually did import decently. Beyond that import, though, I haven’t done much with the idea. (The test server is the only server with the PHP/MySQL technical setup that I can publish to at work, so that’s also an obstacle.)

It’s cool that Flare is starting to handle DITA, and I know the intent is to import to DITA, not export to DITA. But sometimes when you have your content in DITA, you have more options for manipulating it.

Thumbnails

Flare now has the option to resize images as thumbnails. But not just any little thumbnails. When you move your mouse over the thumbnail, the image resizes with a lightbox effect — the background dims and the resized image seems to pop out at you.

I’m not sure how I’ll use thumbnails, but it’s a neat option that Flare now has. It might be useful in release notes, where you’re explaining a lot of new features but you don’t want to include full-size images everywhere. Or it could be useful if you’re writing a post in Sarah Maddox style, or if you have narrow columns without much room for full images.

Future Experimentations

Flare is a robust tool with a lot to learn. One thing I’d like to experiment with is incorporating jQuery effects into the topics. This ProPhotoBlogs support site seems to use a ton of jQuery. If you’re using jQuery in Flare, I’d like to hear from you. Or if you have other insider tips and tricks with Flare, I’d also like to hear about them as well.

I'd Rather Be Writing » jquery

Madcap Flare’s Extensibility: Adding jQuery to Flare

Blog Sponsors

What I’ve Been Learning in Flare

Embedding Video

Relationship Tables

Capture

Exporting to DITA, Importing to WordPress

Thumbnails

Future Experimentations

Blog Sponsors

Plugins | jQuery Plugins

Blog Sponsors

Top 14 jQuery Photo Slideshow / Gallery Plugins | Chicago Web Design

Blog Sponsors