1. Home
  2. Customization
  3. Customize VisualSP On-Premises
  4. Enable a Site Collection to Display Help Items

Enable a Site Collection to Display Help Items

Applies to: VisualSP On-Premises
Print Friendly, PDF & Email

Overview

Before any SharePoint site collection can display VisualSP Help Items, it must first be configured to consume VisualSP Help Items. This is accomplished by simply activating the VisualSP Help Consumer Site Collection Feature.

Note: When VisualSP is installed, it is typically deployed to all Web Applications in the SharePoint Farm. If you do not see the VisualSP Help Consumer Feature in the Site Collection Features page, your SharePoint Administrator will need to deploy VisualSP to the web application.

If VisualSP was installed following the recommended settings, then this feature will already be activated on all site collections and will be activated on new site collections as they are created.

All site collections inherit Help content from the VisualSP Farm Hub and/or a VisualSP Web Application Hub by default. If the Help tab is not visible on a particular Site Collection, that site collection has not been set as a ‘consumer’ of the Help items.

Activate the VisualSP Help Consumer Feature

Reference video tutorial:

http://sharepoint-videos.com/products/visualsp/
visualsp-video-showcase/#ToggleHelpTab

To enable a Site Collection to consume Help items, a site collection administrator must activate the VisualSP Consumer Site Collection Feature as shown in the following image:

Enable and Disable the Help Tab Ribbon for a Site Collection

Nothing else is required to Enable the Help Tab Ribbon. Once the VisualSP Help Consumer Feature has been activated, the site will begin displaying VisualSP Help Items in the Help Tab Ribbon. If you no longer want VisualSP Help content to be displayed in a particular site collection, simply deactivate the VisualSP Consumer Feature.

Note: If you do not see the Help Tab Ribbon anywhere on the site collection, there may not be a VisualSP Farm Hub or Web Application Hub set up to provide content for this site collection to consume. We will look at Provider setting in the next section.

Enable and Disable Displaying of Inline Help within a Site Collection

Inline help can be turned on and off at any of five levels:

  • The VisualSP Provider Settings in the VisualSP Farm Hub
  • The VisualSP Provider Settings in each VisualSP Web Application Hub
  • The VisualSP Consumer Settings in each Site Collection
  • At the page level by each user

In this section, we are only going to look at how this is done via the VisualSP Consumer Settings in each Site Collection and at the page level by each user. The other options will be covered elsewhere in this manual.

To enable or disable Inline Help for a particular site collection, visit the Site Settings page of the site collection and click Manage VisualSP Help Consumer Settings in the VisualSP Settings section.

Checking the box for Enable Inline Help will allow this site collection to display Help Items that are provided to it. When this box is checked, Inline Help can then be enabled or disabled by each individual user. If this box is unchecked, Inline Help cannot be enabled by any user in this particular site collection.

Note: The VisualSP Help Consumer Settings page is also available in the VisualSP Farm Hub and each VisualSP Web Application Hub. If Inline Help has been enabled in the Provider Settings page, a site collection administrator can still use the VisualSP Consumer Settings to enable or disable displaying of Inline Help items within the Hub’s site collection. If Inline Help has been disabled in the Help Provider Settings of a VisualSP Hub site, it cannot be enabled for the hub site collection.

 Enable or Disable Inline Help at the Page Level

Each individual user can enable or disable Inline Help for themselves at the page level by clicking on the VisualSP icon in the right of the Top Bar. If the switch shows Off, clicking it will turn it on. If the switch shows On, clicking on it will turn it off.

Once a user enables or disables Inline Help, it will remain on or off anywhere the user goes. It is not necessary to turn it on or off for each page.

Updated on January 18, 2018

Related Articles