Magnolia 4.5 reached end of life on June 30, 2016. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

Dialogs are used for content entry. Editors type content into the input fields and the dialog stores it in the repository. Dialogs can be used to edit page, area and component content. The functionality of each field in a dialog is provided by a control that allows the editor to perform a task such as enter text, upload an image, select a date etc. Controls are assembled into tabs and tabs into dialogs.

The STK dialog definitions are configured in Templating Kit > Dialog Definitions. The definitions are arranged in four folders: /generic, /pages, /components and functional.

The STK dialogs are standard Magnolia dialogs. For more information on dialogs and how to configure them see Dialogs and Controls in our Reference section.

Generic configurations

To minimize configuration generic dialogs, tabs and fields are configured in the /generic folder. These configurations are used over and over in the page and component dialogs. This arrangement allows you to simply reference the generic configuration instead of duplicating it. The names of the four child folders, /pages, /controls, /teasers and /master, indicate the contents of the folders and where the configuration is most used. The extends mechanism is used extensively.

Here's an example of how it works:

  • The hideTeaserImage field is configured in the /generic/teasers folder.
  • The baseTeaserInternal dialog configured in the /generic/master folder includes the two tabs used in all internal teasers: tabTeaser and tabTeaserOverwrite. The hideTeaserImage field is included in the first tab using the extends property.

  • The stkTeaser dialog configured in the /components/teasers folder extends the master configuration.

Here's the stkTeaser dialog that editors see.

Page dialogs

The /pages folder contains the dialog definitions used by the page templates and there is a child folder for each template. You will find the following dialog definitions for all page templates except stkHome.

  • Properties: <template name>Properties for the entry of page properties.
  • Intro: <template name>Intro for content entry in the Page Header component that renders in the main/intro area on most templates. See intro area  for more information.

The /home folder has only a stkHomeProperties dialog because the intro area is disabled on the stkHome template. See intro area for more information.

There are two other exceptions in the /section and /footer folders:

  • The stkSectionHeader dialog is used for content entry in the Section Header component in the stkSection template. See sectionHeader area  for more information.
  • The stkFooter dialog is used for entry of copyright information in the main footer component . See footer area  for more information.

Properties dialogs

Each page has a properties dialog that is:

  • Assigned to the page in the page template definition  in Template Definitions > /pages/<template name>/dialog.
  • Accessed by clicking Properties in the top bar on the page.
  • Identical for all templates except stkHomethat also includes site-wide information. The dialog allows for:
    • tabMain: Exclusion of the page from the navigation bars, and browser window and navigation titles that are different from the page title. See htmlHeader area  and Navigation for how this content is used.
    • tabMetaData: Entry of meta keywords and description. These are inserted into the HTML by the htmlHeader.ftl script. See htmlHeader area  for more information.
    • tabChannels: Exclusion of the page from rendering in a variation, for example the smartphone variation. See Targeting specific content for more information.
    • tabDependencies: Automatically renders a list of dependent pages and DMS assets. This functionality relies on the Content Dependencies module and is an EE feature.

The master configuration is in Dialog Defintions > /generic/master/basePageProperties.

The individual dialogs are in /<page folder>/<template name>Properties.

Here's the dialog that editors see.

Intro dialogs

All templates except stkHome and stkRedirect have a Page Header component located in the main/intro area.

This component is intrinsic to the page template and not configured in the same way as most other components. See intro area  for more information about this page area.

The intro dialogs differ from template to template and are in Dialog Definitions > /pages/<page folder>/<template name>Intro. These dialogs:

  • Are assigned in the intro area definition of the page template definition.
  • Are accessed by clicking the Edit icon in the Page Header toolbar.
  • Allow for content entry that is:
    • Appropriate for each template and in some cases distinguishes the template. For example the stkArticleIntro dialog includes content categorization and the stkEventIntro dialog includes event-specific fields such as eventTitle, dateEnd and location.
    • Used in teasers that reference the page. Most internal teasers include the title, kicker, abstract and image content entered in the intro dialog.

Here's the definition for the stkArticleIntro dialog.

Here's the dialog the editor sees.

Component dialogs

The component dialogs are configured in Dialog Definitions > /components. The dialog definitions are arranged in child folders by component type. The folder and dialog definition names correspond with those of the  component template definitions configured in Templates Definitions > /components. Each component definition references a corresponding dialog definition in the dialog property node. Each dialog definition is unique and caters for content fields appropriate for the corresponding component.

 

 

  • No labels