Brand Guidelines (v10.5+)
The purpose of the Brand Guidelines plugin is to allow users to set out compliance requirements for their brand. For example what logos to use and where they can be used and colours to use in branding materials, tone of voice and more.
Access control
By default, all user groups with the bgv permission will be able to View the guidelines.
Edit access will only be available to either admin user groups (permission a) or those with the bge permission.
Management: sections & pages
The brand guidelines admins can add new sections/pages using the table of contents sidebar links.
A Section is the top level of the table of contents - used simply for organising pages, you cannot add content to sections. A Page resides within a section and contains the branding guidelines content.
When hovered, each item can reveal a contextual menu (icon: ) from which admins can:
- Edit - change name and/or section (if page);
- Delete - if confirmed will delete that record (including its content) and, if it's a section, all of its pages;
- Re-order (move up/down the list) the item - this is done only within its current level (e.g. when a page is moved up, only its siblings get updated, leaving its section or other pages from different sections alone).
Internationalisation
Sections/Pages support our multi-lingual sytax. You can access it only when creating/editing a record.
Management: content
There are different types of Content supported:
- Rich text
- Resources
- Colour
To add content on a page, admins can use either the Add new content button or when desired to add similar items to a content group (see below) use the + (additional) button.
When hovered, each content item can reveal a contextual menu (icon: ) from which allows admins to:
- Edit;
- Delete - if confirmed will delete that record and, if it's a group, all of its members;
- Re-order the item up/down and, if it's a group and applicable, left/right.
Grouping content items
ResourceSpace will automatically group sequential (and similar) page content items. This is applicable only for colour and half-width/thumbnail resource types. To move an item out of a group it has to be at one of the extremities (left for moving up, right for moving down).
Groups have actions too, mainly to delete (all item members) or move an entire group up/down.
Text (rich text) content
Admins can write as much rich text as they need to provide the right context to their readers. If you need to insert line breaks use Shift + Enter.
Resource content
When adding new resource content, admins can either upload a new file or use existing resources. In both cases, the admin ultimately ends up adding an existing resource to the page.
Clicking on a resource content item will take the user to the view page of that resource. For videos, users will have to click on the resource title (displayed top-left) or the caption instead.
Different layouts give the ability to configure more information. For example: half-width resources accept an optional caption.
ResourceSpace will automatically select an appropriate image size for resource content or show its "no preview" placeholder instead. Admins can navigate to the plugins' configuration page to select a fallback size for each of the available layouts. For example, when displaying a half-width resource, if it doesn't have the "Preview" size an admin may decide to fallback on the "Screen" size instead.
Colour content
Colours can be added to help both visually and technically the guidelines readers. Admins can add colours using HEX (including short notation, e.g. #FFF), RGB or CMYK values. When input into any of the fields, the others will automatically be calculated based on the input value.
It's important for admins to always input the value their designers normally work with.
Colour names support our multi-lingual sytax.
Toggling view/edit modes
Brand guidelines admins have the ability to toggle between the view and edit modes of the page. By default they see the view page (same as everyone else) and have the ability to switch to the edit mode should they want to modify it in any way.
The preference is temporarily persisted on the client side (i.e. browser) for one day so navigating between pages or refreshing (e.g. when deleting an item) will allow you to keep the mode selected.
Logging
Most Brand Guidelines actions carried out by admins are logged, except re-ordering. The relevant tables in the log are:
- brand_guidelines_pages
- brand_guidelines_content
You can determine who created/edited/deleted any guideline items (sections/pages/content).