====== Vivvo Modules in General ======

Vivvo modules interact between [[vte|VTE]] and [[objects|Vivvo Object]]. Basic purpose of module is to:

    * Instance new template bases on parameters
    * Instance list object with search parameters
    * Load additional required resources
    * Provide necessary assignments to template engine

VTE parser calls on Vivvo site to auto load module with provided template and parameters.

<note warning>Each module must be [[devdoc:modules:register|registered]] in Vivvo configuration storage before it can be used.</note>

===== Default module/box parameters: =====

These are default VTE parameters for invoking a module.

^ Parameter name	^Value 	        ^Description                                       ^
|template 	        |string 	|Template filename and path relative to Vivvo root |
|template_string 	|string 	|string template                                   |
|cache 	                |0%%|%%1 	|Enable module output caching                      |

Example:

<code>
<vte:load module="box_sections" id="{category.id}" template_string="{template_string}" prefix="{prefix}" />
</code>

===== Default Modules =====

List of predefined modules available by default that cover all the standard needs. You can develop and register own module for any specific task at any point.

    * [[devdoc:modules:box_article_list]]
    * [[devdoc:modules:box_comments]]
    * [[devdoc:modules:box_users]]
    * [[devdoc:modules:box_sections]]
    * [[devdoc:modules:box_tags]]
    * [[devdoc:modules:box_pages]]
    * [[devdoc:modules:box_feed]]
    * [[devdoc:modules:box_calendar]]
    * [[devdoc:modules:box_topics]]

===== Additional outputs for Vivvo modules =====

    * [[devdoc:modules:JSON]]
    * [[devdoc:modules:XML]]

===== Developing Custom Modules =====

You'd like to program Vivvo modules from the ground up or figure out what modules are actually doing behind the scenes? Then please refer to [[devdoc:modules:devmod|Developing Modules]] section.