Speck CMS - A simple content management system for ColdFusion

you are here: home > documentation > building applications > context sensitive help

• Getting Started
  • Speck Concepts
  • System Requirements
  • Installing
  • Upgrading
  • Hello Speck!
  • Articles
  • Caching
• Sample Application
  • Installing
  • Displaying Content
  • Managing Content
• Application Configuration
  • Settings
  • Keywords
  • Globalization
  • UI Customisation
• Building Applications
  • Application Initialisation
  • Creating Content Pages
  • Creating Content Types
  • Built-in Content Types
  • Built-in Property Types
  • Event Handlers
  • Context Sensitive Help
• Users and Security
  • Security Files
  • User Sessions
  • Access Control
  • Password Encryption
  • Reserved Roles
• Optimising Performance
  • Output Caching
  • Query Caching
  • Unnecessary Processing
  • Database Performance

Context Sensitive Help

There are two simple ways of providing context sensitive help to users of Speck applications, both of which are done when creating content types.

1. The hint attrtibute of the cf_spProperty tag can be used to describe a property. If you add a value for this attribute, a help icon will appear beside the caption on the edit content form. When a user rolls the mouse over the icon, the hint text appears.
2. If a help method is added when creating a content type, a help link will appear above the edit content form. When a user clicks on the link, the method is called and the resulting output displayed.