http://www.orbolt.com/faq/question/10/how-do-i-include-help-my-assets [orbolt.com]
There are some gotchas to watch out for so I'll post them here.
1) When copy pasting text into the help card (asset type Properties>help tab),
the copy paste has a unix-style-MMB paste:
Whatever text was last selected, in any window, is what gets loaded into the copy/paste buffer. MMB will paste it. As a result you cannot select text in this window and paste/replace it…because selecting the text loads it into the buffer. I know, a bit unusual unless you're familiar with Unix or some flavors of Linux.
2) Using embedded images can be tricky. Ill make a separate post about this.
- Icons must be square.
-png or jpg format are good choices.
-If you use embedded images, you will have to update your help card to reflect the new internal name of your asset. The reason for this is that assets get renamed at upload time (for versioning, and to ensure that each one has a unique name.