URLs, Paths and Links in Organizer

While using Organizer, you will notice that the URL bar changes depending on where you are and what you click on.

Organizer makes use of paths, which are made up from the names of the elements and properties in the .yaml files. If you ever need to access a panel in Organizer in your module's code, then you will need to know the correct path to that panel.

There are actually two different types of path: tag paths and navigation paths.

Tag Paths

The tag path to a panel is the direct path in the data to the panel - i.e. from the top of the .yaml file to the panel: definition.

When you create a link to a panel, you will need to specify its tag path.

When the CMS calls one of your module's methods (e.g. fillOrganizerPanel()) it will specify the tag path of the panel that is being accessed.

Navigation Paths

If an administrator clicks a link that uses a refiner, then their current location can no longer be specified using a direct tag path. Instead, a more complicated type of link called a navigation path will appear in the URL bar.

Navigation paths also work by listing the path taken, however the navigation path will go from the top of the .yaml file to the link that was clicked on.

If the link was inside an item_button or an inline_button, and an item on the panel was selected, the id of the item will be included in the navigation path.

As the administrator goes through multiple refiners, the tag path between each link and the id of each item will be added to the navigation path in turn.

Which type of Path to use

Most properties in TUIX that accept paths only accept a tag path, but some properties can accept both types of path.

The documentation for a property will specifically tell you which type of path you can use.

Tag Paths in Admin Boxes

Technically, the Admin Boxes also use tag paths, and when you open an Admin Box you need to specify the path. However these "paths" are only ever one tag long.