How to Configure Help Text on Items in Sitecore CMS

December 11, 2014

Blog | Development | How to Configure Help Text on Items in Sitecore CMS
How to Configure Help Text on Items in Sitecore CMS

This is the twelfth in a series of posts about learning how to use and develop for Sitecore CMS; it is the follow-up post to “How to Delete Items in Sitecore CMS”. In this “How to” post I will be covering how to configure help text on items in Sitecore CMS.

All Sitecore items have long and short description fields, as well as a “Help link” field. These fields are helpful for providing additional information to content editors. This is especially important for items and fields that are rarely edited where the content editor is likely to have forgotten some important information or just need a refresher.

Additionally, help text configured on template fields will be shown in the content editor. This is useful for including reminders or links to documentation.

From the Ribbon

Select the item you'd like to configure in the content tree.

Click the “Help” button in the Appearance section of the “Configure” tab of the ribbon.

Sitecore 8 showing the Help button in the ribbon

Sitecore 8 showing the Help button in the ribbon

Sitecore 6 showing the Help button in the ribbon

Sitecore 6 showing the Help button in the ribbon

Sitecore will open a dialog where the “Short Description”, “Long Description” and “Help Link” fields can be configured.

Sitecore 8 Help Texts dialog

Sitecore 8 Help Texts dialog

Sitecore 6 Help Texts dialog

Sitecore 6 Help Texts dialog

Unfortunately, the fields are incorrectly labelled. The “Short Description (ToolTip)” field will be shown below the item’s name when the item is selected, and the “Long Description” field will be shown as the item’s tooltip in the content tree.

Sitecore 8 showing the long and short descriptions on an item

Sitecore 8 showing the long and short descriptions on an item

Sitecore 6 showing the long and short descriptions on an item

Sitecore 6 showing the long and short descriptions on an item

From the Item

Select the item you'd like to configure in the content tree.

In the content editor, expand the item’s “Help” field group (if you don’t see the “Help” field group you may need to view Standard Fields).

Sitecore 8 showing the help fields

Sitecore 8 showing the help fields

Sitecore 6 showing the help fields

Sitecore 6 showing the help fields

The fields in the “Help” field group can be updated and saved.

Help Text on Fields

To add assistive text to fields in Sitecore, select the “Template field” item used to configure the field.

Update the help text for the field item using either of the methods described above.

Sitecore 8 showing the help fields on a template field

Sitecore 8 showing the help fields on a template field

Sitecore 6 showing the help fields on a template field

Sitecore 6 showing the help fields on a template field

The “Help link” will be used as the link on the field’s label. This is especially helpful when linked to documentation for how the field should be used.

Sitecore 8 showing the long and short descriptions on a field

Sitecore 8 showing the long and short descriptions on a field

Sitecore 6 showing the long and short descriptions on a field

Sitecore 6 showing the long and short descriptions on a field

Up next: “How to Create Templates in Sitecore CMS”

Tim Leverett

Senior Developer
Tags
  • Sitecore
  • Tutorial

Recent Work

Check out what else we've been working on