Ribbon

From Tygron Support wiki
Revision as of 11:38, 17 August 2015 by Joris@tygron.com (talk | contribs)
Jump to navigation Jump to search

Template:Learned

How does the ribbon relate to the Tygron Engine

The ribbon is the generic header of the Tygron Editor. It is a tabbed header, which provides access to tools grouped by categories. Those categories are in organized in tabs. This makes tools accessible in a logical way.

Ribbon Overview

Editor ribbon.jpg


The ribbon at the top consists of 2 parts, the ribbon header and the ribbon bar.

Ribbon header

The ribbon header provides access to the File Menuand to the tabs Stakeholders, Indicators, 3D World, Animations, Storyline, Tools and Help. The ribbon header also provides access to the Team Chat Box, the ability to Sign in with ArcGIS Online and provides access to your project details.

Activating one of the tabs reveals context-sensitive buttons.

Ribbon bar

The ribbon bar provides access to the main properties adjustable in the Tygron Engine. The ribbon bar is divided in 3 parts. The left part for starting and stopping the test run, the middle part for currently active buttons (based on the active tab) and the right part for accessing and switching playable stakeholders available in the current project.

Ribbon bar dropdown menu

The ribbon bar dropdown menu

A dropdown menu can be presented when hovering buttons on the ribbon bar. The dropdown menu can be used as a shortcut to access the left-panel, to add items to your project, or can redirect users to the documentation section.

Left: Test Run

Main article: Test Run.
Test Run Active


A test run is a convenient way of quickly testing the current state of your project.

Middle: ribbon tabs and buttons

File:Editor ribbon bar middle.jpg
The ribbon Header, with active "Indicators" tab, the ribbon bar with the active "Indicators" Button and several other (inactive) buttons


The ribbon consists of a number of tabs, which provide access to buttons required to edit your project. The visible buttons are context-sensitive, they depend on the active tab in the ribbon header. The different tabs including buttons will be described below.

Active tabs

Active tabs are indicated by a blue colored text and the tab appearing on the foreground. Currently the "Indicators" tab is active on the ribbon header, providing access to indicators, function values, function assets and function scores buttons on the ribbon bar.

Active buttons

Active buttons are indicated by a blue background color. Currently the "Indicators" button on the ribbon bar is selected. When active, the button provides access to the properties in the left panel. Selecting a different tab in the ribbon header makes different buttons available.

Right: Playable stakeholders, Switching stakeholders, Invite

The ribbon bar with all playable Stakeholders, the currently selected Stakeholder: "Gemeente" (Municipality), and another occupied stakeholder "Company".


On the far right hand side, the ribbon bar displays all playable stakeholders for the current project. The currently active stakeholder is displayed with a blue background. An unavailable stakeholder (selected by another user) is indicated with a gray background. Available stakeholders are displayed with a white background. When a user switches stakeholders, or logs out of the Tygron Engine makes this stakeholder available for selection again.

The stakeholder buttons enable users to switch between stakeholders by pressing the corresponding button. You can only switch to a stakeholder that is not yet selected by another user.

The stakeholder buttons are always visible, independently of the tab currently selected in the ribbon header.

Switching stakeholders

Switching a stakeholder is done by pressing an available stakeholder button (displayed with a white background). Keep in mind that, when switching a stakeholder you will also switch the indicators, budget and actions among others. You will make an identity switch!

How to switch to an available stakeholder:
  1. Select an available stakeholder in the ribbon bar.

Inviting someone to join

Users can also "invite a friend" to collaboratively make use of the editor. An invitation can be made by hovering over a stakeholder button and selecting "invite a friend".

How to invite others to collaboratively make use of the editor.:
  1. Hover over an available stakeholder in the ribbon bar, a dropdown appears
  2. Select "Invite a friend"
  3. The invitation panel will appear
  4. Select a registered person from your organisation or invite someone without an account via email

File

File Pane

Selecting the "File" Tab from the ribbon header opens the File Menu.

Stakeholders


Contains the options related to stakeholders: stakeholders, actions, Measures and Messages.

Indicators


Contains the options related to: indicators, the properties of functions, and their effects on custom indicators. The option recalculate indicators can also be found here.

3D World


Contains all the options with a spatial aspect: constructions, land, zoning, terrains, overlays, dike types and upgrade types.

Animations


Contains all the options with a moving aspect: cinematics, special effects, units, weather, environment.

Storyline


Contains the options with a storyline related aspect: Levels, Timeline, Intro Texts and Interface

Tools

Editor ribbon header tools.jpg


Contains the options with a tool related aspect: Event Bundles, Screenshot, Video, Free Cam, Query Tool and the API Overview

Help


Contains the following help options: Team Chat Box, Community, Contact Support