ModMaker - Module installation

Download

Under the tab Download the created module is downloaded as a ZIP file. After downloading the zip file unzip and upload to the /modules directory.

Module installation

Write permissions

The file /data/_MODUL_NAME_.db and the folders in the directory /media must be writable. Please use FTP to CHMOD as specified by your provider set.

Settings

Log in to the Webutler and access the module installation /modules/_MODULE_NAME_/admin.php. The Settings page is displayed. After save the installation is completed.

Output

That records are displayed on the website, the module must be loaded in a page:
<?PHP require 'modules/_MODULE_NAME_/view.php'; ?>

Display category tree and latest records

For the category tree or the latest records must be before the load of the view.php additional variables are set. Charging can be performed in menu/block files or directly into pages.

Category tree:

<?PHP
$_MMVAR['_MODULE_NAME_catmenu'] = '1';
$_MMVAR['_MODULE_NAME_modpage'] = '_PAGE_NAME_';
require 'modules/_MODULE_NAME_/view.php';
?>

Latest records:

<?PHP
$_MMVAR['_MODULE_NAME_newest'] = '1';
$_MMVAR['_MODULE_NAME_modpage'] = '_PAGE_NAME_';
require 'modules/_MODULE_NAME_/view.php';
?>

_MODULE_NAME_ must be replaced by the selected modul/directory name. In _PAGE_NAME_ the page name must be entered, which should be called. So the page into which the module is loaded.

In catsmenu.tpl a UL list of all categories will be displayed. The output of the latest records is generated newest.tpl in the template.

Search function: can search the database module

In order to integrate a module database in the search function, the module must be entered in the file /settings/searching.php:
$webutler_modulesearches[] = array('_MODULE_DIRECTORYNAME_', '_PAGE(S)_OF_THE_MODULE_');

Sitemap

If the links of the module should be integrate in the sitemap, it must be included in the file /settings/sitemaps.php:
$webutler_modulesitemaps[] = array('_MODULE_DIRECTORYNAME_', '_PAGE(S)_OF_THE_MODULE_');

Entry point for multi-page support

When a module should be used in different pages, categories can be created as entry points. The category ID must be specified in each case prior the loading of the view.php:
$_MMVAR['_MODULE_NAME_basecat'] = _ID_of_the_base_category_;
(Replace _MODUL_NAME_ by your module/directory name)

For the search feature and the sitemap the category ID must be set as the third value in the array:
_modulesearches[] / _modulesitemaps[] = array('_MODULE_', '_PAGES_', ID);

Settings in config.php

The config.php file is located in the directory /data. The fields listed below are only available if the appropriate settings have been made in ModMaker.

These fields can not be changed!

_conf [ cat ]
_conf [ topic ]
_conf [ data ]
_conf [ base ]
_conf [ types ]

If changes to these fields are made, the module will no longer work properly.

Adjust settings

_conf [ catsperpage ]

When setting category tree can be defined here how many categories to be displayed in the administration per page.

_conf [ imgsize ]

When you upload images they will be in front of the store scaled and trimmed in various sizes. Subsequent change of values ​​has no effect on already uploaded images.

optimage = images in option group (adjustable width and height)
catimage = category images (width and height adjustable)
box = image size in the lightbox
view = image size on the page
Other fields have the names of the awarded in ModMaker DB field name for images. In each case, the width and height of an image set for:
box = image size in the lightbox
view = image size in list view
full = image size on the page
bbcode image width adjustable
If enabled in the BBCode editor image URLs, they are scaled to this width.

_conf [ urlparams ]

As a URL parameter, there are settings for:
cat = ID of the category
order = ID path of the category tree
topic = ID of the topic
data = ID of the record
load = call up the input mask
The values ​​for cat, order, topic, data and load can be changed arbitrarily. Each parameter requires a unique name. Default is _MODULE_NAME_cat, _MODULE_NAME_order, _MODULE_NAME_topic, _MODULE_NAME_data and _MODULE_NAME_load.

_conf [ userinputs ]

Here are all generated DB fields for visitor entries. Fields should not be available for visitors, can/should be removed. The fields must also be removed from the template.

_conf [ required ]

All mentioned DB fields are required for visitors submissions. Fields not mandatory to be able to be removed.
For the administration, there is no mandatory!