MidCOM component online documentation

1. Creating help files
1. Using images
2. Linking to help files

MidCOM includes an online help system that can be used for adding documentation into components.

Creating help files

Help files are UTF-8 encoded text documents formatted using the Markdown syntax. They are located in the documentation directory of the component.

Each file should have its own identifier, corresponding to the handler ID of the current view. Filename suffix for these files is .LANGUAGE.txt, which means that english the documentation for creating articles in the net.nehmer.static component would be stored with the following path:

src/net.nehmer.static/documentation/create_article.en.txt

If documentation is not available in user's current language, the english version will be used as fallback.

Using images

Images and other files needed in the documents may be stored in the component's static directory and linked to the online help files using following syntax:

![Image text](MIDCOM_STATIC_URL/net.nehmer.static/create_article.jpg)

Linking to help files

Help files can be linked to using the MidCOM toolbar service. For example, to link to help file create_article in your component, call the following in the handle phase:

$this->_view_toolbar->add_help_item('create_article');

This will populate a view toolbar item that pops up the help for creating articles.

At least the english version of the documentation file should exist before the button is added to the toolbar.