Adding Meta Descriptions for Topics

Adding Meta Descriptions for Topics

You can add a meta description to a topic in the Properties dialog. Meta descriptions are brief summaries of web pages and are displayed in search engine results pages (SERPs). Therefore, they are useful for search engine optimization in HTML5, WebHelp, and WebHelp Plus outputs.

This description is stored as metadata in the <head> tag of the topic file. The markup looks like this:

<meta name="description" content="This topic provides a general introduction to MadCap Flare, its benefits, and basic steps for getting started." />

In addition, topic meta descriptions are used in the search results for HTML5 output, and they are searchable. Keywords found in meta descriptions receive a ranking in search results.

If you do not provide a meta description, Flare will use the abstract character limit to create an abstract from the text in your topic. However, keywords found in automatically generated abstracts receive a lower search ranking than those found in meta descriptions. See Setting the Search Abstract Character Limit and Ranking Search Results.

For more information and tips for using meta descriptions, see Optimizing Your Content.