Locations¶
When a new content item is published, it is automatically placed in a new Location.
All Locations form a tree which is the basic way of organizing content in the system. Every published content item has a Location and, as a consequence, also a place in this tree.
A content item receives a Location only once it has been published. This means that a new unpublished draft does not have a Location yet. You can find drats in the Drafts tab in the Content menu.
A content item can have more than one Location. It is then present in two or more places in the tree. For example, an article can be at the same time under "Local news" and "Sports news". Even in such a case, one of these places is always the main Location.
You can change the main Location in the Back Office in the Locations tab, or through the API.
Top level Locations¶
The content tree is hierarchical. It has an empty root Location at the top and a structure of dependent Locations below it. Every Location (aside from the root) has one parent Location and can have any number of children.
Top level Locations are direct children of the root of the tree. The root has Location ID 1, is not related to any content items and should not be used directly.
Under this root there are preset top level Locations in each installation which cannot be deleted.
Content¶
The top level Location for the actual contents of a site can be viewed by selecting the Content structure tab in the Content mode interface.
This part of the tree is typically used for organizing folders, articles, information pages, etc. The default ID number of this Location is 2, but it can be modified via configuration. It contains a Folder content item.
Media¶
Media is the top level Location which stores and organizes information that is frequently used by content items located below the Content node.
It usually contains images, animations, documents and other files. The default ID number of the Media Location is 43, but it can be modified via configuration. It contains a Folder content item.
Users¶
Users is the top level Location that contains the built-in system for managing User accounts.
A User is simply a content item of the User account content type. The Users are organized within User Group content items below this Location.
In other words, the Users Location contains the actual Users and User Groups, which can be viewed by selecting the Users tab in the Admin Panel.
The default ID number of the Users Location is 5. It contains User Group content items.
Forms ¶
Forms is the top level Location that is intended for Forms created using the Form Builder.
Other top level Locations¶
You should not add any more content directly below Location 1, but instead store any content under one of those top-level Locations.
Location visibility¶
Location visibility allows you to control which parts of the content tree are available on the front page.
Once a content item is published, it cannot be un-published. When the Location of a content item is hidden, the system will not display it on the website.
Visibility and permissions
The visibility switcher is a convenient feature for withdrawing content from the frontend. It acts as a filter in the frontend by default. You can choose to respect it or ignore it in your code. It isn't permission-based, and doesn't restrict access to content. Hidden content can be read through other means, like the REST API.
If you need to restrict access to a given content item, you could create a role that grants read access for a given Section or Object State, and set a different Section or Object State for the given Content. Or use other permission-based Limitations.
If a content item is hidden, it is invisible in all its Locations. If a Location is hidden, all of its descendants in the tree will be hidden as well. This means that there are three different visibility statuses:
- Visible
- Hidden
- Hidden by superior
All Locations and content items are visible by default. If a Location is made invisible manually, its status is set to Hidden. All Locations under it will change status to Hidden by superior. A content item is Hidden by superior only in Locations in which it has a parent Location with the Hidden status.
In the following example, the Content item 1 is Hidden by superior in the Location A while still visible in the Location B.
From the visitor's perspective a Location behaves the same whether its status is Hidden or Hidden by superior – it will be unavailable on the front page.
The difference is that a Location Hidden by superior cannot be revealed separately from their parent(s). It will only become visible once all of its parent Locations are made visible again.
A Hidden by superior status does not override a Hidden status. This means that if a Location is Hidden manually and later one of its ancestors is hidden as well, the first Location's status does not change – it remains Hidden (not Hidden by superior). If the ancestor Location is made visible again, the first Location still remains hidden.
The way visibility works can be illustrated using the following scenarios:
Hiding a visible Location¶
When you hide a Location that was visible before, it will get the status Hidden. Its child Locations will be Hidden by superior. The visibility status of child Locations that were already Hidden or Hidden by superior will not change.
Hiding a Location which is Hidden by superior¶
When you explicitly hide a Location which was Hidden by superior, it will get the status Hidden. Since the underlying Locations are already either Hidden or Hidden by superior, their visibility status will not be changed.
Revealing a Location with a visible ancestor¶
When you reveal a Location which has a visible ancestor, this Location and its children will become visible. However, child Locations that were explicitly hidden by a user will keep their Hidden status (and their children will remain Hidden by superior).
Revealing a Location with a Hidden ancestor¶
When you reveal a Location that has a Hidden ancestor, it will not become Visible itself. Because it still has invisible ancestors, its status will change to Hidden by superior.
In short
A Location can only be Visible when all of its ancestors are Visible as well.
Visibility mechanics¶
The visibility mechanics are controlled by two flags: Hidden flag and Invisible flag. The Hidden flag informs whether the node has been hidden by a user or not. A raised Invisible flag means that the node is invisible either because it was hidden by a user or by the system. Together, the flags represent the three visibility statuses:
| Hidden flag | Invisible flag | Status |
|---|---|---|
| - | - | The Location is visible. |
| 1 | 1 | The Location is invisible and it was hidden by a user (Hidden). |
| - | 1 | The Location is invisible and it was hidden by the system because its ancestor is hidden/invisible (Hidden by superior). |
Note
Displaying visible or hidden Locations in governed by the Visibility Search Criterion