Doku: 1 - Index (Startseite)

[FrankW]

Hallo,
wie ja schon öfters erwähnt tun wir uns mit einer Dokumentation noch etwas schwer.
Zum einen, weil wir eigentlich täglich an nützlichen Updates arbeiten und auf der anderen Seite weil gerade die Möglichkeiten in den Templates nahezu unbegrenzt sind.
Eine Dokumentation wird also nie vollständig und 100% aktuell sein, aber bei allem was noch kommen wird werden wir unserem Basissystem treu bleiben, sprich jede Minute die ihr euch damit beschäftigt wird sich dauerhaft lohnen.
Ich fange daher jetzt hier mal zwanglos an und hoffe auf eurer Feedback, damit die Arbeit nicht vergebens ist.

Was auch immer ihr seht oder lest, lasst euch nicht abschrecken - all die vielen Worte täuschen darüber hinweg, dass ihr im Grunde eure Seite wie bisher auch mit HTML gestalten könnt.

Ok, fangen wir an:
Die Templates basieren auf der Smarty Templates Engine, für die es auch eine deutsche Doku gibt.
Wenn jemand also etwas nicht versteht, etwas ausprobieren möchte oder einfach nur Anregungen sucht kann er auch gerne dort einmal reinsehen: http://smarty.php.net/manual/de/einem
Editieren kann man die Templates mit HTML-Editoren oder wie z.B. von mir bevorzugt mit einem einfachen
Text-Editor.

Hilfstemplate:
Alle Templates die mit "{include file="Funktionsname.html"} in andere Templates included werden sind sogenannte "Hilfstemplates".
D.h. der darin enthaltene Code kann auch direkt in das Haupttemplate geschrieben werden!
Die Ausgliederung in das Hilfstemplate dient nur der Vereinfachung bei sich wiederholenden Funktionen oder zur besseren Darstellung.
Jeder kann auch eigene Hilfstemplates, wie am Beispiel "footer.html" gezeigt anlegen.

Individualisierung:
Seid kreativ, macht euch Gedanken, fragt uns und geht eigene Wege - maximale Anzeige ist nicht immer der beste Weg !

Das index Template:
Folgende Funktionen können über die config komplett ausgeschaltet werden (default ist ein=1), müssen dann aber noch aus dem Template entfernt werden:

define('AFFILINETKAT_INDEX','1');
Diese Funktion sucht die affilinet Hauptkategorien raus um sie einzeln und ohne Unterkategorien anzuzeigen.
Eine beliebte Funktion um ein "Hauptmenu" auf den Seiten anzuzeigen, welches im Hilfstemplate
"affilinetMain.html" ausgegliedert ist und überall mit {include file="affilinetMain.html"} oder eben direkt
angezeigt werden kann.
Die Funktion ist standartmässig an und verbraucht damit Zeit und Ressourcen, wer sie also irgendwo nicht
braucht möge sie dort bitte in der config ausschalten (=0).
Ich denke hier vor allem an die Index, wo es in meinen Augen wenig Sinn macht den ganzen Kategoriebaum UND die Hauptkategorien anzuzeigen.
Zudem verändern sich diese Kategorien später kaum noch und der Aufbau dürfte auf allen Partnerseiten gleich
sein. Es macht also evtl auch Sinn die Links in reinem HTML zu schreiben und mit einem eigenen "Wording" zu
versehen.
Die Funktion kann nicht genutzt werden, wenn man nur ausgewählte Shops anzeigen will.

define('GETSHOPLIST_INDEX','1');
Hier mit kann die Generierung des "Shop DrowpDown" deaktiviert werden. die Funktion und das zugehörige
Hilfstemplate werden passenden mit {include file="getShopList.html"} eingebunden.
In der Index liegt dieser Block standartmässig ganz oben (evtl. ungünstig ?), ist bei vielen Partnerschaften
sehr groß und enthält er auf Dauer große Gleichteile mit anderen Seiten.
Gerade wenn man mehrere Seiten baut empfehle ich hier ein wenig mit den Möglichkeiten zu "spielen" und auch mal ernsthaft darüber nachzudenken, ob der Besucher die Funktion überall nutzen wird.
Die Funktion kann nicht genutzt werden, wenn man nur ausgewählte Shops anzeigen will. In dem Fall muss man sie manuell nachbauen.

define('GETCATEGORYLIST_INDEX','1');
Die Funktion gibt es in der Index, den Shop Eingangsseiten und den Kategorieseiten.
Auf und von der Index abgehend gibt es die Besonderheit, dass eben keine ShopID zugeordnet werden kann und hier die ShopID 0 = affilinet Kategoriestrukutr verwendet wird.
Einbindung direkt oder mit dem Hilfstemplate: {include file="getCategoryList.html"}.
Ähnlich wie bei den vorherigen Funktionen mag es Sinn machen darauf zu verzichten und auch hier sollte sich
jeder bewusst sein, dass u.U. die Startseite der eigenen Domain bereits mit einem hohen Anteil an Gleichteilen
beginnt.
Hier ein paar Denkanstösse:
- durch den dynamischen Aufbau haben alle Seiten die gleiche Struktur und Verlinkung auf der Index.
- bei einem manuellem Aufbau könnte man die Links benennen und verteilen wie man will...
- brauche ich das Menu überhaupt ? (Google Design)
- brauche ich alle Unterkategorien (viele viele Links) oder reduziere ich die Anzahl (config: define("NO_OF_SUBCATEG" , '15')
- wenn ich eine Seite mit nur ausgewählten Shops baue kann ich die affilinet Struktur meist nicht mehr nehmen
und kann die Funktion deaktivieren.
- brauche ich 3 Spalten und muss der Block in der Mitte sitzen ?

Weitere Besonderheiten anhand der Index erklärt:
{$smarty.const.BASE_URL}
zeigt immer die URL an, unter der der Affilinator installiert ist.
D.h. alle Links sind standartmässig absolut angegeben, um das Unterverzeichnis frei bestimmen zu können. Achtet darauf, wenn ihr Links ändert und Unterverzeichnisse verwendet.
Gerade bei Bildern sorgt mod_rewrite oft für Verwirrung.

{literal}
<script type="text/javascript">
<!--
bookmarkNetscape = 'Drücken Sie Strg + D, um oShops.info zu Ihren Favoriten hinzuzufügen';
-->
</script>
<script src="js/bookmark.js"><!-- empty --></script>
{/literal}
{literal}Der code hier wird von Smarty ignoriert.{/literal}
Das Javascript wird verwendet um eine Seite den Favoriten zuzufügen, hat aber mit mod_rewrite in
Unterverzeiuchnissen auch seine Probleme und wird daher wieder entfernt / ersetzt.
Es bleibt jedem selbst überlassen ob er es nutzt.

{include file="searchbox.html"}
Hilfstemplate für die Suchbox, wird extra erklärt.

{include file="lastKeywords.html"}
Hilfstemplate zur Darstellung der zuletzt gesuchten Begriffe, wird extra erklärt.

{include file="lastVisitedProducts.html"}
Hilfstemplate um die zuletzt gecachten Produkte anzuzeigen, wird auch extra erklärt.
Ich möchte aber anmerken, dass durchaus Sinn machen kann die Darstellung von Seite zu Seite zu ändern, sprich
eben nicht immer das Hilfstemplate zu verwenden.

{include file="getRandomShops.html"}
Hilfstemplate um eine zufällige Liste von Shops anzuzeigen.
Geht nur, wenn die Funktion GETSHOPLIST auf der Seite eingeschaltet ist.
Über den Sinn mag man streiten, ich dachte mir dabei eine Art "Shop des Tages" Anzeige, Zufallseffekte,
automatisch rotierender Content, alternative Verlinkung....

{include file="news_preview.html"}
Hilfstemplate für die Newsvorschau, wird auch extra erklärt.
Auch hier mag es sinnvoll sein gerade auf der Index auf das Hilfstemplate zu verzichten und eine individuelle
Anzeige zu wählen.

{include file="footer.html"}
Ein klassisches Hilfstemplate, dass eigentlich keine Funktion enthält, aber z.B. mit {$smarty.const.BASE_URL}
auch Variablen enthalten kann.
Jeder kann sich beliebig viele solcher Templates anlegen, um sich immer wieder wiederholende Seitenteile wie
z.B. den Footer-Bereich eben nur in einer Datei zu pflegen.

Gruß
Frank