Inline AppleScript Documentation
I used a relatively little-known trick for examining the raw source code of a scripting dictionary. Simply click and drag from Script Editor’s document proxy icon, into a text editor such as TextEdit, Xcode, or BBEdit[…] It’s a quick-and-dirty way to learn how specific outcomes are achieved, and how you might incorporate similar features in your own app’s scripting definition file.
Another tip along these lines is that you can open the AppleScript dictionary of the current app from Script Debugger’s Dock menu.
In this case, I discovered a new (to me) “documentation” element in the file[…] “A documentation element may contain any number of html elements, which contain text that will be displayed at that point in the dictionary.”