ModMaker - Modulinstallation

Download

Unter dem Reiter Download wird das erstellte Modul als ZIP-Datei heruntergeladen. Nach dem Download das Zipfile entpacken und ins /modules Verzeichnis uploaden.

Installation

Schreibrechte

Die Datei /data/_MODUL_NAME_.db und die Ordner im Unterverzeichnis /media müssen beschreibbar sein. Bitte mit FTP CHMOD nach den Angaben des Providers setzen.

Einstellungen

In den WEButler einloggen und die Modulinstallation /modules/_MODUL_NAME_/admin.php aufrufen. Die Einstellungen-Seite wird angezeigt. Nach dem speichern ist die Installation bereits abgeschlossen.

Ausgabe

Damit Datensätze auf der Webseite ausgegeben werden, muss das Modul in eine Seite geladen werden:

<?PHP require 'modules/_MODUL_NAME_/view.php'; ?>
(_MODUL_NAME_ durch den gewählten Modul-/Verzeichnisnamen ersetzen)

Meta-Daten unterdrücken:
Es kann vor kommen, dass man keine Meta-Daten haben möchte. Mit der Einstellung $_MMVAR['_MODUL_NAME_isblock'] = '1' kann die Ausgabe der Meta-Daten unterdrückt werden.

<?PHP
$_MMVAR['_MODUL_NAME_isblock'] = '1';
require 'modules/_MODUL_NAME_/view.php';
?>

Einstiegspunkt für Multipage-Support

Wenn ein Modul in verschiedenen Seiten genutzt werden soll, können Kategorien als Einstiegspunkte angelegt werden. Die ID der Kategorie muss jeweils vor dem Laden der view.php angegeben werden:

<?PHP
$_MMVAR['_MODUL_NAME_basecat'] = _KATEGORIE_ID_;
require 'modules/_MODUL_NAME_/view.php';
?>

Für die Suchfunktion (/settings/searching.php) und die Sitemaps (/settings/sitemaps.php) muss die Kategorie-ID als dritter Wert im Array gesetzt werden.

Kategorienbaum und neuste Einträge anzeigen

Für den Kategorienbaum oder die neusten Einträge müssen vor dem laden der view.php zusätzliche Variablen gesetzt werden. Laden ist in Menü-/Blockdateien oder direkt in Seiten möglich.

Kategorienbaum:

<?PHP
$_MMVAR['_MODUL_NAME_catmenu'] = '1';
$_MMVAR['_MODUL_NAME_modpage'] = '_SEITEN_NAME_';
//$_MMVAR['_MODUL_NAME_basecat'] = _KATEGORIE_ID_; (wenn benötigt)
require 'modules/_MODUL_NAME_/view.php';
?>

neuste Einträge:

<?PHP
$_MMVAR['_MODUL_NAME_newest'] = '1';
$_MMVAR['_MODUL_NAME_modpage'] = '_SEITEN_NAME_';
//$_MMVAR['_MODUL_NAME_basecat'] = _KATEGORIE_ID_; (wenn benötigt)
require 'modules/_MODUL_NAME_/view.php';
?>

_MODUL_NAME_ muss durch den gewählten Modul-/Verzeichnisnamen ersetzt werden. Bei _SEITEN_NAME_ muss der Name der Seite eingetragen werden, die aufgerufen werden soll. Also die Seite, in die das Modul geladen wird.

Im catsmenu.tpl wird eine UL Liste mit allen Kategorien ausgegeben. Die Ausgabe der neusten Einträge wird im Template newest.tpl erzeugt.

Suchfunktion: die Modul-Datenbank durchsuchen lassen

Um eine Modul-Datenbank in die Suchfunktion zu integrieren, muss das Modul nur in die Datei /settings/searching.php eingetragen werden:

$webutler_modulesearches[] = array('_MODUL_NAME_', '_SEITEN_NAME(N)_');

Für Multipage-Support muss die Kategorie-ID als dritter Wert im Array gesetzt werden:

$webutler_modulesearches[] = array('_MODUL_NAME_', '_SEITEN_NAME(N)_', _KATEGORIE_ID_);

Sitemap

Wenn die Links des Moduls in die Sitemap aufgenommen werden sollen, muss es in die Datei /settings/sitemaps.php aufgenommen zu werden:

$webutler_modulesitemaps[] = array('_MODUL_NAME_', '_SEITEN_NAME(N)_');

Für Multipage-Support muss die Kategorie-ID als dritter Wert im Array gesetzt werden:

$webutler_modulesitemaps[] = array('_MODUL_NAME_', '_SEITEN_NAME(N)_', _KATEGORIE_ID_);

Einstellungen in der config.php

Die Datei config.php befindet sich im Verzeichnis /data. Die folgend aufgeführten Felder sind nur verfügbar, wenn die entsprechenden Einstellungen im ModMaker gemacht wurden.

Diese Felder dürfen nicht geändert werden!

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

Wenn Änderungen an diesen Feldern vorgenommen werden, wird das Modul nicht mehr richtig funktionieren.

Einstellungen anpassen

_conf [ catsperpage ]

Bei der Einstellung Kategoriebaum kann hier festgelegt werden wieviele Kategorien in der Administration pro Seite angezeigt werden sollen.

_conf [ imgsize ]

Beim Upload von Bildern werden diese vor dem speichern in verschiedene Größen skaliert und beschnitten. Nachträgliches ändern der Werte hat keine Auswirkung auf bereits hochgeladene Bilder.

seoogimg = Bild für die Open Graph Metadaten
og = Bildgröße
optimage = Bilder in Optionsgruppen (Breite und Höhe einstellbar)
frontimage = Bild der Einstiegsseite (Breite und Höhe einstellbar)
top = Bildgröße für der Kopfbereich
catimage = Kategoriebilder (Breite und Höhe einstellbar)
top = Bildgröße für der Kopfbereich
box = Bildgröße in der Lightbox
view = Bildgröße auf der Seite
Weitere Felder haben die Namen der im ModMaker vergebenen DB-Feldnamen für Bilder. Es sind jeweils Breite und Höhe eines Bildes einstellbar für:
box = Bildgröße in der Lightbox
view = Bildgröße in der Listenansicht
full = Bildgröße auf der Seite
bbcode Bildbreite einstellbar
Wenn im BBCode-Editor Bild-URLs aktiviert werden, werden diese auf diese Breite skaliert.

Für Kategorien- und Datensatzbilder sind weitere beliebige Bildgrößen möglich indem man einfach weitere Array-Keys hinzufügt. Die Größen können nur mit str_replace() im Template aufgerufen werden.

_conf [ urlparams ]

Als URL-Parameter gibt es Einstellungen für:
catid = ID der Kategorie
catorder = ID-Pfad des Kategoriebaums
caturl = Name der Kategorie laut SEO Eingabefeld sprechende URL
topicid = ID des Themas
topicurl = Name des Themas laut SEO Eingabefeld sprechende URL
dataid = ID des Beitrags
dataurl = Name des Beitrags laut SEO Eingabefeld sprechende URL
pager = nächste und vorherige Seiten
load = Eingabemaske aufrufen
Alle Werte können beliebig geändert werden. Jeder Parameter benötigt einen eindeutigen Namen, der Parameter "wbpagefile" ist vergeben und kann nicht genutzt werden. Standard ist _MODULNAME_cat, _MODULNAME_order, _MODULNAME_catname, _MODULNAME_topic, _MODULNAME_topicname, _MODULNAME_data, _MODULNAME_dataname, _MODULNAME_pager und _MODULNAME_load.

_conf [ userinputs ]

Hier stehen alle erzeugten DB-Felder für Besucher-Eingaben. Felder die für Besucher nicht zur Verfügung stehen sollen, können/sollten entfernt werden. Die Felder müssen auch aus den Templates entfernt werden.

_conf [ required ]

Alle hier aufgeführten DB-Felder sind Pflichtfelder für Besucher-Eingaben. Felder die keine Pflichtfelder sein sollen, können entfernt werden.
Für die Administration gibt es keine Pflichtfelder!