Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:visualizer_help_wiki_rules [2025/11/18 15:26] – created adminwikien:visualizer_help_wiki_rules [2025/11/18 16:00] (current) – [Control contents] adminwiki
Line 1: Line 1:
 ===== Documentation for help in the Visualiser ===== ===== Documentation for help in the Visualiser =====
 +{{INLINETOC 3}}
  
 The help texts in the help panel of the vrdoro Visualiser are managed in the wiki. You can use labelling when writing the wiki content to determine which content is displayed. The following options are available: The help texts in the help panel of the vrdoro Visualiser are managed in the wiki. You can use labelling when writing the wiki content to determine which content is displayed. The following options are available:
Line 7: Line 8:
 If a section from a help page in the software is to be displayed in the help panel, then the section must be marked by a WRAP element with the class ''vrdoro-help'' class. A unique ID for the page, starting with ''#'' enables the section to be referenced in the template code. If a section from a help page in the software is to be displayed in the help panel, then the section must be marked by a WRAP element with the class ''vrdoro-help'' class. A unique ID for the page, starting with ''#'' enables the section to be referenced in the template code.
  
-Example (see https://docs.vrdoro.com/doku.php?id=vproduct:room-measure:modes):+Example ([[https://docs.vrdoro.com/doku.php?id=en:vproduct:room-measure:modes|open example page in new tab]]):
 <code html> <code html>
 <WRAP vrdoro-help #irgendeineID> <WRAP vrdoro-help #irgendeineID>
Line 21: Line 22:
 To display this content in the software, the function this.helpPanelNeoCode.getWikiContent is used in the template code to fill a translation map. To display this content in the software, the function this.helpPanelNeoCode.getWikiContent is used in the template code to fill a translation map.
  
-Example (see https://vrdoro.com/editor/~/admin/template-snippets/edit/180):+Example ([[https://vrdoro.com/editor/~/admin/template-snippets/edit/180|open template snippet in new tab]]):
 <code javascript> <code javascript>
 this.translations = { this.translations = {
Line 43: Line 44:
   - not-in-headset: This text is only visible on the wiki page and not in the headset. Admins see the text with a light red background.   - not-in-headset: This text is only visible on the wiki page and not in the headset. Admins see the text with a light red background.
  
-Example (see https://docs.vrdoro.com/doku.php?id=vproduct:helper-tool:scene-align): +Example ''only-headset'' ([[https://docs.vrdoro.com/doku.php?id=en:vproduct:helper-tool:help-panel|open example page in new tab]]): 
 <code html> <code html>
 <div only-headset> <div only-headset>
 Dieser Text ist nur im Headset sichtbar! Dieser Text ist nur im Headset sichtbar!
 +</div>
 +</code>
 +
 +Example ''not-in-headset'' ([[https://docs.vrdoro.com/doku.php?id=en:vproduct:helper-tool:scene-align|open example page in new tab]]): 
 +<code html>
 +<div not-in-headset>
 +Dieser Text ist **nicht** im Headset sichtbar!
 </div> </div>
 </code> </code>
Line 86: Line 94:
 For a heading, a DIV with the class ''title'' class must be used so that the icon is displayed in the same line. For a heading, a DIV with the class ''title'' class must be used so that the icon is displayed in the same line.
  
-Example (see https://docs.vrdoro.com/doku.php?id=vproduct:room-measure:modes):+Example ([[https://docs.vrdoro.com/doku.php?id=en:vproduct:room-measure:modes|open example page in new tab]]):
 <code html> <code html>
 <WRAP vrdoro-help #help-panel> <WRAP vrdoro-help #help-panel>