webCOMAND Docs
API Reference
PHP API
io_comand_help- ⌂ PHP API
- Packages
- io_comand
- io_comand_auth
- io_comand_email
- io_comand_env
- io_comand_file
- io_comand_help
- io_comand_io
- io_comand_log
- io_comand_login
- io_comand_mvc
- io_comand_package
- io_comand_publication
- io_comand_repo
- io_comand_script
- io_comand_search
- io_comand_systemtask
- io_comand_tools
- io_comand_users
- io_comand_util
- io_comand_web
- io_comand_webservice
- io_comand_websocket
- com_webcomand
COMAND Help
io_comand_help
Provides a framework for adding help to the webCOMAND Help sidebar, accessed from the (?) icon in the upper-right of the user interface.
Help URLs and Docs installed and managed in the / System / Help will be displayed in the webCOMAND Help sidebar if their app criteria matches the active app.
Content Types
- Help Doc - Simple content type meant to be extended by the following two to provide a common base.
- Help Doc Text - Help documentation with full text, which can be accessed in the Help sidebar and opened in an iframe or new browser tab/window.
- Help Doc URL - Help documentation that lives on an external web page that be accessed in the Help sidebar and opened in an iframe or new browser tab/window.
Links
Once a Help Doc has been created, a couple types of links can be used to open the Help Doc in webCOMAND.
Full-browser
To open the Help Doc Text in the full browser window, use the Help Doc DOID for a URL like:
https://demo.webcomand.com/io_comand_help/help/view?doid=456
Sidebar Link
To open the Help sidebar with a specific Help Doc Text, get the OID of the Help Doc Text object and add helpdoc=<OID> as a query parameter in the URL, like:
https://demo.webcomand.com/?helpdoc=123
The helpdoc query parameter can also be combined with other query parameters to customize the workspace and help sidebar with something like:
https://demo.webcomand.com/cms/?display=com.webcomand.form.formview&cpath=789&helpdoc=123