ConPresso-Admins
Entwickler
Wiki
ConPresso-Admins
Entwickler
Wiki
string help(string helpRef[, bool nowhitespace[, string show]])
Die Funktion help() dient dazu, das Hilfe-Icon von ConPresso anzuzeigen und gegebenenfalls mit einer verfügbaren Hilfeseite zu verlinken.
Der Parameter $helpRef kann verschiedene Werte haben, je nachdem ob auf die interne ConPresso-Hilfe, eine externe Seite oder die interne Hilfe eines Moduls verwiesen werden soll:
Der Parameter $nowhitespace ist optional und per Default auf false gesetzt. Wird er auf true gesetzt, gibt die Funktion vor dem Hilfe-Icon kein aus.
Der Parameter $show ist optional. Er ist dazu da, um bei Hilfethemen von Modulen im linken Frame das Inhaltsverzeichnis der Module anzuzeigen. Zusätzlich soll damit auch direkt zu den Hilfethemen des entsprechenden Moduls gesprungen werden:
---
Balu: Vielleicht benutzt Ihr im Modul eine Wrapper-Funktion z.B. "meinModHelp()", die den Pfad vor der eigentlich Datei generiert. Dann koennt Ihr nur meinModHelp('abc.html') aufrufen und die Funktion gibt den Parameter weiter an die Funktion help: help('/Modulverzeichnis/Sprache/abc.html')
Oder Ihr definiert eine Variable $meinModHelp und benutzt sie in der Form help($meinModHelp.'abc.html').