mirror of
https://github.com/OpenXE-org/OpenXE.git
synced 2024-12-27 15:10:28 +01:00
1 line
8.2 KiB
Plaintext
1 line
8.2 KiB
Plaintext
<h1><strong><span style="font-size:28px;">Wizard</span></strong></h1><h1>Features</h1>Mit Hilfe des Wizard-Moduls lassen sich für Mitarbeiter Einrichtungs- oder Schulungseinheiten in Form von seitenbasierten Assistenten realisieren. Auf für Xentral selbst gibt es vorladbare Assistenten, z.B. für die Systemeinrichtung.<h2>Syntax</h2><p>Wizards werden in Form von JSON-Code angelegt und einzelnen Besitzern zugeweisen. So können sie auch aktiv / inaktiv geschaltet werden.<br />Hier beispielhaft ein Wizard mit einigen verfügbaren Optionen:<br /><code>{<br /> "settings": {<br /> "user_id": "1",<br /> "active": true,<br /> "key": "firstrun",<br /> "title": "Einrichtungsassistent",<br /> "skip_link_text": "Einrichtung überspringen",<br /> "params": {<br /> "shop_id": 1<br /> }<br /> },<br /> "steps": <a href="<br" target="_blank"> /> {<br /> "key": "grundeinstellungen",<br /> "link": "./index.php?module=firmendaten&action=edit#tabs-1",<br /> "title": "Grundeinstellungen",<br /> "caption": "Meine Firmen-Informationen pflegen ",<br /> "description": "Bitte tragen Sie hier Ihren Firmennamen und bla bla ein. ",<br /> "position": 1<br /> },<br /> {<br /> "key": "briefkopf",<br /> "link": "./index.php?module=firmendaten&action=edit#tabs-2",<br /> "title": "Briefkopf einrichten",<br /> "caption": "Aussehen der Geschäftsbriefe anpassen",<br /> "position": 2,<br /> "options": {<br /> "highlight": </a><a href="<br" target="_blank"> /> "breite_position",<br /> "breite_nummer"<br /> </a><br /> }<br /> },<br /> {<br /> "key": "artikel",<br /> "link": "./index.php?module=artikel&action=list",<br /> "title": "Artikel pflegen",<br /> "caption": "Beispiel mit Modul-Callback",<br /> "position": 3,<br /> "description": "Beispiel mit Modul-Callback. Anforderungen:<br />Callback-Methode muss public sein und Rückgabe muss zu bool wandelbar sein.",<br /> "options": {<br /> "check_callback": {<br /> "module_name": "Wizard",<br /> "module_action": "CheckArticlesProvidedCallback",<br /> "args": <a href="<br" target="_blank"> /> "Wert für erstes Callback-Argument",<br /> "Zweites Argument mit ##shop_id## Parameter"<br /> </a><br /> }<br /> }<br /> },<br /> {<br /> "key": "adressen",<br /> "link": "./index.php?module=adresse&action=list",<br /> "title": "Adressen pflegen",<br /> "caption": "Beispiel mit Objekt-Protokoll-Prüfung",<br /> "position": 4,<br /> "options": {<br /> "check_protocol": {<br /> "object_name": "shop",<br /> "action_name": "shop_created",<br /> "object_id": "##shop_id##"<br /> }<br /> }<br /> }<br />}</code></p><h2>Formatierungen</h2>Die maximale Textlänge für Feld 'description' ist 1024 Zeichen. Der Wizard-Inhalt scrollt, wenn die Inhalt zu hoch oder zu viele Schritte hinterlegt sind.<br /><br />Folgende CSS-Formatierungen für Elemente stehen zur Verfügung<ul><li>ol, ul, li -> Listen und Aufzählungen</li><li>h4, h5, h6 -> Überschriften</li><li>p -> Absatzformatierung</li><li>i, em, b, strong -> Auszeichnung von Texten</li><li>a -> Hyperlinks</li><li>'span' beim Feld 'caption' als Auszeichnung</li></ul> |