Die Konfiguration des Systems
Die Konfigurationsdatei
Alle Einstellungen am System werden zentral in der Konfigurationsdatei
config/config.php
vorgenommen.
In dieser Datei wird die systemweite Konfigurationsvariable $GLOBALS[ 'yap' ][ 'config' ] gesetzt.
Ein Ausschnitt aus der Konfigurationsdatei zeigt, wie die Werte zugewiesen werden:
$GLOBALS['yap']['config'] = array(
"homepage" => "Homepage", // name of rootpage in yappadoo(home)
"pagename" => "Dokusystem", // name of your page (title)
....
);
In jeder Zeile finden sich einfach zu ändernde Variablen-Wert-Zuweisungen.
Sollten einzelne Variablen nicht in Ihrer Konfigurationsdatei gesetzt werden, werden für diese Standardwerte aus der Datei "config/default/config.php" gesetzt.
Die Konfigurationsparameter
Die Datei enthält zu jedem Konfigurationsparameter eine kurze Beschreibung (in englischer Sprache). An dieser Stelle möchten wir Ihnen die einzelnen Einstellungen detaillierter beschreiben.
Die einzelnen Parameter sind in der Datei so angeordnet, daß häufig verwendete und unkritischere Einstellungen am Anfang der Datei stehen.
homepage
Tragen Sie hier den Namen Ihrer Homepage im yappadoo-System ein. Auf diese Seite wird beim erstmaligen Aufruf gesprungen oder als als "Startseite" verwiesen.
pagename
Geben Sie hier den Namen Ihres Webprojektes an. Dieser Name erscheint im Titel des Browsers, wenn eine Seite aus dem System angezeigt wird.
timeformat
Zeichenkette für die Anzeigeformatierung von Zeit und Datum, mögliche Parameter innerhalb dieses Strings finden Sie in der PHP-Dokumentation zum Befehl makedate
Dem deutschen Datumsformat entspricht "d.m.Y H:i".
Standardeinstellung ist "Y-m-d H:i"
root
Geben Sie hier den (Web-)Namen der Seite ein, welche Ihr yappadoo-System integriert. Die hier eingegebene Zeichenkette wird in allen vom System erzeugten Links vorangestellt. Integriert Ihr Webprojekt das yappadoo-System auf einer Ihrer Seiten nach Übergabe eigener http-Parameter, könnten Sie hier beispielsweise "cms.php?load=yappa&mypara=123" notieren. Wenn Sie das System über die standardmäßig angelegte index.php"-Seite des yappadoo-Systems aufrufen, wird hier einfach "index.php?" notiert.
Standardeinstellung ist "index.php?"
printroot
Hält die relative Adresse der Webseite, welche die Druckausgabe der Seiten erzeugt. Wenn Ihr Projekt yappadoo über eine "eigene" Seite integriert und der yappadoo-Systemordner "yappadoo" mit der Datei "print.php" unterhalb dieser Seite liegt, dann tragen Sie hier beispielsweise "yappadoo/print.php?" ein. Nutzen Sie die "index.php"-Datei innerhalb des "yappadoo"-Verzeichnisses zur Seitenausgabe (mittels Template), geben Sie hier "print.php?" an.
Standardeinstellung ist "print.php?"
public
Dieser Schalter beeinflußt die Benutzerverwaltung des Systems.
Geben Sie hier "1" an, wenn das System neue Benutzeranmeldungen aus dem Netz ermöglichen soll oder ob neue Benutzer nur durch Systemadministratoren von aus dem System heraus erfolgen können ("0").
Die Benutzergruppe, welcher selbstständig angemeldete Nutzer zugeordnet werden, können Sie über die Variable "reggroup" einstellen (s.u.)
Standardeinstellung ist "0"
non_public_audc
Dieser Schalter beeinflußt die Benutzerverwaltung des Systems in Verbindung mit dem Schalter "public
".
Geben Sie hier "1" an, wenn das System angemeldeten Benutzern auch dann die eigenständige Verwaltung ihrer Nutzerdaten (Passwort, E-Mail ...) erlauben soll, wenn "public
" auf "0" gesetzt ist (d.h. während eigenständige Nutzeranmeldungen nicht möglich sind).
Standardeinstellung ist "1"
openmode
Wenn diese Variable "1" gesetzt ist, ist jeder Besucher automatisch Administrator und kann die Seiteninhalte beliebig ändern. Diese Einstellung kann z.B. für kleine Dokusysteme im Intranet sinnvoll eingesetzt werden (beachten Sie jedoch auch die Möglichkeiten mittels der Konfigurationsvariable "ipident"!).
Für die allermeisten Fälle sollte diese Variable jedoch "0" gesetzt sein.
Standardeinstellung ist "0"
stealthmode
Mittels dieser Einstellung kann das Administrationsmenü auf den Seiten unterdrückt werden. Ist dieser Wert auf "1" gesetzt, wird das Administrationsmenü nur Benutzern aus den Benutzergruppen angezeigt, denen die Ansicht und Nutzung explizit erlaubt ist. Die zugehörige Einstellung kann in den Gruppeneigenschaften gesetzt werden.
Standardeinstellung ist "0"
requestmail
Ist dieser Wert "1", muss in jedem gültigen Benutzeraccount eine Kontakt-E-Mailadresse hinterlegt sein. So wird z.B. bei der Anmeldung eines neuen Benutzers die Angabe einer E-Mail erzwungen.
Standardeinstellung ist "1"
automenu
Dieser Parameter schaltet die automatische Navigations-Menüerzeugung an oder aus.
Ist dieser Wert auf "1" gesetzt, wird das automatische Navigationssystem erzeugt und steht mit den Aufruf der Systemfunktion "yap_renderPageStructure()" zur Verfügung.
Falls das Menü nicht benötigt wird, kann die Verwaltung zur Resourcenschonung abgeschaltet werden.
Standardeinstellung ist "1"
showlastmod
Dieser Parameter schaltet die Möglichkeit zur Anzeige des Datums der letzten Bearbeitung einer Seite ein oder aus.
Ist dieser Wert auf "1" gesetzt, wird das Datum der letzten Bearbeitung verarbeitet und in die Ausgabe der Systemfunktion "yap_renderFootLine()" eingefügt.
Standardeinstellung ist "1"
showprocesstime
Dieser Parameter schaltet die Möglichkeit zur Anzeige der Dauer der Seitenausgabe durch das System ein oder aus.
Ist dieser Wert auf "1" gesetzt, wird die benötigte Zeit zur Seitenverarbeitung in die Ausgabe der Systemfunktion "yap_renderFootLine()" eingefügt.
Standardeinstellung ist "1"
showprintlink
Dieser Parameter schaltet die Möglichkeit zur Anzeige des "Seite drucken"-Links auf der Ausgabeseite ein oder aus.
Ist dieser Wert auf "1" gesetzt, wird der Link in die Ausgabe der Systemfunktion "yap_renderPrintLink()" eingefügt.
Standardeinstellung ist "1"
Die folgenden Konfigurationseinstellungen sollten nur in begründeten Fällen geändert werden
ipident
Dieser Parameter schaltet die Möglichkeit zur automatischen Benutzererkennung anhand der Zugriffs-IP. Jedem Nutzer kann in seinem Profil eine IP-Adresse zugeordnet werden. Anhand der Zugriffs-IP kann der Nutzer automatisch erkannt und gesetzt werden. Dieses Verfahren ist sehr unsicher und sollte nur mit Bedacht eingesetzt werden! Nützlich kann dieses Feature in abgesicherten Intranetanwendungen mit Nutzern fester IP´s sein.
Standardeinstellung ist "0"
adminuser
Name des Standard-Systemadministrator-Benutzeraccounts. Beachten Sie die Namenskonventionen des Systems.
Standardeinstellung ist "SuperUser"
adminpassword
Standard-Passwort des Standard-Systemadministrator-Benutzers. Das Passwort kann vom Nutzer in den Accounteinstellungen geändert werden und sollte dort unbedingt geändert werden!
anonymoususer
Standardname für anonyme (nichtangemeldete) Benutzer.
Standardeinstellung ist "anon"
reggroup
Name der Benutzergruppe, deren Mitglied neuregistrierte (selbstangemeldete) Benutzer automatisch werden. Alle neuangemeldeten Benutzer sind also Mitglied dieser Gruppe.
Standardeinstellung ist "Registered"
allgroup
Name der Gruppe "Alle Benutzer". Alle Nutzer sind Mitglied dieser Gruppe.
Standardeinstellung ist "AllUsers"
rootviewgroups
Jede Seite im System erbt Ihre Zugriffsrechte von der nächsthöheren Seite im Navigationsmenübaum. Die Seiten der ersten Ebene erlauben den hier gelisteten Gruppen standardmäßig die Ansicht der Inhalte.
Diese Einstellung kann bei Erzeugung einer Seite individuell neu gesetzt werden.
Standardeinstellung ist "AllUsers","Registered"
rooteditgroups
Wie "rootviewgroups", jedoch bezogen auf die standardmäßig gesetzten Schreibrechte.
Standardeinstellung ist "Registered"
languages
Vorhandene Sprachen für die Nutzeroberfläche des Systems.
Zu den hier aufgezählten Sprachen sollten die entsprechenden Resourcen im "i32npath" zur Verfügung stehen.
Standardeinstellung ist
array("en" => "english",
"de" => "deutsch")
defaultlang
Die verwendete Standardsprache im System (aus "languages")
Standardeinstellung ist "de
compilers
Liste der vorhandenen und nutzbaren Source-Compiler zur formatierung der Inhalteausgabe.
Zu den hier gelisteten Compilern dollte die entsprechenden Resourcen im Unterverzeichnis "compiler" im "librarypath" zur Verfügung stehen.
Standardeinstellung ist "pie","purehtml","phpparsing"
defaultcompilers
Eine Liste der Compiler, welche allen Nutzern zur Formatierung zu Verfügung gestellt werden.
Standardeinstellung ist "pie","purehtml"
allowOutContentProcessing
Dieser Schalter legt fest, ob die vorgerenderten (formatierten) Ausgaben der compilierten Seiten vor der Ausgabe an den Browser des Besuchers nochmals vom PHP-Prozessor geparst werden. Damit wird eine hochgradig dynamische Ausgabeerzeugung ermöglicht. Dieses Verfahren ist jedoch sehr unsicher und sollte nur bei absoluter Notwendigkeit eingesetzt werden! Da das Ausgabe-Parsing vom Compiler explizit unterstützt werden, kann trotzdem sichergestellt werden, das nur authorisierte Nutzer dieses Verfahren nutzen können (siehe auch "compilers" und "defaultcompilers").
Spezielle Einstellungen, die das Aussehen der Bearbeitungsseiten betreffen
textareacols
Dieser Wert bestimmt die Breite der angezeigten Texteingabe-Felder (Anzahl der Zeichen pro Zeile)
Standardeinstellung ist "110"
textarearows
Dieser Wert bestimmt die Höhe der angezeigten Texteingabe-Felder (Zeilenanzahl)
Standardeinstellung ist "30"
listlimit
Dieser Wert bestimmt die Maximallänge der vom System ausgegebenen Listen (Seitenliste/Benutzerliste/Gruppenliste)
Standardeinstellung ist "1000"
listcols
Liste der in diversen Listen zur Anzeige gebrachten Eigenschaftenspalten.
Standardeinstellung ist:
"size"=>1,
"modificationDate"=>1,
"lastEditor"=>1,
"creationDate"=>1,
"owner"=>1,
"editCount"=>1
Spezielle Einstellungen, die das Sessionmanagement betreffen. Diese Einstellungen müssen nur in sehr seltenen Ausnahmefällen geändert werden.
nosessionobjects
Wenn das yappadoo-System in ein anderes Projekt eingebunden wurde und zum Zeitpunkt der Ausführung des "yappadoo.php"-Skriptes die Session vom "äußeren" Projekt bereits final initialisiert wurde, kann das yappadoo-System normalerweise nicht mehr auf die in der Session gepeicherten Objekte zugreifen, da diesen zum Zeitpunkt der Initialisierung die zugehörige Klassendefinition gefehlt hat. Ist dieser Schalter auf "1" gesetzt , werden die Objekte mittels eines speziellen mechanismus in der Session gespeichert, welcher den Fehler umgeht. Dieses Vorgehen kostet allerdings (ein wenig) Performance. Deshalb sollte immer versucht werden die "yappadoo.php"-Datei vor dem abschließenden initialisieren der Session auszuführen.
Standardeinstellung ist "0"
sessionuserlists
Ist dieser Schalter "1" gesetzt , werden benutzerspezifisch anzulegende Listen nicht zu jedem Seitenaufruf neu berechnet, sondern in der Session gespeichert. Dieses Caching erhöht die Performance des Systems.
Auf sehr langsamen Servern mit sehr vielen Systemseiten und -Nutzern kann es jedoch sinnvoll sein, diesen Cache abzuschalten.
Standardeinstellung ist "1"
timeout
Legt die Zeit bis zu einem Verfall einer aktuell gültigen http-Session fest. Ein angemeldeter Besucher wird bei Inaktivität z.B. nach dieser Zeitspanne automatisch vom System abgemeldet. Setzen Sie diesen Wert nicht zu niedrig, da das Editieren der Seiteninhalte teilweise recht lange dauern kann.
Pfadeinstellungen
Mit diesen Angaben können Sie die Pfade zu den einzelnen Speicherorten des Systems einstellen.
Variable | Erläuterung | Standardeinstellung |
binarypath | Binarydateien-Speicherplatz | $yap_dir."var/bin" |
sourcepath | Inhaltequellen | $yap_dir."var/src" |
outpath | kompilierte Ausgabeseiten | $yap_dir."var/out" |
pagemetapath | Metadaten der Seiten | $yap_dir."var/meta_page" |
binarymetapath | Metadaten der Binarydateien | $yap_dir."var/meta_bin" |
cachepath | Objektcache | $yap_dir."var/cache" |
librarypath | Systemdateien | $yap_dir."lib" |
custompath | anpassbare Systemdateien (layoutbestimmend) | $yap_dir."etc" |
i32npath | Dateien mit sprachsezifischem Inhalt | $yap_dir."i32n" |
userspath | Benutzerdaten | $yap_dir."var/users" |
groupspath | Gruppendaten | $yap_dir."var/groups" |
logfile | log-Dateien (z.Z. ungenutzt) | $yap_dir."var/log/access" |
updatepath | Seiten- & Systemupdates (von ausserhalb) | $yap_dir."updates" |
rootpath | Verzeichnis mit "yappadoo.php" | $yap_dir |
csspath | CSS-Daten (Layout) | $yap_dir."css" |