Dizmo User Help Text
DizmoGen has generated the help/en/help.md file as a template. Edit this file to create the User documentation about your dizmo. After uploading the dizmo to the Store, this user documentation will be uploaded to the help server at dizmo and displayed to the User when he selects "Help" from the menu of your dizmo. Help.md is version specific, so the dizmo will always display then help linked to the specific version of the dizmo.
# (Display Name of the dizmo)
**Table of contents**
1. Screenshots
2. Description
3. What is new in VX.Y.Z
4. Works well with
5. Additional information
## Screenshots
Add your screenshots measuring width 400 px and height 275 px that illustrate your dizmo.
## Description
Describe what can be done with the dizmo and how it should be used.
## What is new in VX.Y.Z
Explain the improvements of the newest dizmo, then list those of each published version.
## Works well with
(Optional) List the hardware and/or the dizmos with which your dizmo can be used.
## Additional Information
* Developer: (Developers Name)
* Publisher: (Publisher's Name, remove if same as Developer)
* Contact: (Who to contact for additional information or support)
* Website: (URL of the dizmo providing additional information)Chapter 1. Screenshots
Add a screenshot measuring width 400 px and height 275 px that illustrates your dizmo. If your dizmo has a front and the user can adjust settings, add screenshot of the front and back. If your dizmo provides more features, add the feature screenshots.
If you are using more than one screenshot as described above, you can display it in an image slider, which allows to jump from one screenshot to the next.
You’ll also need to add the following script to enable the image slider to the end of help.md
<script>
var url="/bundles/com.dizmo.helper/assets/js/hooks.js";
jQuery.get(url).done(function (js) {
eval(js); jQuery('#pager').trigger('turn:before', [0]);
});
</script>Chapter 2. Description
Describe what can be done with the dizmo and how it should be used.
Chapter 3. What is new in VX.Y.Z
Explain the improvements of the newest dizmo, then list those of each published version.
Chapter 4. Works well with
This chapter is optional. List the hardware and/or the dizmos with which your dizmo can be used.
Chapter 5. Information
Fill in your or your company’s name, how to contact your for support and your website.