Using the new Help Editor

Applies to: VisualSP
Print Friendly, PDF & Email
VisualSP has streamlined our Help Editor window to make the process of making Help Items easier. You now have a choice of either starting from scratch, as was the experience in the previous version of our Editor, or start from a template. We have provided some starter templates for you, but you are also able to create your own templates and have easy access to them from this template gallery.

Creating a Help Item with the new Help Editor

When you click the green Add Help Item button in the help panel, you are taken to our new template gallery, which looks like this:

  1. Just like our previous Help Editor, the Application defaults to the current application you are in. You can change the Application by simply selecting a different application from the drop down menu.
  2. To duplicate the experience from our previous Editor and start from scratch, select the Blank Help Item template. This will open the Editor screen with nothing pre-configured. Use a blank template if you know what you want to do.
  3. You can expand the Editor window by clicking this icon.
  4. Click the Manage Templates button to open the Templates application. This is where you go to edit the actual templates.
  5. We have opened up the Editing screen real estate by hiding some other features along the left side of the Editing screen. This panel will slide out when you hover your cursor over it:

    1. New Help Item - Click here to open up the Create New Help Item template gallery
    2. Open Help Item - Click here to view all your help items, grouped by Application
    3. Manage Groups - Click here to view / create your Group names
    4. Import Help Item - Click here to import a help item json file

  1. If you wish to start from a template, we have some pre-configured templates available to get you started. Any templates you create will appear here.
  2. Other templates are grouped into tabs.

How to Create a Template

Just as VisualSP empowers you to create your own help item, you can also create your own templates. There are a couple of ways to do so.

From the New Help Item page

    1. From the New Help Item page, begin by selecting VisualSP Help Templates from the drop down menu:

    2. Next, click the Blank Help Item template. This will open the regular blank help item screen, but there will be an extra section at the top called Template Details where you can enter details about the template:

      Template Title and Template Description are required. The Template Image is optional, but uploading an image of what the template looks like is helpful when looking for the template in the gallery.
    3. Below that will be the regular fields for the different Media Types. The next section to take note of is the Group section:

From the Open Help Item page

  1. Click on Open Help Item in the side panel
  2. Select VisualSP Help Templates
  3. Click the Add Template button
Fill in the template details as described above.
Updated on February 26, 2021

Related Articles