Self Help - The Graphic Editor


         SelfHelp - GUI overview.png

The graphic editor comprises a set of dedicated panes for:

It is accessed from the Edit view in the view bar of the Product name - ev Self Help.png application.

Notes

  • Multilingual management  is proposed in all the components of the project: translation of procedures, resources, forms, etc.

Best Practice big icon.pngBest practice

  • Arrange your panes to suit your work habits  - Open url.png see Procedure

Screen description

In the standard configuration, the graphic editor displays 5 areas:

  • (1) Title bars, menu bar, toolbar, view bar
  • (2) Explorer pane: projects and their components managed as a tree structure
  • (3) Properties pane: to define the properties of the component selected in the Explorer pane
  • (4) Design pane: workspace dedicated to the graphics designing of procedures and forms
  • (5) Description pane: to define the contents and page layout of the object selected in the Design pane, and manage the resources it uses

         SelfHelp - GUI.png

Title bar, menu bar, toolbar, view bar

        GUI - Bars.png

BarsDescription
  • (1) Title bar: Information about the current Product name - ev Self Help.png session (server name, domain, connected user).
  • (2) Menu bar
    • Certain menu options can also be accessed from the toolbar and from a context menu on the Explorer pane components.
  • (3) Toolbar
  • (4) View bar
    • Click a view to open it; the active view has a gray frame.
      • GUI - Bars - Other view icon.png : Access to customized views.
      • Edit view: Graphic editor for versions with ongoing project modification.
      • Publish view: Publishing manager for the published versions of projects.
      • Admin view: administration manager only for the domain’s administrators and the project owners.
          
    • Right-click a view name to display the contextual options:
      • Customize...: To select the items to be shown in the toolbar, the menu bar, commands and shortcuts.
      • Save as...: The changes made to the active view are saved under another view name.
        To revert to the standard view (default), click GUI - Bars - Other view icon.png > Other... and select it from the list.
      • Reset: Revert the panes of the active view to the standard display.
      • Close: Close the active view.
        To display the view again, click GUI - Bars - Other view icon.png > Other... and select it from the list.
      • Dock on: To set the view bar position (top left/right or on the left side of the graphic editor).
      • Show text: To display or not display the title of the view to the right of the icon.
EndBarsDescription

 

The Explorer pane

It displays all the projects of the active domain as a tree structure.

Display pane: View > Explorer
         GUI - Explorator Pane.png

Toolbar

  • Select language drop down.png: Select the display language for the Explorer pane components.
    • To add a language in the list: Help > Preferences > Allowed Languages.
  • Synchronize icon.png : Synching of the Design pane display with the component selected in the Explorer pane.

Project tree structure

  • Expand the tree structure by double-clicking the project name or click Tree expand icon.png.
    • The project components are grouped together in folders.
    • The icon shown opposite each component identifies its nature: procedure, variable, form, etc.  - Open url.png see Project contents
  • The project version is shown in brackets after its name.
    • Only unpublished versions are shown in the graphic editor.
    • The published versions can be accessed from the Publishing manager and can no longer be modified.
  • The actions that can be carried out on each component of the project can be accessed from a context menu: create, copy, move, import, etc.

 

The Properties pane

         GUI - Properties Pane.png

PropertiesPaneDescription

It displays the contextual properties of the component selected in the Explorer pane: project, procedure, folder, resource, etc.

Toolbar

  • Select language drop down.png: Select the display language for the Properties pane components.
  • Properties browsing history icons.png : Navigate in the history of the properties viewed during the current session. Note: The history is reset for each Product name - ev Self Help.png session.
  • Additional icons are displayed based on the component type selected.

             Open url.png see Toolbar for:

List of tabs

Properties: Set of properties of the component. 

Go to the tab: View > Properties

  • The name of the component is shown at the top of the pane.
  • The sub-tabs are contextual to the component type.

             Open url.png See Properties for:

 

EndPropertiesPaneDescription

Overview: Overview of a Procedure component.

Go to the tab: View > Overview

  • The red frame delimits the area displayed in the Design pane.
             GUI - Properties Pane - Overview tab.png

Best Practice icon.png  

  • Use this view for lengthy procedures for which you need to use the horizontal scroll bar in the Design pane.
  • Zoom to adjust the size of the diagram.

 

Design pane

It displays the graphic representation of procedures and resources of the HTML content and Form type.

  • (1) Component tab bar
  • (2) Toolbar contextual to the selected component
  • (3) Diagram of the component
  • (4) Views

         GUI - Redaction Pane.png

  • When the graphic editor is opened, the pane shows the component that was opened in the previous Product name - ev Self Help.png session.
  • To display another diagram, select the desired component in the Explorer pane or in the tab bar (1).

Tab bar

It shows the history of the components that were opened previously in the Design pane for all projects. 

  • Click a tab to display the corresponding diagram.
  • If the Synchronize icon.png icon is enabled in the Explorer pane, the pane is automatically synched every time you change tabs.

Design views: Workspace in which the selected component is built graphically: procedure Product name - ev Self Help.png, HTML content or Form resource.

         Open url.png see Procedures:

  • Click an object of the diagram to select it.
    • It is framed in blue.
               Redaction Pane - Active object.png
       
    • The Description pane is synchronized automatically.
    • The toolbars of the two panes are contextual to the object type.
  • Double-click the object and enter its name.
    • You can also enter it from the title bar of the Description pane.
    • You can hide a part of the name by placing the text within [ ] characters.
               Example documentation icon EN.png  Conception pane - Hidden text step name.png
  • Deleting a step: Right-click the step and select Delete from the context menu. Keyboard shortcut icon.png <Del>
    Note: To delete a step that has branches, you must first delete each branch.
  • Diagram information icons:
Icon Description
Step type icon - Start.png Start step
Step type icon - End.png End step
Redaction Pane - Interactive step.png Interactive step (Web page): preceded by another icon
Redaction Pane - Automatic step.png Automatic step (action): preceded by the Redaction Pane - Action icon.png icon
Redaction Pane - Resume point icon.png Marker step type
Redaction Pane - Sub procedure icon.png Sub-procedure step type
Redaction Pane - Problems icons on object.png
  • The Step problem icon.png icon shown opposite the description of an object indicates errors: title not entered, error in a condition, etc.
  • Mouse over the icon to display the details in a tooltip. Redaction Pane - Step problem details.png
Redaction Pane - Resource icon on object.png
  • The icons shown inside the frame represent the resource types (form, file, etc.) used by the object.

Preview: Preview the object selected in the diagram as it will appear in the user’s Internet browser.

  • The preview can be displayed by applying the different project themes available.

         GUI - Redaction Pane - Preview.png

 

The Description pane

It describes the content of the object selected in the Design pane.

  • (1) Description view in the language selected in the Design
  • (2) Title bar
  • (3) Tab bar contextual to the object
  • (4) Toolbar contextual to the object
  • (5) Content of the active tab: all the resources used by the object are listed in dedicated tabs.

Go to the pane: View > Description (desired language)
         GUI - Description Pane.png

Title bar

  • It contains the name of the selected object.
  • Double-click the object to change its name.
    • You can also change it by double-clicking the object in the Design pane.
    • You can hide a part of the name by placing the text within [ ] characters.
               Example documentation icon EN.png  Conception pane - Hidden text step name.png
  • Information icons before the object name:
Icon Step type
Step type icon - Start.png Start
Step type icon - End.png End
Step type icon - Action.png Action
Step type icon - Action with conditions.png Action with switch
Step type icon - Branche.png Branch
Step type icon - Page.png Node
Step type icon - Choice page.png Choice node
Step type icon - Resume point.png Marker
Step type icon - Sub procedure.png Sub-procedure

List of tabs

Notes

  • The tab bar is contextual to the object selected.
  • Each tab has a contextual toolbar.
     

Content: Editor dedicated to the definition and page layout of the HTML content of the object selected in the diagram (text, tables, hypertext links, resources, etc.).

  • Note: Tab not displayed for the Start Step type icon - Start.png and End Step type icon - End.png steps.
  • Use the toolbar to format the text and the tables.
  • The pictures may have clickable areas: active areas that execute an action when clicked upon (open a Web page, chain to the next step, guide to a branch of the tree, etc.) -  Open url.png see Procedure
  • To insert a resource in the editor:
    • Drag&drop it from the Explorer pane to the Content pane.
    • Right-click its name and configure it using the proposed options - Open url.png see Procedure
               Example documentation icon EN.png  Description pane - Resource configuration menu.png
       

Linked files: List of resources of the File type used by the current step (picture, audio, video, PDF, etc.).
         Description Pane - Link Files tab.png

  • Note: Tab not displayed for the Start Step type icon - Start.png and End Step type icon - End.pngsteps, Branch steps.
     

Forms: List of Form resources used by the current step.
         Description Pane - Forms tab.png

  • Note: Tab not displayed for the Start Step type icon - Start.png and End Step type icon - End.pngsteps, Branch steps.
  • Display colors:
    • red: settings
    • blue: variables
       

Branches: List of branches linked to the previous step.
         Description Pane - Branches tab.png

  • Note: Tab displayed only for Page and Page with choices steps.
  • + Add a Branch: Add a new branch linked to the previous step. You can also right-click the step in the diagram.
  • Up arrow icon.png and Down arrow icon.png: Changing the order of the branches. You can also drag&drop the step in the diagram.
     

Connectors: List of connectors used by the current step with their settings and variables.
         Description Pane - Connectors tab.png

  • Note: Tab not displayed for the Start Step type icon - Start.png and End Step type icon - End.pngsteps, Branch steps.
  • Display colors:
    • green: connectors added to the object as attachments in the Design pane
    • blue: connectors inserted in the step content through the Description pane
       

Linked procedures: List of sub-procedures used by the current step
         Description Pane - Related procedures tab.png

  • Note: Tab displayed only for Sub-procedure steps.
     

Linked markers: List of markers inserted in the current step
         Description Pane - Related resume points tab.png

  • Note: Tab displayed only for Marker steps.
     

Report: Text inserted in the execution report when the user completes the current step, and which is hidden in the Web page.
The execution report describes the user’s route in the procedure (step of steps and branches that the user has gone through). It can be set up step by step in this tab.

  • By default, the report contains the title of the step.
  • Customize the report for the current step using one of these three options:
    • Custom report: Manually enter the text to be inserted in the 
    • Node title report: The title of the current step is automatically inserted in the report
    • None : No text is displayed in the report

Best Practice icon.png  Add a report on the steps of the procedure for which you wish to know the user’s choice. 

 

Macro: Editor dedicated to defining macros.
         Description Pane - Macros tab.png

  • Note: Tab not displayed for the Start Step type icon - Start.png and End Step type icon - End.png steps, Branch steps.

    Best Practice icon.png Use macros to perform calculations or to modify the user’s route according to the answers given by the user in the forms.

Procedures

How to open the graphic editor

1. Run the Product name - ev Self Help.png executable: the authentication dialog box is displayed.

2. Select the server you want to work in.

3. Enter your access credentials.

4. Click OK.

  • The graphic editor is opened. 
  • The connection information is displayed in the title bar (server, domain, user).

How to customize the graphic editor

Step 1: Position the panes of the editor

1. Drag&drop the title bar of each pane to the desired position.
 

Step 2: Customize the menu bar and the tool bar
 

Step 3: Backup of your configuration

1. Create a new Edit view.

  • Click GUI - Bars - Other view icon.png.
  • Select the desired Edit view.
     

Return to the default configuration

  • Right-click the Edit view in the toolbar of the graphic editor.
  • Select the Reset option
Tags:
Last modified by Unknown User on 2018/12/14 12:14
Created by Administrator XWiki on 2018/12/14 11:21
Powered by XWiki ©, EasyVista 2019