Basic Navigation and User Interface Overview

The editor is the same in every edition - the standalone application, the Unity and Unreal Engine plugins, and the web editor. This page is a tour of what is on the screen; the pages it links to explain the work done there.


The Editor Window

../_images/dashboard.png

Three regions, and they stay put:

  • The side navigation on the left - branches, the dashboard, and every schema in the project.

  • The search field across the top.

  • The working area in the middle - the dashboard, a document collection, or a document form, with a breadcrumb above it that tracks where you are.


Side Navigation

From the top:

  • The project - its icon, its name, and the branch currently open.

  • Branches - the other branches of the project, one click to switch. Web editor only, see Workspaces, Projects, and Branches.

  • Home - the Dashboard, and Metadata, which is the list of schemas.

  • Schemas - every schema that is visible in the menu, arranged into the folders its Group field names, plus Add new schema.

  • Project Settings at the bottom.

Installed extensions can add entries of their own here, either in the Home group or in a section of their own.

The « button collapses the whole panel to a narrow rail of icons, and » brings it back - worth doing on a laptop screen when a collection has many columns.


Dashboard

The landing page of a project, and what the side navigation returns to.

  • Start - create a schema, export, import.

  • Tasks - publish, generate source code, internationalization settings.

  • Recent Documents - what you had open lately, newest first, each card naming the collection it belongs to.

In the web editor the dashboard also shows which teammates are in the project at the same time.



First Steps

A new project opens with a guide docked to the right of the dashboard.

../_images/dashboard_tutorial.png

Five steps - create a schema, open and manage documents, generate source code, publish, load the game data - each ticked off as you do it, with the current one expanded into instructions. The header chevron collapses the card, Skip Tutorial dismisses it for good.


The Working Area

Selecting a schema in the side navigation opens its document collection, a grid of every document of that schema. Opening one of those documents replaces the grid with the document form.

Those two screens are where nearly all the work happens, and each has a page of its own: Filling Documents and Editing a Document.


Tips and Keyboard Shortcuts

  • Jump to a referenced document - hold Ctrl and click any reference value to open the referenced document’s form. This works on references throughout the UI.

  • Move between documents without going back - Alt/⌘+ and Alt/⌘+ walk the collection from inside the form, filters and sorting included.

  • Reorder or copy an embedded document - inside a document form, drag a collection entry by its panel header to move it, or hold Ctrl while dropping to copy it. See Editing a Document.

  • The collection grid and the document form have shortcuts of their own, listed on their pages.

See also