Monday, February 19, 2018

Have You Stopped Indexing Your Flare Projects? Not So Fast…



Many Flare authors no longer create indexes for their targets, instead relying on the search feature. It makes sense. Most authors find indexing tedious, so the search feature is a simple and widely accepted alternative. And if you use TopNav skins for your targets, there’s no index option anyway. So, you can just abandon indexing entirely, right?

You can, but there are two arguments for creating an index, even if you use TopNav skins.

Improving Search Ranking

Indexing seems to have nothing to do with search, but it can actually make topics found by search show up higher in a search results list and thus be more visible. For example, the screen below shows the result of a search for “FTP Site”. The desired topic, called “Neil’s FTP Site,” has no index entries assigned to it. It shows up in position 5.


I then add the index entry “FTP site” to the topic, regenerate the target, and re-run the search. The topic now shows up in position 2.


Why? When creating the list of search results, Flare assigns different weights to keywords depending on where they occur in a topic. (See “Ranking Search Results” in the help.) Specifically, it weights an index keyword in a topic as if that keyword is a search keyword in a level 4 heading. It’s hard to say exactly what to expect here because topics are so different but, as a general rule, the more index keywords you apply the better your search results. Try it with a topic in your Flare project that users often search for and see if it makes a difference.

Improving Search Synonyms

Adding index entries may let you fix some search synonym issues. This can be a somewhat tangled issue so follow me.

Let’s say that one of your topics describes subs (the sandwich). However, in Philadelphia, subs are called hoagies. But you, the author, being from Boston, never used the word hoagie in the topic. The result? Users who search for “hoagie” get zero hits.

You can fix this by creating a search synonyms file (File > New > Synonyms) and adding a group synonym where “sub=hoagie=torpedo=” and so on. Now, when users search for hoagie, they’ll get the Subs topic. Problem solved?

Perhaps. Users who search for “hoagie” but find “sub” are likely to do one of two things. If you have lots of credibility with your users, they may infer that a hoagie is the same thing as a sub. More likely, they’ll think the index entry was misdirected and the credibility of your material will drop a bit.

The solution is to change the wording of the synonym to make it clear that it is a synonym, like changing the synonym to “hoagie, aka sub”. However, the synonym editor only accepts single-word entries. Now what?

There are two solutions, one that works by using the meta-description feature but doesn’t involve index entries at all, and a speculative solution that does involve index entries.

Meta-Description Solution

The first solution is to add the synonyms in the topic’s meta-description (in the Topic Properties tab of a topic’s Properties dialog box, shown below.


In the Description field, you can enter a description of the topic that displays when users see the topic in the search results list. If I enter the synonyms in the Description field as “Also called grinder, hoagie, or torpedo,” here’s what the user will see in the search results list.

It’s not as efficient as seeing the full synonym in the search highlight but it does the job.

Speculative Solution

This involves creating the multi-word synonyms as index entries. Go to the topic for which you want to add synonyms, like the subs topic, and press F9 to open the Index window. Enter the multi-word synonyms, one per line. For example, for the subs topic, you might add the synonyms “hoagie, aka sub” and “torpedo, aka sub”. If users then search for hoagie, the browser will return the subs topic as the hit. The problem is that the search results screen looks like this.


The search report shows only what the users type in the search field. The complete synonym is “hoagie, aka sub” but you don’t want users to have to type that whole entry or expect them to. You want them to just type “hoagie”, run the search, and see a report that says “Your search for “hoagie, aka sub” returned 1 result(s).” that reinforces the idea that a hoagie is the same thing as a sub.

The problem is that, as of Flare 2017 r3, the search report only shows what the user typed in the search field. It doesn’t list the complete search term. I have put in a feature request to make the search report list the entire entry but there’s no way to tell whether MadCap will add this feature or when. So, you’d be adding these index synonyms on speculation that MadCap might add the feature.

Summary

Indexing is increasingly seen as a dying feature as more and more Flare authors default to using search. But there are some good reasons for continuing to add index entries, especially if you want to increase the findability of certain topics. Indexing may be old but it’s far from dead.

30 comments:

unknown said...


What a nice blog! I have enjoyed reading through the article although I landed on this site while I was looking for data analysis assignment help . I will be visiting this site occasionally to read more interesting and intriguing articles. I hope the writer will continually keep us updated with new information.


Alex Kim said...

Do you need help with business translation help?Today,availing Online Singapore Translation Services has become easier than ever before.Here, you get instant help from Singapore linguist experts.For more information visit singaporetranslators.com .

ireland assignment help said...

Ireland assignment help provides the best and inexpensive sna level 6 assignment sample services to the students of Ireland. our professional and well-qualified experts present the outstanding sna level 6 assignment sample to all students at a reasonable price.

unknown said...

What a nice blog! I have enjoyed reading through the article although I landed on this site while I was looking for irrigation equipment suppliers in Kenya. I will be visiting this site occasionally to read more interesting and intriguing articles. I hope the writer will continually keep us updated with new information.

pesh said...

What a wonderful content will be occasional visitor. Our team has professional writers who deals with math assignment with 100% perfection and delivers quality work free from plagiarism. Place your order today at take my online mystatlab class and get work done

pesh said...

Best piece of info ever looking forward for more, if you have always desired to look like Jesse James or James Bond, your look won’t be complete without a typical full-length all-leather duster. Get one from Leather Duster Jacket

NZ Assignment Help said...

Get the best do my assignment help services in Napier. Our writers are ready to fix your problems. NZ Assignment Help have several years of experience in the field of assignment help and we are giving quick and reliable services to all the students at pocket-friendly prices.

uae assignment help said...

Need instant assignment help? Our Assignment Helper UAE are ready to help you. We have a large team of 1000+ experts who are ready to help you 24x7. We are giving 100% accuracy with quick and reliable services. We have several years of experience in the field of assignment help.

Binary said...

Thank you for this wonderful information looking forward for more, if you live in an area with some hills and slopes and you are planning to buy an electric scooter to climb the hills when commuting or enjoying the beautiful view of the landscape, you need to choose the best electric scooter for climbing hills around your area. All from Best Electric Scooter for Climbing Hills

MyAssignmentHelp said...

Thank you for sharing this informative post.MyAssignmenthelp.co.uk is giving computer engineering to students.we are already trusted by thousands of students who struggle to write their academic papers and also by those students who simply want Best Computer Engineering Assignment Helper in Uk to save their time and make life easy.

Academic Assignment Writing said...

Hello, I have browsed most of your posts. This post is probably where I got the most useful information for my research. Thanks for posting, we can see more on this. Are you aware of any other websites on this subject.
accounting assignment writing service

Alex Kim said...

Singapore Translators have already translated lots of birth certificates and recognize precisely what and how quick you need to have it. No worries as we do not have any urgent charges or additional charges or higher rates.

pesh said...

Thank you for sharing great content. Will be your occasional visitor. Drip Irrigation is a kind of micro-irrigation system that delivers water slowly at a low pressure near or at the root zone of the plants. Get Best drip emitters today

Expo 2020 said...

Nice to be visiting your blog again, it has been months for me. Well this article that i've been waited for so long. I need this article to complete my assignment in the college, and it has same topic with your article. Thanks, great share.
rta bus timing

ireland assignment help said...

Ireland Assignment Help is the most trusted and reputed brand in Ireland which provides the academic writing services to the students. Our experts can handle any complex assignments outstandingly. Hire our writers and get complete your assignment on time.

Assignment help said...

Assignment Help ,
Assignment Help Online ,
Online Assignment Help ,
Assignment Help ,
Buy Assignment ,
Cheap assignment help ,

best assignment help ,
assignment helper ,
homework help ,

Assignment Help ,
Assignment Help Online ,
Online Assignment Help ,
Assignment Help ,
Buy Assignment ,
Cheap assignment help ,

best assignment help ,
assignment helper ,
homework help ,

Assignment help said...


programming assignment help ,
programming homework ,
cheap programming assignment help ,
programming assignment help ,

programming assignment help ,
programming homework ,
cheap programming assignment help ,
programming assignment help ,

Assignment help said...

web development company ,
digital marketing company ,
web designing company ,
seo services ,
web development company ,

Smith said...

I have been looking for such great information for some time thanks I finally found it. From sweetbreads to sandwich bread, to gluten-free bread, people are using these handy bread maker machines to replace the less than appetizing store-bought bread. But choosing a bread machine isn’t exactly easy. Visit Best Buy Bread Maker for more.

Smith said...

Thank you for such a great content looking forward for other. When it becomes hard to manage your online assignment, availing Online Assignment Help is the best choice. Many students often fail to submit their assignment before deadlines and end up scoring low grades because they didn’t have enough time to write the assignment given on time and satisfactorily. Read more on Assignment help UAE .

shri style said...

Excellent article. I'll be forwarding this page to a few other people. And you want information about Irrigation equipment then visit now our website : https://www.apsaequipments.org

Pay My Recharge said...

IF you are searching for a new bill payment business in INDIA. Pay My Recharge is the best option for you for buying a bill payment business. Our team is highly professional and we are working from past 10+ years in API selling business. We are giving high commission rates for all the transaction done with our API.

Top Body Products said...

This is a popular health resort for you. Relates to more than millions of products in the market. But we have suggestions for the most effective and healthy product and can facilitate health and fitness and most of you desire to understand it. You can feel free to ask data about the side effects and benefits of health and wellness items through our site.

https://www.topbodyproducts.com/

Codunite said...

If you are searching for best MLM Software Solution in INDIA. Codunite IT Solution is the best option for you. We are giving top-quality services at best price. Our team is highly professional and we are serving top-quality product at an affordable price.

Caleb said...

I’m amazed by your great effort to make best content on internet. But wait! Did you know? Everyday hustle and bustle make it difficult for most people to get some time for hitting the gym, but doing a few yoga poses right in the comfort of your home can be good enough. That is why a quality rolling wheel is an essential part of your workout kit. Visit Chirp Wheel for more.

Sam Smith said...

What a nice piece of content. At the point when the yard work is done, it's a great opportunity to cook outside. Envision yourself planning steak, fish, chicken, cleaves, imps, canines, burgers, or a major skewer of marinated vegetables on a new gas grill. Hungry? You’ve come to the right place. Learn more on Best Gas Grills

bonni bennette said...

Thanks for sharing this amazing post.World’s best assignment experts is the best choice you could make. Students often miss the assignment submissions, leading to score low grades. This is the moment MyAssignmentMart is considered to be the best companion of a student in need of online assignment help. We are here to help you in your assignments, Mechanical Engineering Assignment Help,matlab Assignment Help,Electrical Engineering Assignment Help,Management Assignment Help,Assignment Help,Assignment Help Online be it any subject.

bonni bennette said...

This is the moment Matlab Assignment is considered to be the best companion of a student in need of Matlab assignment and Homework help. We are here to help you in your Matlab assignments. If you are running out of time, choose us for our on-time delivery benefit. Second thing we strictly follow is the plagiarism. All our solutions provided are 100% plagiarism free.
MatlabAssignment.com Matlab Assignment Help Plagiarism is a sin, and we better understand it.

bonni bennette said...

Hey, really such great information dear. Thanks for sharing this amazing post.We are an independent cdr report help provider with a highly professional team providing complete guidance for Competency Assessment for EA Membership and Skill Assessment for Migration to Australia. As preparation of CDR reports and Career Episodes (CEs) is the vital step in migration skills assessment, we assist engineers from all engineering disciplines such as Electrical, Civil, Mechanical, Chemical, Electronics, Instrumentation, Industrial, Biomedical, Computer, Telecommunication and so on.We also providing diffrent services like CDR report writing services,
Career episode writing services,
Summary statement writing services,
RPL writing services,
KaO2 report writing services,
sop writing services from us.

Smith said...

What an informative article. Tell you what I have bookmarked your website for regular checkup. Thank you for taking time to share such a great content. Are you puzzling about who to contact for Nursing Writing Services? Could it be that you are working on a tight budget yet need high-quality nursing-related assignments? Is it the efficiency that you are looking for? Well, with the popularity that the nursing course has gained over the years, there are a lot of gaps to fill in the health sector. Read more on Nursing Writing Services.