Page templates and branches

Abstract

All about page templates in SPEAK:

SPEAK provides four templates for page definition items:

  • Speak-DashBoardPage

  • Speak-ListPage

  • Speak-TaskPage

  • Speak-DialogPage

The first three of these templates are for creating application pages; the Speak-DialogPage is for creating single-page dialogs.

These templates give you an almost empty definition item, and there are no components in the layout. The main reason to use the correct template for a specific page is to identify what kind of page it is.

Branch templates are based on the basic templates, but they also contain the basic components of a valid SPEAK page. It is often better to use branch templates as a starting point for a webpage than the basic templates.

You use a dashboard page for overview information and for navigation to more specific information on other pages.

Dashboard pages typically contain lists of entities, such as the “best performing” or “worst performing” entities of a certain type, or charts and other summary data.

Dashboard pages are normally read-only and do not let users enter data.

An example of a dashboard page:

163181B148BA450EADC3FD2B8B8E2FD4.png

You use a list page to help users locate specific entities and for navigation to more specific information available on other pages. List pages generally display a single large list of entities, and they let users search and filter to find specific entities. List pages normally do not let users edit entities, but sometimes bulk operations are appropriate.

An example of a list page:

D83A3DEF3BD64D7D9E26DE1214F1A542.png

You use a task page to show detailed information about a single entity and, when relevant, related sub-entities. Task pages are usually editable. Typically, you do not give users many navigation options in a task page, except for going back to the previous page.

An example of a task page:

F2B88B0890604FEEB4082E470674A82A.png

You use a dialog page for single-page dialogs, for example the Select Media Dialog in Sitecore. Dialog pages do not provide navigation to other pages; users open them to do a specific task (for example, select an image to upload) and it closes when the task completes or the user cancels the task.

An example of a dialog page:

9EF10CA6B2EC4EC8B8644BEAB28936E4.png

A branch template is based on one of the standard page templates, but it adds a layout, a theme, a PageCode component, and a number of structural components. The branch templates are in the Templates/Branches/Applications folder under the Business Component Library. SPEAK provides these branch templates:

  • DashboardPage

  • ListPage

  • TaskPage

When you use a branch template, you gain some advantages:

  • You get a valid page that you can immediately open in a browser. The basic templates need some configuration before you can see them in a browser.

  • The page is consistent with the basic structure outlined in the SPEAK UI guidelines.