WebsiteBaker Support (2.12.x) > Modules

New module: Hints

(1/5) > >>

Martin Hecht:
(German version see below)

I have written a new module to create hints, tutorials, or documentation in the backend. It always makes sense where people with different levels of skills and therefore different privileges in the backend work together.

An admin user installs modules and delegates tasks to one or more editors. They help feeding the web page with content, but they might not be that much familiar with IT. They need some hints how to use the modules in the backend. This new module allows the admin to provide such hints etc.. Another use case is a team of collaborators who have to coordinate their work and need a place to insert additional information about what has been done, how and why...

The module does not produce any frontend output. In the backend there is a text area where one can insert some text. html tags are allowed, newlines are converted to html line breaks.
The module supports several modes: shared/unshared, and hidden/visible. Each section is assigned to an owner. Members of the administrator group have special privileges. If they have permissions on the Hints module they can do everything the owner can do and also change the ownership.

Unshared sections can be modified (or deleted) only by the owner and administrators.
Shared sections can be modified by all users with Hints permissions and permissions to modify the page.
Hidden sections can be seen/modified only by the owner and administrators.
Sections that are not hidden can be seen by everyone with permissions to use the Hints module.

The background color can be selected which can be used to mark some hints as important, others as regular hints, or visually assign hints to to specific tasks or user groups.


German version:


Ich habe ein neues Modul erstellt, mit dem man Hinweise, Anleitungen und Dokumentation im  Backend erstellen kann. Das ist immer dann sinnvoll, wenn Menschen mit unterschiedlich  tiefen Kenntnissen im Backend zusammenarbeiten und entsprechend unterschiedliche  Privilegien zugewiesen bekommen.

Ein Admin user installiert Module und delegiert Aufgaben an einen oder mehrere Redakteure. Diese helfen ihm die Webeseite mit Inhalten zu füllen, aber sie sind eventuell nicht so vertraut mit IT. Sie brauchen ein paar Hinweise, wie die Module im Backend zu bedienen sind. Dieses neue Modul erlaubt es dem Admin gerade solche Hinweise etc. zu erstellen. Ein weiterer Answendungsbereich ist ein Team, dessen Mitarbeiter ihre Arbeit untereinander abstimmen müssen und sie brauchen eine Platrorm um Begleitinformatione n zu hinterlegen, z.B. was erledigt ist, wie und warum...

Das Modul erzeugt im Frontend keine Ausgabe. Im Backend stellt es eine Textarea bereit in die Text eingegeben werden kann. html tags sind dort erlaubt, Zeilenumbrüche werden in html line breaks umgewandelt.
Das Modul unterstützt mehrere Modi: freigegeben/nicht freigegeben sowie verersteckt/sichtbar. Jede Section wird einem Besitzer zugeordnet. Mitglieder der Administratorgruppe haben besondere Rechte. Wenn sie Zugriff auf das Hints Modul haben, können sie alles tun, was der jeweilige Besitzer einer Section tun kann und darüber hinaus die Section einem neuen Besitzer zuweisen.

Nicht freigegebene Sections können nur durch den Besistzer und durch Administratoren geändert oder gelöscht werden.
Freigegebene Abschnitte können von allen Benutzern mit Berechtiung für das Hints Modul und zum Ändern der jeweiligen Seite geändert werden.
Versteckte Sections können nur vom Besitzer und von Administratoren betrachtet oder geändert werden.
Sections die nicht versteckt sind, können von allen mit der Berechtigung das Hints Modul im Backend zu verwenden gesehen werden.

Die Hintergrundfarbe kann ausgewählt werden, was dazu benutzt werden kann, bestimmte Hinweise als wichtig und andere als normal zu kennzeichnen, oder visuell Hinweise mit bestimmten Aufgaben zu verknüpfen oder sie bestimmten Nutzergruppen zuzuweisen.

thanks to Franky for testing and for providing input to this work

dbs:
Hello Martin, very useful module. Thanks for that.  (Y)
The colorchooser works good.

The owner dropdown maybe should better without login name (user name is enough).

One notice is there (WB 2.12.1, PHP 7.2):

--- Code: ---[E_NOTICE] /framework/SecureTokensInterface.php:[133] from /modules/hints/save.php:[74] bin\SecureTokensInterface->checkIDKEY "Undefined index: bfc97d24236068a5"
--- End code ---

hgs:
Super Idee das Modul, da ich als "Nur-Anwender" auch immer gerne Bilder in einem Hinweis-Text habe, ist es denkbar das Modul noch auf zu bohren?.
Zur Info
Die Fehlermeldung von dbs erscheint auch bei php5.6 mit WB 2.12.1

Gast:
@Martin:  nur den Namen der POST-Variable übergeben, diese wird dann automatisch auf den POST-Array bezogen (siehe public function checkIDKEY() ). Die Schreibweise oben würde ausgeschrieben bedeuten
$_POST[$_POST['owner']]

Zeile 74 in der save.php
dein original

--- Code: ---$owner = $admin->checkIDKEY($_POST['owner']);
--- End code ---

ändern auf

--- Code: ---$owner = $admin->checkIDKEY('owner');
--- End code ---
oder (falls mehrere übergebene IDKEY's mit GET oder POST unterschieden werden müssen)


--- Code: ---$owner = $admin->checkIDKEY('owner',false,'POST');
--- End code ---

Martin Hecht:
Hallo zusammen,

hier ist auch schon die nächste Version. Danke @jacobi22 für den HInweis. Ich dachte es hätte daran gelegen, dass ich checkIDKEY ursprünglich erst nach der Ausgabe des Headers verwendet hatte, aber das war's dann wohl doch nicht. Deine vorgeschlagene Änderung habe ich in 0.3.1 übernommen.

@dbs: thanks for the hint not to expose login names. I have changed that in the latest version. Only if the display name is empty (I don't know if that can happen at all) I use the login name as a fallback now.

@hgs: Bilder sind jetzt schon möglich. Du kannst html tags <img src="...."> im normalen Text mit eingeben. Wenn der Hint nicht freigegeben ist, sehen die anderen User, die nicht in der Administrator-Gruppe sind, das eingebundene Bild. Um es als Besitzer oder Admin angezeigt zu bekommen, denke ich darüber nach, auch in diesem Fall die Ansicht darzustellen, die andere Benutzer sehen, und zusätzlich einen "Edit"-Button einzublenden, um zu der Bearbeitungsansicht umzuschalten. Ich habe daran schon mal gedacht, hatte dann aber den Anwendungsfall mit Bildern noch nicht im Hinterkopf. Gibt's ein Modul, bei dem man sich abschauen kann, wie man am besten einen Browser für den Medien-Ordner integriert?

Navigation

[0] Message Index

[#] Next page