Andreas
09.08.2007, 17:24
Worum geht es hier?
vBulletin verfügt für das Administratoren-Kontrollzentrum über ein eingebautes Online-Hilfesystem. Dieses gibt dem Administrator Hilfestellung zu den Funktionen, der Bedienung der Benutzeroberfläche, etc.
Diese Anleitung beschreibt wie man Administrator-Hilfe für eigene Hacks nutzen kann.
Wozu brauche ich das?
Notwendig ist Administrator-Hilfe natürlich nicht, aber gerade bei etwas umfangreicheren Hacks mit vielen Funktionen/Einstellungen/etc. kommt es doch nicht selten vor dass die Nutzer mit der Bedienung zunächst einmal überfordert sind, zumal sich die Funktion aller Eingabefelder, Auswahlboxen, etc. nicht immer eindeutig aus der Beschriftung entnehmen lässt.
Hier kann die Administrator-Hilfe nützlich sein den Support-Aufwand zu verringern und den Nutzern die Benutzung von Hacks zu erleichtern.
Klingt einleuchtend. Aber wie mache ich das?
Die Administratorhilfe wird über den Menüpunt vBulletin/Adminhilfe verwalten kontrolliert, welcher nur im Debug-Modus sichtbar ist.
Hierbei ist zwischen 3 Arten von Einträgen zu unterscheiden
Einträge die sich auf ein komplettes Script beziehen. Hier kann man z.B. allgemeine Erklärungen unterbringen
Einträge die sich nur auf eine Aktion eines Scripts beziehen. Hier kann man z.B. eine Erklärung der Funktion(en) dieser Aktion unterbringen
Einträge die sich auf ein Element (Eingabefeld, Checkbox, Radioboxen, etc.) bezieht.
Hier sollte eine Erklärung zur Funktion des jeweiligen Elements, der erwarteten Eingabedaten, etc. stehen
Um ein neues Thema zu erstellen, klickt man (wenn man sich im Bereich Administratorhilfe verwalten befindet) auf Neues Thema hinzufügen.
Das daraufhin erscheinende Formular anthält folgende Elemente:
Skript
Hier muss der Name des Script ohne .php eingegeben werden, also z.B. myhackadmin
Aktion
Hier muss der Bezeichner der Aktion eingegeben werden.
Beispiel: Für myhackadmin.php?do=settings muss hier settings eingetragen werden.
Falls das gleiche Element in mehreren Aktionen verwendet wird, so können hier mehrer Aktionen per Komma getrennt angegeben werden (z.B. add,edit).
Dieses Feld ist nur für Themen vom Typ 2 oder 3 relevant
Produkt
Hier muss das Produkt ausgewählt werden, zu welchem das Hilfethema gehört
Anzeigereihenfolge
Hier sollte angegeben werden in welcher Reigenfolge Themen angezeigt werden.
Empfehlung: 10er Schritte verwenden. Also 10 für das erste Thema, 20 für das zweite, usw.
Titel
Für Themen vom Typ 1 sollte hier ein allgemeiner Titel für die Funktion des Scripts eingetragen werden (Über MyHack Administration.
Für Themen vom Typ 2 empfiehlt es sich die Überschrift des Formulars zu verwenden.
Für Themen vom Typ 3 sollte der Titel des jeweiligen Elements verwendet werden.
Text
Hier kommt der Text des Hilfethemas rein
vBulletin Standard
Diese Einstellung sollte muss für zu veröffentlichende Produkte immer Ja sein.
Kann ich auch Administrator-Hilfe für eigene Einstellungen erstellen?
Ja, das ist möglich.
Hierbei ist als Script options.php (also Angabe options), als Aktion options und als Option der Variablenname (z.B. myhackwahtever) anzugeben.
Und für eigene Benutzergruppenrechte?
Auch das funktioniert analog:
Als Script usergroup.php (=Eingabe usergroup), als Aktion add,edit und als Option den Bezeichner des jeweiligen Bits (z.B. canfoo).
vBulletin verfügt für das Administratoren-Kontrollzentrum über ein eingebautes Online-Hilfesystem. Dieses gibt dem Administrator Hilfestellung zu den Funktionen, der Bedienung der Benutzeroberfläche, etc.
Diese Anleitung beschreibt wie man Administrator-Hilfe für eigene Hacks nutzen kann.
Wozu brauche ich das?
Notwendig ist Administrator-Hilfe natürlich nicht, aber gerade bei etwas umfangreicheren Hacks mit vielen Funktionen/Einstellungen/etc. kommt es doch nicht selten vor dass die Nutzer mit der Bedienung zunächst einmal überfordert sind, zumal sich die Funktion aller Eingabefelder, Auswahlboxen, etc. nicht immer eindeutig aus der Beschriftung entnehmen lässt.
Hier kann die Administrator-Hilfe nützlich sein den Support-Aufwand zu verringern und den Nutzern die Benutzung von Hacks zu erleichtern.
Klingt einleuchtend. Aber wie mache ich das?
Die Administratorhilfe wird über den Menüpunt vBulletin/Adminhilfe verwalten kontrolliert, welcher nur im Debug-Modus sichtbar ist.
Hierbei ist zwischen 3 Arten von Einträgen zu unterscheiden
Einträge die sich auf ein komplettes Script beziehen. Hier kann man z.B. allgemeine Erklärungen unterbringen
Einträge die sich nur auf eine Aktion eines Scripts beziehen. Hier kann man z.B. eine Erklärung der Funktion(en) dieser Aktion unterbringen
Einträge die sich auf ein Element (Eingabefeld, Checkbox, Radioboxen, etc.) bezieht.
Hier sollte eine Erklärung zur Funktion des jeweiligen Elements, der erwarteten Eingabedaten, etc. stehen
Um ein neues Thema zu erstellen, klickt man (wenn man sich im Bereich Administratorhilfe verwalten befindet) auf Neues Thema hinzufügen.
Das daraufhin erscheinende Formular anthält folgende Elemente:
Skript
Hier muss der Name des Script ohne .php eingegeben werden, also z.B. myhackadmin
Aktion
Hier muss der Bezeichner der Aktion eingegeben werden.
Beispiel: Für myhackadmin.php?do=settings muss hier settings eingetragen werden.
Falls das gleiche Element in mehreren Aktionen verwendet wird, so können hier mehrer Aktionen per Komma getrennt angegeben werden (z.B. add,edit).
Dieses Feld ist nur für Themen vom Typ 2 oder 3 relevant
Produkt
Hier muss das Produkt ausgewählt werden, zu welchem das Hilfethema gehört
Anzeigereihenfolge
Hier sollte angegeben werden in welcher Reigenfolge Themen angezeigt werden.
Empfehlung: 10er Schritte verwenden. Also 10 für das erste Thema, 20 für das zweite, usw.
Titel
Für Themen vom Typ 1 sollte hier ein allgemeiner Titel für die Funktion des Scripts eingetragen werden (Über MyHack Administration.
Für Themen vom Typ 2 empfiehlt es sich die Überschrift des Formulars zu verwenden.
Für Themen vom Typ 3 sollte der Titel des jeweiligen Elements verwendet werden.
Text
Hier kommt der Text des Hilfethemas rein
vBulletin Standard
Diese Einstellung sollte muss für zu veröffentlichende Produkte immer Ja sein.
Kann ich auch Administrator-Hilfe für eigene Einstellungen erstellen?
Ja, das ist möglich.
Hierbei ist als Script options.php (also Angabe options), als Aktion options und als Option der Variablenname (z.B. myhackwahtever) anzugeben.
Und für eigene Benutzergruppenrechte?
Auch das funktioniert analog:
Als Script usergroup.php (=Eingabe usergroup), als Aktion add,edit und als Option den Bezeichner des jeweiligen Bits (z.B. canfoo).