Available translations

Tutorial Topic

education.png
tutorial-topic.png
A tutorial topic is an organizational device that helps to keep tutorial step nodes arranged in a logical hierarchy by topics and subtopics.
Content
Tutorial topics may be nested within other tutorial topics in unlimited levels, and each level may feature multiple tutorial steps.
Configuring
Tutorial Topic Configuration
Initial Values
These are the Initial Values for Tutorial Topic configuration: 
 {
    "icon": {
        "name": "",
        "project": "Foundations"
    },
    "position": "Left",
    "slider": "toTop",
    "pressButton": "",
    "docs": {
        "project": "Foundations",
        "category": "Tutorial",
        "type": ""
    },
    "controlDocs": {
        "panel": "",
        "closeTutorialEditor": false,
        "page": {
            "project": "Foundations",
            "category": "",
            "type": ""
        }
    }
}
Examples
This is a list of properties featured by the Tutorial Topic configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Tutorial Topic Menu
The Tutorial Topic node has the following Node Menu items:
The Play menu item has the following properties:
  • action: Play Tutorial Topic
  • actionProject: Education
  • label: Play
  • iconPathOn: play
  • iconPathOff: play
  • actionFunction: payload.executeAction
The Resume menu item has the following properties:
  • action: Resume Tutorial Topic
  • actionProject: Education
  • label: Resume
  • iconPathOn: resume
  • iconPathOff: resume
  • actionFunction: payload.executeAction
The Configure menu item has the following properties:
  • action: Configure
  • actionFunction: uiObject.configEditor.activate
  • label: Configure
  • iconPathOn: configuration
  • iconPathOff: configuration
The Add Tutorial Step menu item has the following properties:
  • action: Add UI Object
  • actionProject: Visual-Scripting
  • actionFunction: payload.executeAction
  • relatedUiObjectProject: Education
The Add Tutorial Topic menu item has the following properties:
  • action: Add UI Object
  • actionProject: Visual-Scripting
  • relatedUiObject: Tutorial Topic
  • actionFunction: payload.executeAction
  • relatedUiObjectProject: Education
The Delete menu item has the following properties:
  • action: Delete UI Object
  • actionProject: Visual-Scripting
  • askConfirmation: true
  • confirmationLabel: Confirm to Delete
  • label: Delete
  • iconPathOn: delete-entity
  • iconPathOff: delete-entity
  • actionFunction: payload.executeAction
Tutorial Topic Children
The Tutorial Topic node has the following childrenNodesProperties:
The Tutorial Steps node property features the following properties:
  • name: tutorialSteps
  • type: array
  • autoAdd: false
The Tutorial Topics node property features the following properties:
  • name: tutorialTopics
  • type: array
  • childType: Tutorial Topic
  • autoAdd: false
Tutorial Topic Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Tutorial Topic with other nodes:
Compatible Types:
Tutorial Topic Referencing Rules
The following are the Node Referencing Rules that determine which nodes Tutorial Topic may establish a reference to:
Compatible Types:
Incompatible Types: