Dokumentation Categorywalker

Aus DeDi-Help

(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
Version vom 19:34, 19. Aug. 2004 (bearbeiten)
Mistral (Diskussion | Beiträge)
K (Vorwort)
← Zum vorherigen Versionsunterschied
Version vom 19:57, 19. Aug. 2004 (bearbeiten) (Entfernen)
Mistral (Diskussion | Beiträge)
K
Zum nächsten Versionsunterschied →
Zeile 13: Zeile 13:
=== Ziel des Moduls === === Ziel des Moduls ===
-Der Categorywalker bringt zwar eine Menge an Funktionalitt, mit die auch in anderen Modulen vorliegen,+Der Categorywalker bringt zwar eine Menge an Funktionalitt, mit die auch in anderen Modulen vorliegen, doch ist es nicht Sinn dieses Moduls sich Spezialisiert auf eine Funktion (z.B.: NewsTeaser) zu beschrnken.
-doch ist es nicht Sinn dieses Moduls sich Spezialisiert auf eine Funktion (z.B.: NewsTeaser)+ 
-zu beschrnken.+Vielmehr soll der Umfang und die Mglichkeiten des Categorywalker dazu dienen Aufgaben zu bewltigen, mit anderen Modulen nur schwer oder nicht vollstndig (weil zu Spezialisiert) umgesetzt werden knnen.
-Vielmehr soll der Umfang und die Mglichkeiten des Categorywalker dazu dienen Aufgaben zu bewltigen, mit anderen Modulen nur schwer oder nicht vollstndig (weil zu Spezialisiert)+
-umgesetzt werden knnen.+
=== Gltigkeit dieser Dukumentation === === Gltigkeit dieser Dukumentation ===
Diese Dokumentation gilt ab Version 0.64 bis 0.7, alle anderen Versionen werden nicht Supportet! Diese Dokumentation gilt ab Version 0.64 bis 0.7, alle anderen Versionen werden nicht Supportet!
 +
Alle nderungen seit Version 0.6 sind bercksichtigt und in diese Dokumentation eingeflossen. Alle nderungen seit Version 0.6 sind bercksichtigt und in diese Dokumentation eingeflossen.
 +
Fr die Light-Version gibt es eine kleinere angepasste Dokumentation, da dort nicht alle Features Fr die Light-Version gibt es eine kleinere angepasste Dokumentation, da dort nicht alle Features
Enthalten sind. In der Dokumentation verwendete Abkrzungen wie z.B.: 2.2 oder 4.2.2 beziehen sich auf Enthalten sind. In der Dokumentation verwendete Abkrzungen wie z.B.: 2.2 oder 4.2.2 beziehen sich auf
Zeile 39: Zeile 39:
=== Standart Installation als XML-Modul === === Standart Installation als XML-Modul ===
Standart Installation als XML-Modul: Standart Installation als XML-Modul:
 +
Voraussetzung ist hierbei das Sie das Modul vom DeDi-Modul Repository heruntergeladen haben. Voraussetzung ist hierbei das Sie das Modul vom DeDi-Modul Repository heruntergeladen haben.
-Nach der Anmeldung im Backend, ffnen Sie ber Design->Module die 'Modul' bersichtsseite.+ 
-Klicken Sie auf die Schaltflche Durchsuchen..., in dem unteren Bereich der Seite 'Modul uploaden'.+Nach der Anmeldung im Backend, ffnen Sie ber '''Design->Module''' die 'Modul' bersichtsseite.
-Whlen Sie nun in dem sich ffnenden 'Datei auswhlen' Fenster+ 
-das Modul 'Categorywalker.dedimod' aus.+Klicken Sie auf die Schaltflche '''Durchsuchen...''', in dem unteren Bereich der Seite 'Modul uploaden'.
 + 
 +Whlen Sie nun in dem sich ffnenden 'Datei auswhlen' Fenster das Modul 'Categorywalker.dedimod' aus.
 + 
Besttigen Sie die Auswahl mit Klick auf 'ffnen' und starten den Upload mit Klick auf die Schaltflche 'Modul uploaden' (Diskettensymbol, rechts). Besttigen Sie die Auswahl mit Klick auf 'ffnen' und starten den Upload mit Klick auf die Schaltflche 'Modul uploaden' (Diskettensymbol, rechts).
 +
Bei erfolgreichem Upload, wird das neue Modul sofort in der Modulbersicht angezeigt. Bei erfolgreichem Upload, wird das neue Modul sofort in der Modulbersicht angezeigt.
 +
Sie knnen nun in einem Template das neue Modul einstellen. Sie knnen nun in einem Template das neue Modul einstellen.
Zeile 51: Zeile 57:
=== Installation als Developer-Modul === === Installation als Developer-Modul ===
Installation als Developer-Modul: Installation als Developer-Modul:
 +
Voraussetzung ist wie bei 2.2, oder das Sie das Modul aus dem Entwicklerforum kopiert haben. Voraussetzung ist wie bei 2.2, oder das Sie das Modul aus dem Entwicklerforum kopiert haben.
-Nach der Anmeldung im Backend, ffnen Sie ber Design->Module die Modulbersichtsseite.+ 
-Klicken Sie auf neues Modul, es ffnet sich die 'Modul bearbeiten' Seite.+Nach der Anmeldung im Backend, ffnen Sie ber '''Design->Module''' die Modulbersichtsseite.
-Hier fgen Sie den Code in die entsprechenden Felder ein. Zur besseren bersicht geben Sie dem Versionsnamen eine Unterzahl (z.B.: 0.6y.x-dev)+ 
-und benennen die Kategorie 'Develope'.+Klicken Sie auf '''neues Modul''', es ffnet sich die 'Modul bearbeiten' Seite.
 + 
 +Hier fgen Sie den Code in die entsprechenden Felder ein. Zur besseren bersicht geben Sie dem Versionsnamen eine Unterzahl (z.B.: 0.6y.x-dev) und benennen die Kategorie 'Develope'.
 + 
Speichern Sie das Modul. Das neue Modul wird sofort in der Modulbersicht angezeigt. Speichern Sie das Modul. Das neue Modul wird sofort in der Modulbersicht angezeigt.
 +
Sie knnen nun in einem Template das neue Modul einstellen. Sie knnen nun in einem Template das neue Modul einstellen.
 +
Achtung: Developer-Module erzeugen einen Warnhinweis im Backend bei der Einbindung Achtung: Developer-Module erzeugen einen Warnhinweis im Backend bei der Einbindung
des Moduls in ein Template! des Moduls in ein Template!
 +
DIES IST EINE ENTWICKLERVERSION. SIE IST NICHT FR DEN PRODUKTIVEN EINSATZ GEEIGNET !!! DIES IST EINE ENTWICKLERVERSION. SIE IST NICHT FR DEN PRODUKTIVEN EINSATZ GEEIGNET !!!
Zeile 74: Zeile 87:
=== Allgemeines === === Allgemeines ===
-Der Categorywalker durchsucht die Datenbank. ber die Angabe von Container, Startoptionen+Der Categorywalker durchsucht die Datenbank. ber die Angabe von Container, Startoptionen (Startseite, On-/Offline) und Suchmuster (4.3) kann man die Suche eingrenzen und komfortabel das Suchergebnis beeinflussen.
-(Startseite, On-/Offline) und Suchmuster (4.3) kann man die Suche eingrenzen und komfortabel+ 
-das Suchergebnis beeinflussen.+
Die Ausgabe erfolgt ber 4 Templates, die einzeln definiert werden knnen. Die Ausgabe erfolgt ber 4 Templates, die einzeln definiert werden knnen.
-Zustzlich generiert der Categorywalker eine zusammenhngende Navigation die es bequem macht+ 
-das Ergebnis auf mehrere Seiten aufzuteilen (Galery). Die Navigation kann optional floaten das heit+Zustzlich generiert der Categorywalker eine zusammenhngende Navigation die es bequem macht das Ergebnis auf mehrere Seiten aufzuteilen (Galery). Die Navigation kann optional floaten das heit die Anzeige der Navigation wird auf z.B.: maximal 20 Navigationspunkte begrenzt und die Nummerierung wandert in einem Bereich Rechts und Links um die aktuelle Seite mit.
-die Anzeige der Navigation wird auf z.B.: maximal 20 Navigationspunkte begrenzt und die Nummerierung+
-wandert in einem Bereich Rechts und Links um die aktuelle Seite mit.+
=== Templates === === Templates ===
Die Templates werden wie normales Html behandelt (also sind Html-Tags erlaubt). Die Templates werden wie normales Html behandelt (also sind Html-Tags erlaubt).
 +
Es gibt ein 'Top-Artikel' Template welches separat angesprochen werden kann um einen Artikel auf der Startseite hervorzuheben. Es gibt ein 'Top-Artikel' Template welches separat angesprochen werden kann um einen Artikel auf der Startseite hervorzuheben.
 +
Die beiden 'Content1' und 'Conten2' Templates wiederum wiederholen in einer Schleife jeweils die gegebene Anzahl von Artikel/Suchergebnissen und das vllig unabhngig voneinander. Die beiden 'Content1' und 'Conten2' Templates wiederum wiederholen in einer Schleife jeweils die gegebene Anzahl von Artikel/Suchergebnissen und das vllig unabhngig voneinander.
-Das letzte Template 'Merge' ist fr den Gesamtaufbau der Anzeige verantwortlich,+Das letzte Template 'Merge' ist fr den Gesamtaufbau der Anzeige verantwortlich, hier werden die anderen 3 Templates zu einer Seite zusammengefgt.
-hier werden die anderen 3 Templates zu einer Seite zusammengefgt.+
Innerhalb dieser Templates sind auch einige Scripttags erlaubt die eine genaue Positionierung und Wiederholung von Content-Variablen erlauben. Innerhalb dieser Templates sind auch einige Scripttags erlaubt die eine genaue Positionierung und Wiederholung von Content-Variablen erlauben.
-Die Scripttags werden in 4.2.1 erlutert.+Die Scripttags werden in 4.2 unter 'ScriptTags' erlutert.
Zeile 129: Zeile 140:
* Verbindungs Template, das Verbindungs Template (Merge) verbindet die anderen Templates zu einer einheitlichen Ausgabe. * Verbindungs Template, das Verbindungs Template (Merge) verbindet die anderen Templates zu einer einheitlichen Ausgabe.
* Anchors, das sind Anker im Html-Code. * Anchors, das sind Anker im Html-Code.
 +
=== Templates === === Templates ===
Templates knnen nur einzelne Variablen oder auch ganze Html-Seiten (Vorlagen) enthalten. Templates knnen nur einzelne Variablen oder auch ganze Html-Seiten (Vorlagen) enthalten.
 +
Die Ausgabe von Variablen wird ber die Scripttags gesteuert. Dabei lassen diese Tags Verschachtelung und Abhngigkeiten zu, um auch die verschiedensten Inhalte Korrekt darzustellen. Die Ausgabe von Variablen wird ber die Scripttags gesteuert. Dabei lassen diese Tags Verschachtelung und Abhngigkeiten zu, um auch die verschiedensten Inhalte Korrekt darzustellen.
 +
'''ScriptTags''' '''ScriptTags'''
Zeile 159: Zeile 173:
Die Scripttags Legende: Die Scripttags Legende:
- 
* {text}, ist der 1. text-Typ in einem Content * {text}, ist der 1. text-Typ in einem Content
Zeile 186: Zeile 199:
* {file_target:x}, -> siehe {img_desc:x} * {file_target:x}, -> siehe {img_desc:x}
* {url_to_articel}, ist der interne Link zu dem gefundenen Content/Artikel * {url_to_articel}, ist der interne Link zu dem gefundenen Content/Artikel
-* {exist yyy[:x]}/{/exist}, ein Konstrukt das ein Variabelenabfrage fr yyy:x (wobei :x optional ist!) ausfhrt und nur bei Vorhandensein der innere Code (Html/Script) ausgefhrt wird. Man kann somit im Template sicherstellen das ein Layout wie im Beispiel:+* {exist yyy[:x]}/{/exist}, ein Konstrukt das ein Variabelenabfrage fr yyy:x (wobei :x optional ist!) ausfhrt und nur bei Vorhandensein der innere Code (Html/Script) ausgefhrt wird. Man kann somit im Template sicherstellen das ein Layout wie im Beispiel: <br /><nowiki>{exist text:3}<b>{text:3}</b><br>{/exist} </nowiki><br />nicht ausgefhrt wird, wenn die Variable nicht existiert oder leer ist.
-** {exist text:3}<b>{text:3}</b><br>{/exist}+* {loop yyy}/{/loop}, ein Konstrukt das eine Schleife um den Contenttype yyy (ohne :x) ausfhrt, man kann somit im Template ein Layout wie im Beispiel: <br /><nowiki><ul>{loop text}<li><b>{text}</b></li>{/loop}</ul> </nowiki><br />mehrfach durchlaufen und alle Inhalte von z.B.: {text} (text:1, text:2, text:3 usw.) werden wiedergeben.
-** nicht ausgefhrt wird, wenn die Variable nicht existiert oder leer ist.+
-* {loop yyy}/{/loop}, ein Konstrukt das eine Schleife um den Contenttype yyy (ohne :x) ausfhrt, man kann somit im Template ein Layout wie im Beispiel:+
-<ul>{loop text}<li><b>{text}</b></li>{/loop}</ul>+
-mehrfach durchlaufen und alle Inhalte von z.B.: {text} (text:1, text:2, text:3 usw.) werden wiedergeben.+
* {each xxx}, ist eine vereinfachte Form von {loop xxx}{xxx}{/loop} * {each xxx}, ist eine vereinfachte Form von {loop xxx}{xxx}{/loop}
* Cuttexte, das Attribut [cut:xy] ist eine optionale Einstellung (ohne die eckigen [...] Klammern) um den Text auf xy Zeichen zu krzen! z.B.: {text:1 cut:100} - Damit kann man Teaser erzeugen die 100 Zeichen lang sind Minus das Letzte (berhngige) Wort aus dem erstem Textfeld einer Seite. * Cuttexte, das Attribut [cut:xy] ist eine optionale Einstellung (ohne die eckigen [...] Klammern) um den Text auf xy Zeichen zu krzen! z.B.: {text:1 cut:100} - Damit kann man Teaser erzeugen die 100 Zeichen lang sind Minus das Letzte (berhngige) Wort aus dem erstem Textfeld einer Seite.
Zeile 206: Zeile 215:
''Beispiel1:'' ''Beispiel1:''
- - das Beispiel gibt immer den ersten gefundenen text-Typ + textarea:1 aus, und nur wenn vorhanden auch text:2 + textarea:1 und text:3 + textarea:1 inklusive der umfassenden <b>...</b><br> Tags+<nowiki>das Beispiel gibt immer den ersten gefundenen text-Typ + textarea:1 aus, und nur wenn vorhanden auch text:2 + textarea:1 und text:3 + textarea:1 inklusive der umfassenden <b>...</b><br> Tags</nowiki>
- <b>{text}{textarea:1}</b><br>+ 
 + <nowiki><b>{text}{textarea:1}</b><br></nowiki>
{exist text:2} {exist text:2}
- <b>{text:2}{textarea:1}</b><br>+ <nowiki><b>{text:2}{textarea:1}</b><br></nowiki>
{/exist} {/exist}
{exist text:3} {exist text:3}
- <b>{text:3}{textarea:1}</b><br>+ <nowiki><b>{text:3}{textarea:1}</b><br></nowiki>
{/exist} {/exist}
Zeile 218: Zeile 228:
''Beispiel2:'' ''Beispiel2:''
- - das Beispiel zeigt den Aufbau einer Liste mit Artikel-Teasern + Bild+das Beispiel zeigt den Aufbau einer Liste mit Artikel-Teasern + Bild
- <ul>+ 
 + <nowiki><ul></nowiki>
{loop text} {loop text}
- <li><b>{img}{text}</b></li>+ <nowiki><li><b>{img}{text}</b></li></nowiki>
{/loop} {/loop}
- </ul>+ <nowiki></ul></nowiki>
 + 
=== Suchmuster=== === Suchmuster===
Zeile 232: Zeile 244:
-Der Categorywalker kann als Newsgrabber, DokuWeb, Redaktionstool oder Galery eingesetzt werden. Sicherlich gibt es noch viele andere Mglichkeiten, das auszuprobieren ist ja Ihr Job ;)+Der Categorywalker kann als Newsgrabber, DokuWeb, Redaktionstool oder Galery eingesetzt werden.
 + 
 +Sicherlich gibt es noch viele andere Mglichkeiten, das auszuprobieren ist ja Ihr Job ;)
 + 
Weitere, ausfhrliche Beispiele siehe Anhang A. Weitere, ausfhrliche Beispiele siehe Anhang A.
Zeile 240: Zeile 255:
Der Categorywalker wird noch einige Updates erfahren, welcher Art knnen Sie der Doku entnehmen. Der Categorywalker wird noch einige Updates erfahren, welcher Art knnen Sie der Doku entnehmen.
 +
Die v0.64.4 ist die aktuelle Stabel-Version, bis zur v0.7 werden zumindest einige Code Optimierungen durchgefhrt. Bis zur DeDi 1.0 wird die Version 0.8 released. Die v0.64.4 ist die aktuelle Stabel-Version, bis zur v0.7 werden zumindest einige Code Optimierungen durchgefhrt. Bis zur DeDi 1.0 wird die Version 0.8 released.

Version vom 19:57, 19. Aug. 2004

Persönliche Werkzeuge