Dies ist eine alte Version des Dokuments!
Dokumentation für die Hilfe im Visualizer
Die Hilfetexte im Hilfs-Panel des vrdoro-Visualizer werden im Wiki verwaltet. Über Auszeichnungen beim Schreiben der Wiki-Inhalte kann festgelegt werden, welche Inhalte angezeigt werden. Es gibt folgende Möglichkeiten:
Inhalte aktivieren
Soll ein Abschnitt aus einer Hilfeseite in der Software im Hilfe-Panel angezeigt werden, dann muss der Abschnitt von einem WRAP-Element mit der Klasse vrdoro-help umschlossen sein. Eine für die Seite eindeutige ID, beginnend mit # ermöglicht die Referenzierung des Abschnitts in Template-Code.
Beispiel (s. https://docs.vrdoro.com/doku.php?id=vproduct:room-measure:modes):
<WRAP vrdoro-help #irgendeineID> ==== Überschrift ==== Textinhalt. </WRAP>
Diese Inhalte werden im Wiki mit einem Strich an der linken Seite markiert. So ist direkt erkennbar, dass dieser Text auch im vrdoro-visualizer angezeigt wird.
Verwendung der Inhalte im visualizer
Um nun diesen Inhalt in der Software anzuzeigen wird die Funktion this.helpPanelNeoCode.getWikiContent verwendet, um eine Übersetzungsmap zu füllen.
Beispiel (s. https://vrdoro.com/editor/~/admin/template-snippets/edit/180):
this.translations = { de: { step1: { description: '', docFunction: () => this.helpPanelNeoCode.getWikiContent('https://docs.vrdoro.com/doku.php?id=pageID', 'irgendeineID') }, }, }
irgendeineID referenziert dabei die ID aus dem WRAP-Tag oben.
Inhalte steuern
Über DIV oder 'SPAN Elemente mit Klassen lässt sich nun steuern, welche Inhalte wo sichtbar sind.
Diese Klassen bedeuten:
- only-headset: Der Text ist nicht auf der Wiki-Seite sichtbar. Ausnahme: Admins sehen den Text mit einem gelben Hintergrund.
- not-in-headset: Dieser Text ist nur auf der Wiki-Seite sichtbar und nicht im Headset. Admins sehen den Text mit einem hellem rotem Hintergrund.
Beispiel (s. https://docs.vrdoro.com/doku.php?id=vproduct:helper-tool:scene-align):
<div only-headset> **Dieser Text ist nur im Headset sichtbar!** </div>
2 spaltiges Layout
Für die Anzeige von Bilder bietet sich ein zweispaltiges Layout an. Dies wird im Markdown über diesen Code erreicht:
Bilder einfügen
Icons einfügen
Icons im Text können in der Überschrift oder im normalen Text verwendet werden.
Icon in der Überschrift
<WRAP vrdoro-help #help-panel> <div title> {{https://cdn.vrdoro.com/data/vrdoro/images/shared/app/circle-question.png?filt=negate&w=40&.png?nolink}} ===== Überschrift ===== </div>
