UniHelp Publisher

Our award-winning, cross-platform help system for REALbasic developers.

The UniHelp Publisher window allows you to customize the appearance of the UniHelp module interface by choosing the icon colors, font face, window size/position, and more! When publishing your help pages, TOC, and Index for UniHelp, HelpLogic generates customized REALbasic code for the UniHelpEngine constructor and saves it in your new help folder in a document called "Code_for_UniHelp.txt".

Publishing a UniHelp Virtual Volume

To publish your UniHelp pages as a Virtual Volume, select the .vv checkbox next to the "Help Folder Name" field. Once checked, you will notice that the field's name changed to "Help Virtual Volume Name". The published help will be saved as a single Virtual Volume file with a .vv extension. Located in the same directory as your published Virtual Volume will be a "Code_for_UniHelp.txt" document that includes your customized code for your REALbasic project. Pay special attention to the fact that this generated REALbasic code is different for Virtual Volumes than standard help folders.

Virtual Volumes CANNOT be opened from read-only locations such as Mac OS X disk Images, CD-ROMs, DVDs, or locked drives/disks. If you need your application to access help pages from a read-only location, then you should publish your UniHelp pages in a standard help folder.

Developing for Older Versions of UniHelp

With UniHelp 4 now available, older UniHelp versions are no longer supported, so preview and publishing options for those obsolete versions have been removed from HelpLogic. Since UniHelp 3 and higher supports standard HTML/CSS, the special UniHelp Page Editor is no longer needed and has been removed from HelpLogic. The built-in HelpLogic Code Editor (or any external editor) can be used for creating HTML pages for UniHelp 3 and higher.

Publishing Your Old UniHelp 1.x Pages in Other Help Formats

When importing your UniHelp 1.x Pages into a new project (using the "Import Set" feature), the project's Table of Contents is automatically generated based on your UniHelp 1.x file naming and numbering scheme. You will still need to add your own custom keywords to the TOC topics, but the generated TOC will have saved you a lot of time when publishing your help pages in other help formats that use the TOC (such as UniHelp 3, Web-based Help, etc.)

Important Note: When selecting a publish location, do NOT choose a directory within your source files folder. Publishing from your source files folder into your source files folder will cause an endless loop, filling your hard drive with endless folders. As of HelpLogic 1.0a2, the Publish feature does not allow you to select the source files folder as your publish location.

For detailed instructions on how to use UniHelp, please see the UniHelp documentation (included in the UniHelp download).

If you're a REALbasic developer who is unfamiliar with our popular UniHelp component, you can find more information and download the trial version at: http://www.ebutterfly.com/rb/unihelp.php