Panels tutorial: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 41: Line 41:


==Adding a Text panel==
==Adding a Text panel==
[[File:panels-editor-add-textpanel-1.jpg|175px|thumb|Adding a text panel via the [[ribbon hover menu]].]]
[[File:panels-editor-add-textpanel-1.jpg|150px|thumb|Adding a text panel via the [[ribbon hover menu]].]]
[[File:panels-editor-add-textpanel-2.jpg|175px|thumb|Adding a text panel via the add button.]]
[[File:panels-editor-add-textpanel-2.jpg|150px|thumb|Adding a text panel via the add button.]]
To add any panel, you can either hover over “Panels” in the ribbon and select “Add … Panel”, or select the desired type at the bottom of the left panel with the “Type” dropdown, and then selecting “Add Panel”. To add a Text panel, select “Add Text Panel” via the menu in the ribbon, or select TEXT_PANEL in the left panel.
To add any panel, you can either hover over “Panels” in the ribbon and select “Add … Panel”, or select the desired type at the bottom of the left panel with the “Type” dropdown, and then selecting “Add Panel”. To add a Text panel, select “Add Text Panel” via the menu in the ribbon, or select TEXT_PANEL in the left panel.

Revision as of 12:31, 7 June 2018

Template:Learned

Prerequisites

The following prerequisites should be met before starting this tutorial:

  • This tutorial relies on base knowledge about the editor interface and the creation of excels for indicators. If you have not yet followed the tutorials related to those subjects please do so first.
  • This tutorial can be followed with any project of any arbitrary location. Recommended is to create or load a project in the editor with 3 or more neighborhoods at least partially within the project area
  • Microsoft Excel is required for completing this tutorial. 

Preparations

Take the following steps as preparation for following this tutorial:

  • Start your project. This can be a pre-existing project, or a newly created project.
  • Start Microsoft Excel. Excel will be required in the later stages of the tutorial.

Introduction to panels

Panels are interface elements which can be made visible to the end-user. These panels can be made visible to the user in multiple ways, including a popup in the 3D world, giving the panel or its information a physical presence as well. There are multiple types of popups, each of which behave and are configured in the same manner, but the way the panel generates its content differs.

Types of panels

There are 5 types of panels:

Type Description
Text panels Content is statically defined text, which can be formatted as html. You can configure the text.
Web panels Content is a viewport in which a website is loaded. You can configure which URL to direct the viewport to.
Global panels Content is a list of globals, present in the project, and input fields with which their value can be changed by the end-user. You can configure which globals to list.
Excel panels Content is text, which can be formatted as html, as defined or calculated by an excel sheet. You can configure which excel sheet provides content for this panel, similar to how an indicator is defined by an excel sheet.
Template excel panels Content is (indirectly) text, which can be formatted as html, similar to a “regular” Excel panel. However, the Template Excel panel is not directly accessible by an end-user. It forms a definition, based on which panels are generated which are visible to the end-user.

In most use-cases, Template Excel panels are the most effective tool for communicating information to end-users.

Panels in the editor

The location of panels in the editor.

To edit panels, go to: Template:Editor ribbon When adding panels, they will be added in the categories “Template Panels” and “Single Panels”. Template Excel Panels, and their generated instances, will appear under “Template Panels”. All other panels will appear under “Single Panels”.

Adding a Text panel

File:Panels-editor-add-textpanel-2.jpg
Adding a text panel via the add button.

To add any panel, you can either hover over “Panels” in the ribbon and select “Add … Panel”, or select the desired type at the bottom of the left panel with the “Type” dropdown, and then selecting “Add Panel”. To add a Text panel, select “Add Text Panel” via the menu in the ribbon, or select TEXT_PANEL in the left panel.