Google translator »

(Opens in a new window - öffnet in einem neuen Fenster)

# Kurz-Dokumentation Addon "TemplateFuncs"

### Einsatzbereiche

TemplateFuncs ist ein Addon für CMSimple Templates. TemplateFuncs wird einfach in den Ordner des Templates eingefügt und stellt verschiedene nützliche Funktionen für Templates bereit.

## 1. Systemvoraussetzungen

Voraussetzung ist eine funktionierende Installation von CMSimple_XH 1.2 utf-8 oder höher.

Empfohlen wird CMSimple 4.0 oder höher.

## 2. Installation

1. zip-Datei herunterladen und mit einem geeigneten Programm entpacken
2. Laden Sie den Ordner "templatefuncs" in das Verzeichnis des Templates hoch.

Nun muss noch die Datei "templatefuncs.php" in die template.htm eingebunden werden (ganz oben, noch vor der Doctype Declaration):

<?php include_once($pth['folder']['template'] . 'templatefuncs/templatefuncs.php');?>
<!DOCTYPE html>
...

## 3. Die Funktionen

### 3.1. Die Funktion "wechselnde Newsboxen"

Die Newsbox Funktion zeigt in einer Newsbox fortlaufend nummerierte CMSimple-Seiten an, die mit dem Namen der Newsbox-Seite beginnen (in der Regel "News"), gefolgt von einer fortlaufenden Nummerierung. Beispiel:

- News1001
- News1002
- News1003

Sie können beliebig viele fortlaufend nummerierte Newsbox Seiten anlegen, im weiteren Verlauf dieser Dokumentation beziehe ich mich jedoch auf News1001 - News1003. Mit den grossen Zahlen sollen Konflikte mit bereits bestehenden Newsboxen auf der Seite vermieden werden.

Der Wechsel der Newsboxen erfolgt mit jedem Seitenaufruf, egal ob eine neue Seite aufgerufen wird oder ein Reload der aktuellen Seite erfolgt.

#### Verwendung im Template

Newsboxen werden normalerweise im Template (template.htm) eingefügt, an der Stelle, wo die Newsbox erscheinen soll.

##### Geordneter, fortlaufender Wechsel

Der folgende Addon Aufruf zeigt die Newsbox Seiten News1001 - News1003 nacheinander im Wechsel an:

<?php echo tf_newsboxes('News',1001,1003); ?>

#### Zufälliger Wechsel

Der folgende Addon Aufruf zeigt die Newsbox Seiten News1001 - News1003 im zufälligen Wechsel (random) an:

<?php echo tf_newsboxes('News',1001,1003,'random'); ?>

So können beliebig viele verschiedene Newsboxen abwechselnd, fortlaufend oder zufällig, angezeigt werden.

### 3.2. Die Funktion "wechselnde Bilder"

Mit dieser Funktion können wechselnde Bilder oder Hintergrundbilder (per inline CSS in der template.htm) im Template angezeigt werden. Der Bildwechsel erfolgt mit jedem Seitenaufruf, egal ob eine neue Seite aufgerufen wird oder ein Reload der aktuellen Seite erfolgt.

Die Bilder liegen in in einem Unterordner des Ordners "templatefuncs", z. B. "templatefuncs/bgheader/" für wechselnde Hintergrundbilder im Header.

Laden Sie einfach Ihre Bilddateien in den Ordner "templatefuncs/bgheader/" hoch, und sie werden in den Bildwechsel mit einbezogen. Wenn Sie ein Bild entfernen wollen, löschen Sie es einfach. Die Funktion "wechselnde Bilder" ermittelt selbstständig die Anzahl der Bilder im Ordner.

Der Ordner, in dem die Bilder liegen, muss im Funktionsaufruf angegeben werden:

<?php echo tf_images('bgheader'); ?>

Hier ein Beispiel für wechselnde Hintergrundbilder im Header:

<div id="header" style="background: #fff url(<?php echo tf_images('bgheader');?>) no-repeat;">
...
</div>

#### Zufallswiedergabe (random)

Für die Zufallswiedergabe fügen Sie den optionalen Parameter "random" zum Funktionsaufruf hinzu:

<?php echo tf_images('bgheader','random'); ?>

### 3.3. Die Funktionen für "special Links mit Icons"

Mit diesen Funktionen können spezielle CMSimple-Links mit Miniaturbildern (Icons) eingebunden werden.

<?php echo tf_homelink('homelink.gif'); ?>
<?php echo tf_printlink('printlink.gif'); ?>
<?php echo tf_mailformlink('mailformlink.gif'); ?>
<?php echo tf_sitemaplink('sitemaplink.gif'); ?>
<?php echo tf_previouspage('prev.gif'); ?>
<?php echo tf_nextpage('next.gif'); ?>
<?php echo tf_top('top.gif'); ?>

Die Icons liegen im Verzeichnis "templatefuncs/icons/". Der Dateiname und das Dateiformat müssen im Funktionsaufruf angegeben werden (dateiname.gif, dateiname.png usw.)

Die Icons können mit folgenden CSS Klassen in der stylesheet.css des Templates gestaltet werden (z. B. Abstände herstellen):

img.tf_homelink_icon {margin-right: 16px;}
img.tf_printlink_icon {margin-right: 16px;}
img.tf_mailformlink_icon {margin-right: 16px;}
img.tf_sitemaplink_icon {margin-right: 16px;}
img.tf_prev_icon {margin: 0 16px;}
img.tf_next_icon {margin: 0 16px;}
img.tf_top_icon {margin: 0 16px;}

### 3.4. Die Funktion openMenu()

Mit dieser Funktion können Sie ein aufgeklapptes Menu erzeugen. Es können optional 2 Parameter angegeben werden, für menulevel "min, max":

<?php echo openMenu(1,2); ?>

Im Normalfall reicht aber der einfache Aufruf, menulevel wie in der Konfiguration festgelegt:

<?php echo openMenu(); ?>

### 3.5. Die Funktion tf_locator()

Mit dieser Funktion können Sie einen alternativen Locator (Breadcrumb Navigation) mit definierbarem Trennzeichen (Delimiter) erzeugen.

Dieser Funktionsaufruf verwendet das Sonderzeichen » als Trennzeichen:

<?php echo tf_locator('&raquo;'); ?>

Sie können auch ein Bild referenzieren. Dieser Funktionsaufruf verwendet die Datei locator.png im Verzeichnis .../templatefuncs/icons/ (im Templateordner) als Trennzeichen:

<?php echo tf_locator('<img src="' . $pth['folder']['template'] . 'templatefuncs/icons/locator.png" alt="">'); ?>

### 3.6. Die Funktion tf_contentPlus()

Diese Funktion ähnelt der Funktion Newsbox. Es wird jedoch nicht eine bestimmte Seite angezeigt, sondern eine Unterseite der aktuellen Seite. Standard Seitenname der angezeigten Unterseite ist "tfContentPlus".

Standard Aufruf in der template.htm:

<?php echo tf_contentPlus(); ?>

Die Funktion hat 2 optionale Parameter:

<?php echo tf_contentPlus('Seitenname', 'CSS_Klasse'); ?>

Seitenname: Der Name der anzuzeigenden Seite, Standard: tfContentPlus
CSS_Klasse: Die CSS Klasse der umgebenden divs, Standard: tf_cplus

Die Ausgabe wird mit 2 divs umgeben, das innere div bekommt die Klasse mit einem angehängten "In", also im Standardfall tf_cplus und tf_cplusIn.