Help

The Help module consists of two integrated modules titled Help and Category. The Category module dis- plays a hierarchical list of categories that have one or more HTML pages associated with it. Clicking on a category name displays a summary list of the related HTML pages (called tutorials) in the Help module. The user can then click a read more... link beside any summary to display the related tutorial in full. The Category module includes a search facility which displays results in the Help module. Note: The Help module uses a different import/export feature than other modules which enables Administrators to upload an XML file of content as well as upload a compressed images file and set their root path.

Module Version: 03.00.02 / Minimum DNN Version: 04.05.05

Features: ISearchable

Configuration

The Help module must be configured before any categories or tutorials can be added. This tutorial explains how to associate the Help and Category modules with each other. If the module is not configured any categories added the Category module will not be displayed on the Edit Tutorials page of the Help module. Note: Only one Help module can be located on a page. Users must be a Page Editor or an Administrator.

  1. Select Settings from the module actions menu - OR - Click the Settings button.
  2. Click the Update button.

Searching for a Tutorial

All users can make a search for tutorials using the search box on the Help Category module. You can search on both keywords and phrases. Results will be exact matches, therefore a single keyword search is recommended. Results are displayed in the Help module. You can also use a site wide search which will return both matching tutorials and matching results from other modules on this site.

  1. In the Category module, enter your search criteria into the text box located below the list of categories.
  2. Click the Go button. The search results are now displayed in the Help module. Click on a read more... link beside a result to view the related tutorial.

Viewing a Tutorial

All users can navigate to and view a tutorial using the Help module.

  1. In the Category module, navigate to and click on the name of the category where the tutorial is located. This displays the related tutorials in the Help module.
  2. Click on the read more... link beside a tutorial to view it.

Tip: Use the Previous or Next buttons to view other tutorials within this category. Click the Back To Category button to return to the category.

Adding a Tutorial

Module Editors can add tutorials to the Help module. Note: At least one category must be created using the Category module before a tutorial can be added.

  1. Select Add Tutorial from the module actions menu.
  2. In the Title text box, enter a title for the tutorial. A maximum of 100 characters is permitted.
  3. In the Short Description text box, enter a short description of the tutorial.
  4. In the Tutorial Text Editor, enter the tutorial.
  5. Optional. In the Keywords text box, enter one or more keywords for the tutorial separated by a comma. E.g. alternative therapy,Chinese medicine,health. Enter keywords which aren't included in either of the title, short description or tutorial fields. These keywords will then return this tutorial in both the site search and the help module search.
  6. At Categories, select one or more categories where this tutorial will be displayed.
  7. Click the Update button.

Changing Tutorial Categories

Module Editors can modify tutorial categories on the Help module.

  1. In the Category module, navigate to and click on the name of the category in which the tutorial is located.
  2. Click the Edit button located beside the required tutorial.
  3. At Categories, perform the following:
    • To add the tutorial to a category: Locate the category and then mark the Category check box.
    • To remove the tutorial from a category: Locate the category and then unmark the Category check box.
  4. Click the Update button.

Deleting a Tutorial

Module Editors can delete tutorials from the Help module.

  1. In the Category module, navigate to and click on the name of the category in which the tutorial is located.
  2. Click the Edit button located beside the tutorial to be deleted.
  3. Click the Delete link and click the OK button to confirm deletion.

Editing a Tutorial

Module Editors can edit tutorials in the Help module.

  1. In the Category module, navigate to and click on the name of the category in which the tutorial is located.
  2. Click the Edit button located beside the tutorial to be edited. Note: You can also click the Edit button displayed when viewing a tutorial.
  3. Edit one or more fields as required.
  4. Click the Update button.

Re-ordering Tutorials

Tutorials are listed in the order they are added by default. Changing the order of a tutorial in one category does not affect how it is displayed in another category. Module Editors can move tutorials up or down by one or more positions on the Help module.

  1. In the Category module, navigate to and click on the name of the category where the required tutorial is located.
  2. Click the Refresh button located below the tutorials. This retrieves the latest database information to ensure the correct re-ordering.
  3. Click the Up and Down buttons beside the tutorials to re-order them as required.

Re-ordering Tutorials Alphabetically

Module Editors can re-order all tutorials within a category alphabetically on the Help module. Tutorials are listed in the order they are added by default. Changing the order of a tutorial in one category does not affect how it is displayed in another category.

  1. On the Category module, navigate to and click on the name of the category where the required tutorial is located.
  2. Click the Refresh button. This retrieves the latest database information to ensure the correct re-ordering.
  3. Click the Alphabetical View Order button.

Troubleshooting: Help Categories Don't Display

There are two reasons why categories don't display on the Edit Help page of the Help module when you are trying to add a tutorial, either the module needs to be configured, or no categories have been added. See "Adding the First Category" to resolve this problem. Note: Only Page Editors can configure the Help module

Help Category

Module Editors can perform all of the following tasks using the Help Category module.

Adding a Child Category

How to add a child category to the Help Category module. The Categories module uses a tree folder structure. Child categories are located below a Parent category and can be viewed by clicking on the Maximize button displayed beside their parent category.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and click on the name of the category you want to add a child category below.
  3. Click the Add Child link. This will add a new category to the category tree called "New Category". You can now update the details of this New Category.
  4. In the Name text box, enter the name for the category as it will appear in the module.
  5. In the Description text box, enter a description for the category.
  6. In the Keywords text box, enter one of more keywords separated by a comma. Note: this key- words field is not currently enabled.
  7. Click the Update button.
  8. Repeat Steps 2-7 to add additional child categories.
  9. Click the Back link to return to the module.

Adding a Sibling Category

The Categories module uses a tree folder structure. Sibling categories appear in the same level as each other. A parent category has one or more child categories added to it which is indicated by a Maximize button.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and click on the name of the category you want to add a sibling category to.
  3. Click the Add Sibling link. This will add a new category to the category tree called "New Category". You can now update the details of this "New Category".
  4. In the Name text box, enter the name for the category as it will appear in the module.
  5. In the Description text box, enter a description for the category.
  6. In the Keywords text box, enter one of more keywords separated by a comma. Note: this key- words field is not currently enabled.
  7. Click the Update button.
  8. Repeat Steps 2-7 to add additional sibling categories.
  9. Click the Back link to return to the module.

Adding the First Category

How to add the first category to the Help Category module.

  1. Select Manage Categories from the Category module actions menu.
  2. In the Name text box, enter the name for the category as it will appear in the module.
  3. In the Description text box, enter a description for the category.
  4. In the Keywords text box, enter one of more keywords separated by a comma. Note: this key- words field is not currently enabled.
  5. At Visible, mark the check box to make the category visible on the Category module- OR - unmark check box to hide the category.
  6. Click the Add New link. The category is now displayed to the left.

Changing a Child Category to a Parent Category

How to move a child category to the root of the Help Category module. Root categories are top level parent categories.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and click on the name of the child category to be modified.
  3. At Parent, select < None Specified >.
  4. Repeat Steps 2-4 to modify other categories.
  5. Click the Back link to return to the module.

Changing the Parent of a Category

How to change the parent of a category in the Help Category module.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and select the category to be modified.
  3. At Parent, select the name of the new parent category.
  4. Click the Update button.
  5. Repeat Steps 2-4 to modify additional categories.
  6. Click the Back link to return to the module.

Deleting a Category

How to delete a category from the Help Category module.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and select the category to be deleted.
  3. Click the Delete link then click the OK button to confirm deletion.
  4. You are now able to delete categories with Child categories as well as the tutorials associated with them.
  5. Repeat Steps 2-4 to delete additional categories.
  6. Click the Back link to return to the module.

Editing Category Details

How to edit the details of a category in the Help Category module.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and click on the name of the category to be edited.
  3. Edit the Name or Description details as required.
  4. Click the Update  button.
  5. Repeat Steps 2-4 to modify additional categories
  6. Click the Back link to return to the module.

Managing the Visibility of a Category

Categories set as visible are displayed in the Categories module. Categories set as not visible will not dis- played in Category module. All child categories of a category set as not visible are also hidden.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and select the category to be modified.
  3. At Visible, mark the check box to set the category as visible - OR - unmark the check box to set it as not visible.
  4. Click the Update button.
  5. Repeat Steps 2-4 to modify additional categories.
  6. Click the Back link to return to the module.

Re-ordering Categories on the Same Level

How to re-order categories on the same level in the Help Categories module.

  1. Select Manage Categories from the Category module actions menu.
  2. Navigate to and select the category to be moved.
  3. Click the Refresh button.
  4. At View Order, click the Up and Down buttons to move the category as required.

Settings

Importing Help Data

How to import help data including images to the Help module.

  1. Select Settings from the Help module actions menu.
  2. Select the Help Module Settings tab.
  3. In the Root Path For Images text box, enter the root path for where the images for this module are to be located. The XML is updated on import using this new path allowing the content to be port- able. E.g. If you create the content on your local machine using a standard DNN setup with the portal ID =0 and you need to Import onto a live site with a Portal ID=25 then you set the Root path to Portals/25 so that the ../../../../Resources/OnlineHelp is replaced in all of the HTML you have created which makes the images show properly:
  4. At Upload XML, select or upload the data xml file which contains the Help content. This file can optionally be zipped (compressed).
  5. At Upload Images, select or upload a zipped (compressed) images file.
  6. Click the Update button.

Last edited Oct 7, 2015 at 1:22 AM by dnnangel, version 6

Comments

No comments yet.