Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Ideally this function is for administrators within a system to be able to add 'how to' and 'help' tabs for their employees or subcontractors who may be using their site. Administrators can add additional help entries within the 'Help' or '?' icon for most modules within Lucidity.  This function can be useful as the page can be configured to how ever simple or complicated you want your users to read, plus there is using your own URL or file to link into this page. Help can be found on to relay additional, organisation specific information for users, as either links to additional URL's, links to documents or text.   

A 'Help entries' tab is located within the navigation bar in the following photo >>

Image Removed

How you add/edit a new Help Entries page

Image Removed

Once open this page should appear in the middle of the screen.

Image Removed

This is where the user can add/edit the help entry. Also a handy function is here is the Disabled checkbox, this can be enabled for a help entry that has become outdated or irrelevant and mean users on the Help Entry page wont be able to see it.

Image Removed

Current / All Pages is a function where the user can select Access module as shown below:

Image Added

From the Help entries tab, new entries for the Help drop down can be added to any module apart from the Intranet.  As the Intranet module includes a publishing system (the Management System), it is better to add company specific help to the management system pages.

To create a hew Help menu entry, click the Add New link in the list of Help Entries as shown below.  Help can also be added by going to he specific page where the new help entry should display, and clicking the 'Add/Edit' item in the Help drop down (also shown below).  

Image Added


Visible once a new help entry has been created, or when editing, the popover screen enables the type of help entry to be determined, and allows the content to be created.  Note the Disabled checkbox, which can be used when drafting a new help entry.

Image Added

The Current / All Pages function determines whether the help entry data is viewed on all MODULES pages or just the current module you are inpage.

Image Removed

Continuation of adding a new help entry, this is where the user can select the 'Type' of help entry. 'Text', meaning that only the text input in the text box below will be viewed in the entry. 'Url' is when the user adds a link to an external page. 'Resource' is when the user adds in an external file that can be opened on the help entry page, THOUGH, this has to be manually uploaded first to the help entry database by the user before being linked to the help entry itself. 

Image RemovedImage Added

Each help entry can be either a Text or URL (link).  Note that the Resource option has been replaced by the use or the URL option, in combination with a link from the appropriate Document once placed in the Filing Cabinet. 

Image Added


When selecting the text option, you are able to format by whatever means necessary using the functions above the textbox. You are also able to add hyperlinks to other pages if need be within the text editorImage Removed

Image Added

When selecting the URL option, either link to an external page that the content is published within. i.e. google docs, a document publishing system, or an externaly hosted resources.  If you wish to link to a document or file located within the Filing Cabinet, generate a link to the document and then past the link into the URL.