Framework for a Help System in MediaBeacon
MB Build / Version: 8.0+
Issue
This method is a way to add a holding area for help topics. It's not intended as a CMS, but a way to provide a sequestered area for help materials.
- Users can access the Help area from the ACL menu
- Users search, browse, view and download help assets
Resolution
- Create an
/Index/Help/
folder- Populate with help assets.
- Make new fields in a schema, often an "Administrative" schema is used:
- "Help Material" (checkbox), this will identify assets as help assets
- "Help Topic" (csv field) this will categorize the assets
- You might add more fields for other categorization or make "Help Topic" hierarchical for more organization
- Create a "Help" Group and "Help" ACL within it
- Prevent view of anything but help assets
- Root Folder will be "/Index/Help"
- Add a search filter for ("Help Material" IS NOT NULL)
- Prevent all actions but search and download
- Most permissions will be off, except for High Res and Quick Download
- No metaform tabs will be available
- Prevent view of anything but help assets
- Populate all the assets with appropriate Help Topic keywords
- Create a single "Help" workspace for the "Help" ACL
- Add a search filter to the workspace with the "Help Topic" field and any other relevant ones.
- You may also wish to add a HTML widget with explanatory text as well.
- Alter existing configuraton to accommodate
- Add/remove new field as necessary to existing metaforms
- Add all users to the Help Group
- Alter all other preexisting ACLs
- Search Filters: Add the following to existing search filters; ("Help Material" IS NULL)