Documentation

The Brand Portal presents brand guidelines inside AWP: logos, colours, typography and usage rules, next to the assets they describe. A colour swatch icon in the header opens it; it is shown when the Brand Portal is enabled and the user may see it. Its content is a tree of brand pages.

The pages are items of a hierarchical object type in Fylr. Each item is one page, the hierarchy of the items is the page tree, and the content of a page is a list of blocks stored in a nested table of the item. As the pages are ordinary items, Fylr's pools and permissions decide which users see which page, and editors maintain them in Fylr like any other item or edit, create and delete them directly in AWP.

The options are set in the Brand Portal panel below General in the AWP configuration.

• Create a hierarchical object type for the pages in Fylr, or use an existing one.
• In the Brand Portal panel below General in the AWP configuration enable Show Brand Portal from, select the object type and click Prepare. This adds the fields listed below to the data model, including the nested table for the blocks and a link field to the main object type of AWP.
• Add the awp_bp_ fields and the nested table awp_bp_blocks with its fields to the mask AWP uses for the object type. The Brand Portal relies on all of them being in that mask.
• If the object type is pool-managed, select the Pool for pages. The first page can only be created in AWP when a pool is selected.
• Optionally select the View Set for item details. Its Information View decides which fields the item dialog of a records block shows. Preselected is the default view set of AWP. Check Render Markdown in item details to format its field values as Markdown.
• Optionally check Limit Brand Portal to Guest Users. The Brand Portal is never shown in sessions opened from a PIN collection or a dynamic collection link.

For example, the options of a records block showing 24 items without Show in Search Result (query left out):

{"query": "...", "count": 24, "reveal": false}

The option colors of a colors block lists the colours, each with its name, its hex value and any number of further values:

{"colors": [
  {"name": "Attention Blue", "hex": "#003da5", "values": ["RGB 0 61 165", "CMYK 100 70 0 0", "Pantone 293 C"]},
  {"name": "Signal Orange", "hex": "#ff6a13", "values": ["RGB 255 106 19"]}
]}

Colours without a valid hex value are skipped.

The query of a records block is run when the page is opened, so the block always shows the current items. It only finds items the user may see and that match the Limit to items matching query of the General panel. If it finds no item, for example because the user may not see any of them, the whole block including its heading and text is hidden.

The page tree on the left lists the pages; the search field above it filters the tree by page title. Pressing Escape or the close button returns to the search result. The browser's back and forward buttons move between the pages.

Each page has its own address ending in /brandpage=<slug>, for example https://example.com/awp/main/thumbnailview/brandpage=logo. It can be bookmarked or shared; opening it shows the page directly. An unknown slug opens the first page.

Users who have write permission on a page item in Fylr see an edit icon above the page. Guests never see it, nor the icons to create and delete pages. The editor lists the blocks of the page; each block has a toolbar to set its width, move it up or down, duplicate it or delete it. A block can also be dragged to another place by the grip at the left of its toolbar. Add block at the end adds a block of the chosen type.

The two icons next to the Blocks heading switch between the list of blocks and the layout view. The layout view arranges the blocks like the page, so blocks of half or a quarter of the width are placed next to each other; a block dropped on the left or right half of such a block is placed before or after it. The browser remembers the chosen view.

• The Page section at the top sets the title of the page in every language, its link name (the slug in the page address, taken from the title when empty and unique among all pages) and its place in the page tree: the parent page and the position among the pages on that level. Changing the link name breaks links to the page that were shared before; the editor warns about it.
• Title, heading and text can be edited in every language enabled in AWP, independent of the language AWP is shown in. The language buttons above the blocks switch all fields at once; a dot marks languages in which texts of the default language are not translated yet, and the tooltip of each button tells whether all texts are translated. An untranslated field shows the text of the default language in italics and is marked as not translated. The buttons above the text insert Markdown for headings of three levels, bold, italic, code, links, bulleted and numbered lists, quotes and horizontal lines; headings, lists and quotes apply to every selected line. The two icons next to them switch between editing the text and a preview of the formatted text.
• Images are uploaded with Upload image and stored in the block. Remove image removes the image.
• The download item of an image or do's and don'ts block is chosen by searching the main object type. Only items the user may see in AWP are found.
• Colours are edited in a table with name, hex value and further values; the colour field next to each row picks the hex value.
• The query of a records block is typed as a Fylr search query.

The disc icon above the blocks saves all blocks of the page at once and shows the page with the changes, the close icon next to it discards them.

The new subpage icon right of the edit icon, shown to the same users as the edit icon, creates a page. Its dialog asks for the title only; the page is added as the last subpage of the current page, created right away in the pool of the current page with a link name taken from the title, and opens in the editor. Its place in the page tree can be changed afterwards in the Page section. A further top-level page is created the same way: create it as a subpage, then select Top level as parent page in the Page section or drag it in the page tree.

The trash icon deletes the current page after a confirmation and then shows its parent page, or the first page if it was a top-level page. It is shown to users who have delete permission on the page item in Fylr, and only for pages without subpages; move or delete the subpages first. The page is deleted in Fylr like any other item.

Pages can also be moved by dragging them in the page tree; this is offered for every page the user may edit. Dropping a page on the upper edge of another page places it before that page, on the lower edge after it, and in the middle makes it the last subpage of that page. A page cannot be dropped onto one of its own subpages.

As long as no page exists, users who may create items of the object type (in the Pool for pages, if the object type is pool-managed) see a Create first page icon instead. The page is created at the top level.