Custom Widgets
Here we display docu pages for custom widgets that are either written by the user or provided with a backend plugin.
The widget files are stored in ./pages/<yourPages>/widgets or ./dropins (user written) and ./dropins/widgets or ./dropins/shwidgets (plugins).
In order to show a docu page for a custom widget, the docu page needs to be created according to the following rules:
- Name the docu file "widget_<widgetgroup>.<widget>.html", e.g. widget_mywidgets.myfunction.html
- Place the docu file in the same directory where the widget files are located (only ./dropins and subtree is working correctly in the docu)
- Add the following head to the top of your widget file and also your docu file:
/**
* -----------------------------------------------------------------------------
* @package smartVISU
* @author AUTHORNAME
* @copyright YEAR
* @license GPL [http://www.gnu.de]
* -----------------------------------------------------------------------------
*/
- Put the following code into your docu file right after the head area:
{% extends "custom/widget_custom.html" %}
{% block example %}
Here comes your docu or example content
{% endblock %}
