Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me

Four Ways Confluence Could Be Better

March 17, 2023 by RDesprez Leave a Comment

Years ago, I used Con­flu­ence and then recent­ly used it again at a client site. I liked it when I first used it but feel dis­ap­point­ed that it does not seem to have evolved. Here are four ways that it could be improved.

What is Confluence?

In case you have not used it, Con­flu­ence is a soft­ware prod­uct that makes it easy to col­lab­o­rate across an enterprise.

Import content from PDFs and Word files

On a past project, I import­ed many old­er Word files and PDFs into Confluence.

The Word and PDF files were very dif­fer­ent from the new tem­plate found in Con­flu­ence so I resort­ed to copy­ing con­tent from the source file to the new tem­plate. Even if I first copied con­tent into a text edi­tor (like Notepad), Con­flu­ence fre­quent­ly changed the fonts or font sizes. Re-apply­ing a para­graph style with­in Con­flu­ence to the word or sen­tence did not fix the issue. For­tu­nate­ly, there’s a workaround.

Con­flu­ence Source Edi­tor is a free app that reveals the code on a giv­en page. If all else fails, you can strip out the extra code that is chang­ing the fonts. 


Using Con­flu­ence Source Edi­tor, I can hone in on a cer­tain word and strip out the code that sur­rounds the font. Here is an example:

By strip­ping out the span text, Con­flu­ence then dis­plays the text nor­mal­ly. As some pages can be rid­dled with this extra code, search­ing for and remov­ing it can quick­ly become tedious. 

My sug­ges­tion: Con­flu­ence should address these for­mat­ting issues so that tech­ni­cal authors do not need to fix con­tent this way. At the very least, this Source Edi­tor should be includ­ed in Con­flu­ence with­out hav­ing to search for and install the app.

Search and replace functionality

I worked for a client that rebrand­ed itself, mean­ing that its old name need­ed to be updat­ed on dozens and dozens of Con­flu­ence pages. For author­ing tools like Mad­Cap Flare, the search fea­ture can eas­i­ly comb through mul­ti­ple topics. 

Con­flu­ence includes a search and replace tool but it’s only for page by page. This means that some­one updat­ing the clien­t’s name needs to open the page, going to edit mode, find an instance of the old name, and replace it. This is a very time con­sum­ing process.

Con­flu­ence does offer apps that will per­mit you to search across mul­ti­ple pages with­in a space but they’re not free and you need to research, pay, and install the one that you’d like.

My sug­ges­tion: Atlass­ian, the com­pa­ny that makes Con­flu­ence, needs to include a free search and replace tool as part of its core prod­uct that can scan mul­ti­ple pages with­in a space.

Weak conditional text support

If you’ve used tools like Mad­Cap Flare, you under­stand the pow­er of con­di­tion­al text, which you allows you to sin­gle-source and include or exclude spe­cif­ic sets of infor­ma­tion. You can apply a con­di­tion to a char­ac­ter, word, sen­tence, para­graph, or entire sec­tions of content.

Con­flu­ence includes a form of con­di­tion­al text sup­port but it’s hard­ly robust. Using an app called Scroll Ver­sions, writ­ers can cre­ate dif­fer­ent ver­sions of con­tent and then asso­ciate the con­tent with a “vari­ant.” If you need to cre­ate three dif­fer­ent ver­sions of a para­graph, you can pub­lish three ver­sions using the Scroll Ver­sions app. The main chal­lenge with the app is that it forces users to pick which ver­sion they want to read using a drop­down in Con­flu­ence. Here’s an exam­ple in which a user might select among mul­ti­ple prod­uct versions:

My ver­dict: Although it’s bet­ter than noth­ing, Con­flu­ence’s sup­port is pret­ty weak com­pared to Mad­Cap Flare or oth­er tech­ni­cal writ­ing tools.

No built-in support for variables

In case you haven’t used vari­ables, here’s a def­i­n­i­tion from Mad­Cap’s online help: “Vari­ables are brief, non-for­mat­ted pieces of con­tent (such as the name of your company’s prod­uct or phone num­ber) that can be edit­ed in one place but used in many places…” If you need to update the vari­able, you only need to change it in one place and the change is auto­mat­i­cal­ly made every­where the vari­able appears.

Prod­uct names, cor­po­rate address­es, sup­port phone num­bers all tend to change from time to time. Using vari­ables makes a change super easy. There is an app called Easy Con­flu­ence Vari­ables that may pro­vide some of this func­tion­al­i­ty, although I haven’t had a chance to use it.

I like Con­flu­ence. But if tech­ni­cal writ­ers are going to embrace the tool, Atlass­ian needs to invest more effort in improv­ing it. Besides Con­flu­ence, are there oth­er wikis worth investigating?

Filed Under: Career Development, Help Authoring Tools, Online Writing, Professional Development, Robert Desprez | Vancouver technical writer | Blog Tagged With: Confluence, Madcap Flare, online writing, wikis

First impressions of MadCap’s purchase of IXIASOFT

March 8, 2023 by RDesprez 2 Comments

Mad­Cap Soft­ware’s pur­chase of IXIASOFT makes sense to me as it broad­ens Mad­Cap’s offerings.

I like Mad­Cap Flare and have rec­om­mend­ed it to a few clients over the years. While Flare already uses an XML-based archi­tec­ture, I have nev­er seen it used with Dar­win Infor­ma­tion Typ­ing Archi­tec­ture (DITA). By buy­ing Mon­tre­al-based IXIASOFT, Mad­Cap broad­ens its offerings—it now can sell a com­po­nent con­tent man­age­ment solu­tion that is based on the DITA standard.

It also shakes things up for Mad­Cap. I’ve heard from a few writ­ers and man­agers that Flare is start­ing to feel “dat­ed.” One client I worked with won­dered whether it should be offered as a soft­ware as a ser­vice (Saas). Even with reg­u­lar updates to the soft­ware, the first ver­sion of the soft­ware is more than 15 years old. One of Mad­Cap’s co-founders over­saw the devel­op­ment for Robo­Help, anoth­er help author­ing tool that start­ed in 1992. 

I would like to see a com­pa­ny like Mad­Cap fur­ther broad­en its soft­ware by offer­ing a superb wiki-based solu­tion that a team of writ­ers could use in an orga­ni­za­tion. Ide­al­ly, it would be a wiki devel­oped to han­dle com­plex tech­ni­cal documentation—with sup­port for con­di­tions, vari­ables, and snip­pets. In my opin­ion, it would stand out in the mar­ket­place. I recent­ly used Con­flu­ence again and was dis­ap­point­ed how lit­tle it seems to have evolved since I last used it years ago. 

In sum­ma­ry, I can see why Mad­Cap acquired IXIASOFT. Do you agree with my quick assess­ment? Are there oth­er author­ing tools you would like to see developed?

Filed Under: Help Authoring Tools, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: DITA, Madcap Flare, xiasoft

Adding Conditions to Microcontent in MadCap Flare 2020

May 30, 2020 by RDesprez Leave a Comment

Mad­Cap Flare 2020 adds improve­ments to its micro­con­tent fea­ture by sup­port­ing conditions.

In this blog post, I delve into the enhance­ments and pro­vide step-by-step instruc­tions on how you can mar­ry micro­con­tent with con­di­tions. Flare recent­ly cre­at­ed a post on some of the micro­con­tent improve­ments in the lat­est release of the soft­ware; this blog pro­vides addi­tion­al details.

What is microcontent?

Accord­ing to Flare’s online help, “Micro con­tent is short, con­cise infor­ma­tion that stands alone and is eas­i­ly con­sum­able.” Com­mon ways to use micro­con­tent in Flare include build­ing FAQs, work­ing with chat­bots, and adding micro­con­tent to search results. In this blog post, I explain how to add micro­con­tent in Mad­Cap Flare 2020 to your online help search results.

What does microcontent look like?

If you search for cer­tain terms, such as “con­di­tions” in Mad­Cap Flare’s online help, you see exam­ples of microcontent.

For years, Google has used the same par­a­digm. For exam­ple, type “how to pow­er wash” (I just bought a pow­er wash­er) and the search engine dis­plays a sum­ma­ry of the steps with­out me even hav­ing to click a website.

Add microcontent in Flare

First, I draft­ed a top­ic called “Adding Vari­ables” that includes five steps and two screen cap­tures. I con­di­tion­al­ized the images so they only appear in the topic.

I con­di­tion­al­ized the images with the Top­i­cOn­ly tag (I assume that you know how to con­di­tion­al­ize con­tent in Flare). This top­ic serves as the mas­ter for the microcontent.

To re-use the top­ic as microcontent:

  1. In Flare, click the Con­tent Explorer.
  2. Under Resources, click Micro­Con­tent.
  3. Right-click the Micro­Con­tent fold­er and select New > Micro Con­tent.
  4. In the Add File dia­log box, type a new name for your micro­con­tent in the File Name field and click Add.
  5. In the Micro­con­tent edi­tor, click the Add a phrase icon.
  6. Type a phrase for the micro­con­tent, such as “Vari­ables.” Phras­es are the key­words that you think users will type in the help’s search field when look­ing for a cer­tain topic.
  7. Option­al­ly, you can type alter­nate phras­es for the top­ic (for exam­ple, “Adding Vari­ables,” “Using Vari­ables,” and so on).
  8. Right-click the phrase(s) and select Add Link.
  9. In the Select File dia­log box, link the phrase to a top­ic (I linked my phrase to the Adding Vari­ables top­ic that I recent­ly cre­at­ed) and click OK.
  10. Right-click the phrase you added and select Prop­er­ties.
  11. Click Micro Con­tent Con­di­tions.
  12. In the list of Tags, select Default.TopicOnly and click Exclude. This step excludes the images that I added in the orig­i­nal help top­ic so they do not appear in the microcontent.
  13. Save your project.
  14. Gen­er­ate your help.

View the search results with microcontent

When users type the phrase “Vari­ables” in the search field, they see micro­con­tent that is based on the top­ic but does not dis­play any images as we con­di­tion­al­ized them to not dis­play. We are try­ing to just dis­play crit­i­cal con­tent in a con­cise way. Here’s an example:

Of course, the full top­ic is also avail­able in the help includ­ing the images.

Why is this a welcome improvement?

This enhance­ment is a worth­while devel­op­ment as you can re-use exist­ing top­ics and opti­mize the con­tent so it’s ide­al­ly suit­ed for micro­con­tent. For depart­ments who are already using micro­con­tent, this fea­ture is a wel­come addition.

Filed Under: Help Authoring Tools, Online Writing, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: conditions, Madcap Flare, microcontent, single-sourcing

Embedding Fonts in EPUB Files

October 21, 2015 by RDesprez Leave a Comment

New­er Help Author­ing Tools such as Robo­Help (2015 release) and Mad­Cap Flare make it eas­i­er to embed fonts in EPUB files. This blog entry pro­vides step-by-step instruc­tions on how to embed fonts in Robo­Help (2015 release).

Some Basics

An EPUB doc­u­ment is a zip file with the .epub exten­sion. EPUB files can be read using e‑reader soft­ware on many devices includ­ing the iPad, iPhone, PCs, and smart­phones run­ning on Android. There are many types of e‑reader pro­grams. For this blog post, I down­loaded and installed Adobe Dig­i­tal Edi­tions on my computer.

For tech­ni­cal writ­ers, I believe EPUB files are one of the tech­nolo­gies to watch. The iBooks book­store sells its e‑books in an EPUB file for­mat. With tablets and smart­phones out­selling PCs, users are increas­ingly read­ing content—including tech­ni­cal communications—on these devices. Help Author­ing Tools also make it easy to cre­ate EPUB files.

One of the key advan­tages of an EPUB file is its abil­i­ty to reflow on dif­fer­ent devices.  The fol­low­ing image shows how an EPUB file appears on an iPad:

EPUB file shown on an iPad

The next screen shot shows how the same file appears on an iPhone:

EPUB on an iPhone

In con­trast, a PDF file may look beau­ti­ful on your 24-inch mon­i­tor at home but is dif­fi­cult to read on your smartphone.

Why Embed Fonts?

There may be times when you want to embed a font into your EPUB file to give a doc­u­ment a cus­tom look. If you are going to add cus­tom fonts to an EPUB file, you need to embed the font.  Oth­er­wise, some—or all—users will see the doc­u­ment dif­fer­ent­ly than you envisioned.

The fol­low­ing screen shot shows how an embed­ded font (called “Quin­tes­sen­tial”) appears on an iPad. With­out embed­ding the font, the user may see it in Ari­al (or anoth­er font), due to a font substitution.

embedding fonts

Embedding Fonts in the Past

In the past, if you want­ed to embed a font in a EPUB file, you first need­ed to down­load a font from a site such as Google Web­Fonts, unzip the fold­ers inside an EPUB file, add the font to the cor­rect fold­er, and change your Cas­cad­ing Style Sheet (CSS) so that fonts would appear prop­er­ly. The process was not dif­fi­cult but sus­cep­ti­ble to errors. If you did not down­load the font to the cor­rect fold­er in your EPUB project, the font would not appear prop­er­ly. If you made a mis­take typ­ing some code into a CSS file—even for­get­ting to add a “;”—your font would not be prop­er­ly embedded.

Embedding Fonts is Much Easier Now

Thank­ful­ly, in new­er Help Author­ing Tools, embed­ding fonts is much easier.

Downloading the Font

To down­load the font:

  1. Vis­it a site such as Google WebFonts.
  2. Find a font that you like.
  3. Down­load and install it on your com­put­er that is run­ning Robo­Help (2015).

Adding a Custom Font to your EPUB File

In your Robo­Help (2015) project, make a deci­sion where you want to use cus­tom fonts. For instance, you may decide that all Nor­mal text should use a cus­tom font.

To add a cus­tom font:

  1. Select the text in which you want to apply a cus­tom font.
  2. Select the Edit menu.
  3. In the rib­bon, select Edit Stylesheet.
  4. In the For­mat­ting sec­tion, select the font you want to use from the Font drop­down list. Click OK.

Style_dialog_box_font

To embed a font in Robo­Help (2015 release):

  1. In the Out­put menu, click eBook.
  2. In the eBook Set­tings dia­log box, select Con­tent.
  3. Select the Embed Fonts check box.

Embedding_fonts_RoboHelp

  1. Click Man­age.
  2. In the Embed Fonts dia­log box, select a font that you want to embed, click the Add but­ton, and click OK.

embed fonts_dialog

  1. Click Save and Gen­er­ate.
  2. In the dia­log box that appears, click View Result.

The e‑reader soft­ware (in this case, Adobe Dig­i­tal Edi­tions) dis­plays the embed­ded font.

Embedded_font_EPUB

New ver­sions of Help Author­ing Tools have made embed­ding fonts in EPUB files much simpler.

Filed Under: Career Development, Help Authoring Tools, Robert Desprez | Vancouver technical writer | Blog Tagged With: embedded fonts, EPUB, Madcap Flare, RoboHelp

Would Faceted Search Assist Your Users?

October 10, 2011 by RDesprez 1 Comment

Google’s search engine pars­es through mil­lions of web pages and still deliv­ers amaz­ing search results.

Still, even Google’s search algo­rithm has its lim­its. With more and more web con­tent avail­able every day, you can see why Google offered addi­tion­al fil­ters to help you nar­row your search results. For exam­ple, if you’re look­ing for pic­tures of pump­kins, you can type “pump­kins” in the search field and click Images. Alter­na­tive­ly, if you’re inter­est­ed in the lat­est books about Thanks­giv­ing, you can search for that term and click Books.

Com­pa­nies, such as Dell, have used this technique—called faceted search—for some time.  For exam­ple, on Dell’s web site you can search for a lap­top or desk­top com­put­er. Alter­na­tive­ly, you can use the fil­ters to help you search by prod­uct cat­e­go­ry, proces­sor, screen size, weight, and so on.

For users, this pro­vides a lot of ben­e­fits includ­ing the abil­i­ty to be much more spe­cif­ic when look­ing for cer­tain types of content.

Faceted Search and Tech­ni­cal Communication

There has not been a lot of dis­cus­sion about faceted search and tech­ni­cal com­mu­ni­ca­tion. I believe that if your help sys­tem is large (for exam­ple, more than 500 top­ics), a faceted search could help your users search by top­ic type (such as trou­bleshoot­ing con­tent, pro­ce­dures, and con­cep­tu­al mate­r­i­al), train­ing vs. tech­ni­cal com­mu­ni­ca­tion con­tent, HTML ver­sus PDF guides, and so on.

There are, how­ev­er, a few prob­lems with using faceted search with the cur­rent Help Author­ing Tools.

First, most Help Author­ing Tools don’t offer faceted search. So unless you’re using a tool that does offer the func­tion­al­i­ty, you won’t be able to pro­vide it to your users. It’s worth men­tion­ing that Mad­Cap Flare does offer a form of faceted search in its product.

Sec­ond, in my expe­ri­ence, the search in Help Author­ing Tools isn’t great. For many years, Google’s search engine has set the stan­dard for find­ing con­tent online. In con­trast, the out-of-the box search found in a Help Author­ing Tool is mediocre.

Third, I find it’s hard to cus­tomize the search engine in a Help Author­ing Tool. RoboHelp’s search does allow you to tweak con­tent but the last time I looked into it, the search engine is large­ly a black box that isn’t meant to be sig­nif­i­cant­ly customized.

What do you think? Would faceted search help your users? Should it be it avail­able in all Help Author­ing Tools?

Filed Under: Help Authoring Tools, Robert Desprez | Vancouver technical writer | Blog Tagged With: faceted search, Help Authoring Tools, Madcap Flare, RoboHelp, Search engines

About Robert Desprez

I have worked as a Vancouver technical writer for more than 20 years, working at some of British Columbia's largest high-tech firms. I have served in leadership positions for the Society for Technical Communication and have worked as a writing instructor at Vancouver's Simon Fraser University.

Robert Desprez Follow 1,144 238

Vancouver Technical Writer. Former Instructor at Simon Fraser University. Dog Lover. Coffee Drinker. Tennis and Piano Player.

robert_desprez
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 May 1918126029463536113

This productivity poison is exhausting you /via @globeandmail

Image for twitter card

This productivity poison is exhausting you

Constantly shifting your attention undermines what is your super power in most knowledge jobs. How you anticipate an...

www.theglobeandmail.com

Reply on Twitter 1918126029463536113 Retweet on Twitter 1918126029463536113 0 Like on Twitter 1918126029463536113 0 Twitter 1918126029463536113
robert_desprez avatar; Robert Desprez @robert_desprez ·
24 Apr 1915491435350253736

Google forcing some remote workers to come back 3 days a week or lose their jobs

Image for twitter card

Google forcing some remote workers to come back 3 days a week or lose their jobs

Several units within Google have told remote staffers that their roles may be at risk if they don't start showin...

cnb.cx

Reply on Twitter 1915491435350253736 Retweet on Twitter 1915491435350253736 0 Like on Twitter 1915491435350253736 0 Twitter 1915491435350253736
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 Apr 1912364221582758283

Image for twitter card

As Canadians cancel trips due to Trump, the U.S. tourism industry could lose billions

The Trump administration's attacks on its northern neighbor have been met with confusion and anger by some Canadians...

www.npr.org

Reply on Twitter 1912364221582758283 Retweet on Twitter 1912364221582758283 0 Like on Twitter 1912364221582758283 0 Twitter 1912364221582758283
robert_desprez avatar; Robert Desprez @robert_desprez ·
13 Apr 1911507080504303659

Image for twitter card

How to awaken Canada’s sleeping economic giant

Recent interviews with industry leaders and experts point toward 10 areas where actionable strategies are needed – ...

www.theglobeandmail.com

Reply on Twitter 1911507080504303659 Retweet on Twitter 1911507080504303659 0 Like on Twitter 1911507080504303659 0 Twitter 1911507080504303659
Load More

Recent Blog Posts

  • ChatGPT: The AI-Powered Proofreader
  • Four Ways Confluence Could Be Better
  • First impressions of MadCap’s purchase of IXIASOFT
  • Online Conferences for Technical Writers in 2023

About Me

Robert Desprez I have worked as a Vancouver technical writer for more than 20 years, working at Kodak, Boeing, Teck Resources, and FortisBC. In addition, I have worked as a writing instructor at Simon Fraser University in Vancouver.

Contact Me

Robert Desprez Com­mu­ni­ca­tions Inc.
North Van­cou­ver, British Columbia
Canada
Phone: 604–836-4290

  • Email
  • LinkedIn
  • Twitter

Copyright © 2025  · Robert Desprez Communications Inc.