plainblack.com
Username Password
search
Bookmark and Share
Subscribe

The Help System

WebGUI provides an extensible help system so that developers can create help for their plugins. The help system is tightly integrated with the Internationalization system.

To add your help, create a file in lib/WebGUI/Help

The help system is all stored in perl modules to keep it fast. The file takes the following format:

package WebGUI::Help::SOMENAMESPACE;

our $HELP = {
        'my big asset add/edit' => {
                title => 'my big asset',
                body => 'my big asset help text',
                related => [
                        {
                                tag => 'my big asset template',
                                namespace => 'SOMENAMESPACE'
                        },
        
                ]
        }
};

1;

Keywords:

Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved