Editing pages
A page built with Variflow Builder lives in one field of an entry. You edit it in the page editor, which opens over the entry's publish form, and you save it with the entry's own Save button, so statuses, revisions and permissions work exactly as they do for any other field.
Everything in the editor works from the keyboard, and every action is announced to screen readers.
Opening the editor
The Builder field in the publish form shows one button, Launch Variflow Page Builder. Choose it to open the editor full-screen. (If the field has a problem, such as a page that couldn't be read, its message shows above the button.)
- An empty page opens on a start prompt (below). Pick something to begin.
- Close the editor with Done, or with Escape (it asks first if you've changed anything). Your changes stay in the form, and nothing is kept until you save the entry. If you leave the page without saving, your browser warns you.
- Preview opens the entry in EE's own Live Preview with your unsaved changes, if the channel has a preview URL. You rarely need it: the editor's centre already shows the page.
The start prompt
A new page (a Builder field with nothing in it yet) opens on Start this page instead of an empty canvas:
- up to six of the field's section patterns, the ones this channel's pages use most first (then the order your developer listed them), each a card with its icon, name and description;
- Blank section, if the field allows sections that don't come from a pattern: the field's default section (or its first), empty, to lay out yourself;
- Browse all patterns, which opens the Library's Patterns tab;
- Start with an empty page, which closes the prompt and leaves Plan's empty page with + Add section.
Choosing a card adds it and closes the prompt, as one step you can undo (undoing it leaves the empty page, not the prompt).
The editor
The editor has three columns. F6 moves to the next one, Shift+F6 to the previous one.
- Left: the Library. What you can add and your site's design tokens, on three tabs: Components (blank sections, components and layouts), Patterns (section and content patterns) and Tokens (schemes, variants, spacing and colour steps), with a search box (Adding).
- Centre: the page. The Canvas shows the page itself, as visitors will see it (below). Plan shows it as an outline instead (below): each section is a band, its layouts drawn as their columns, each component a card with its main words, and every item with its type's icon and its tokens as small chips. Switch with Canvas | Plan above the page; the editor remembers your choice in this browser. Choose Desktop, Tablet or Phone in the toolbar to see the page at that width: columns stack on phones and some use different widths on tablets.
- Right: the inspector. What's selected: where it is, its content, its appearance and what you can do with it. Its labels sit above their controls and it never scrolls sideways: a long row of spacing steps becomes a dropdown, and long names wrap between words, never inside one (a single word too long for its space is cut short with "…", and pointing at it shows it all). Some fields show only when they apply: an image's Focus only once its Shape crops it, say. A field that's hidden keeps what it was set to, so switching back brings it back.
Selecting something in one column selects it in the others.
The toolbar's buttons
Most of the editor's buttons are icons. Each has a name that screen readers read, and pointing at one (or reaching it with Tab) shows its name in a small tooltip, with its shortcut if it has one. A pressed button (the device you're showing, the grid when it's on) has a coloured edge.
| Icon | Name | Where |
|---|---|---|
| ↶, ↷ | Undo, Redo | The top bar |
| Monitor, tablet, phone | Desktop, Tablet, Phone | The top bar (one is pressed) |
</> |
Edit JSON | The top bar, for developers (below) |
| Columns | Show the grid | Above the canvas (The grid) |
| Colour square | Grid colour and opacity | Beside it |
| Circular arrow | Reload page | Above the canvas |
| Lines, cards | Compact, Comfortable | The Library (Adding) |
| + | Add to page… | Beside each Library item |
| Target | Apply to… | Beside each Library token |
| Arrow to a line | Select parent | The inspector, beside the breadcrumb |
| ↑, ↓, ←, → | Move up, Move down, To previous column, To next column | The inspector's Item |
| Arrow out of a box | Out of this layout | The inspector's Item |
| Four arrows | Move… | The inspector's Item |
| Two squares | Duplicate | The inspector's Item (Remove is a word, set apart) |
| Six dots | The drag handle | Plan's items, the selection's tab on the canvas |
| ⋯ | The item's menu | Plan's items |
The canvas
The canvas is the entry's real page, made by your site's own templates through EE's Live Preview, with your unsaved changes in it. What you see there is what visitors get when you save.
- Selecting: pointing at something outlines it; clicking selects it, and the breadcrumb and the inspector follow. The selection has a small tab: a drag handle (six dots) for moving it, its type's icon and name (and a lock if it's part of something locked), and a ▾ for its menu, which has Select parent, Move…, Move up, Move down, Duplicate and Remove, as in the inspector. Clicking an empty part of a column selects the column. Selecting something in the breadcrumb (or in Plan, then back to the canvas) scrolls the page to it.
- Columns: with a section (or one of its layouts or columns) selected, the canvas outlines its columns, drawn over the page, never in it. Each has a small label (Column 1, …) that selects it. An empty column, such as a new band's, shows as a dashed box with + Add, at least 64 pixels tall even when it has no height on the page; click the box to select the column. + Add opens a short menu beside it of what fits in that column (arrow keys move through it, Enter adds, Esc closes it); what you choose lands in the column. A column that already holds items has no +: drag from the Library, or select the column and click a Library item, or use the Library's + (Add to page…). Esc walks back out: column, then layout, then section.
- Empty columns: a column with nothing in it has no height on the page, so the canvas always draws it, whatever is selected: a thin dashed box, at least 64 pixels tall, saying Column 2: empty. Pointing at it draws it in full and shows its + Add; clicking it selects the column (and then its section's columns are drawn as above). While you drag, an empty column the drop marker covers shows the marker instead.
- Empty items: a heading, text or image you haven't filled in yet has no size on the page, so the canvas draws a dashed placeholder where it is, with its icon and name (Heading: empty). Point at it, click it to select it, or drag it to move it, as you would the item itself. Its + Add opens the same menu, and what you choose goes after it. Once the item has content, the placeholder goes and the item itself is what you click.
- Links and forms on the canvas don't go anywhere: clicking a link selects it. The page's own scripts still run, so sliders and menus behave as they do on the site.
- Updates: a change you make in the inspector shows on the page within a moment. Only the section you changed is redrawn, so the page doesn't jump. Adding, moving or removing whole sections reloads the page; it comes back at the same place with the same selection.
- Devices: Tablet and Phone show the page at 820 and 390 pixels wide. When the space is narrower than the device, the page is scaled down to fit.
- Hidden things: something inside a closed accordion or an inactive tab can still be selected in Plan, where everything is listed. Back on the canvas, it opens the accordion or tab when it can; otherwise it says the item "isn't visible on the page".
- Reload page (the circular arrow above the canvas) loads the page again, keeping where you were and what's selected.
The grid
Show the grid (above the canvas) draws your design's grid over the selected section: its container's edges, and its columns with the gutters between them, as your token file defines them. Select a component and you see the grid of the section it's in; with nothing selected, every section's. It's drawn over the page in the editor only: the page itself, and what visitors get, never change.
While you drag a column divider, the layout's own columns show (whether the grid is on or not), so you can see where it will snap.
The grid is light blue at first. If it gets lost in a design, Grid colour and opacity (the small square beside it) offers Light blue, Pink and Dark (high contrast), and an Opacity slider. The editor remembers the grid, its colour and its opacity for you in this browser; they're never part of the page.
Editing on the page
Fields your developer has marked as editable in place (headings, captions, short text, button labels, rich text) are edited right on the canvas: select the item, then click the words again (or press Enter to start on its first one).
- Enter saves a one-line field; Escape cancels. Leaving the field saves it too.
- Pasted text arrives as plain text, and a field stops at its length limit.
- Rich text gets a small toolbar above it: Bold, Italic, Link and lists (⌘K or Ctrl+K adds a link too). For anything bigger, use the inspector's editor.
- Images: double-click one to choose a file with EE's file picker, or drag an image file from your desktop onto the item: it's uploaded into the item's image.
- Every change made on the page is a step in Undo, and the inspector shows it at once.
- Locked items can still have their words, links and images edited in place, and nothing else.
- An empty optional field (an eyebrow you haven't filled in, say) isn't on the page, so fill it in in the inspector.
When the canvas can't show the page
- No preview URL: the editor says "This channel has no preview URL — set one in Channel › Settings", with a link to the channel's settings, and shows the Plan instead. Pages managed by Structure (or EE's Pages module) use their page's URL, so they don't need one. Entries in a channel whose Live Preview is turned off get the same message.
- The page doesn't load within 10 seconds, or loads with an error so Builder can't connect to it: the canvas says so, with Try again and Show the plan. Your changes are never affected: keep editing in Plan and the inspector, and save as usual.
- Problems in a part: something that can't be shown (a part with an error in its template, say) shows a dashed Variflow Builder notice in its place on the canvas. Visitors never see these.
- Your control panel session ended: the editor says so. Your changes stay in the form: log in again when the control panel asks, then save.
Plan
Plan is the page as an outline: the one place to see and rearrange its whole structure, and the way through the page from the keyboard and with a screen reader.
- Each item shows its type's icon (the same as in the Library), its name, its main words, a lock (Locked, Structured or Fixed), a section's pattern ("from Home hero") and a ⚠ problem badge where they apply, written out rather than shown by colour alone, a drag handle (six dots), a menu (⋯: Select parent, Move…, Move up, Move down, Duplicate, Remove, and where they apply Save as pattern… and Detach from pattern) and its token chips (Tokens). A copy of a pattern that has changed since it was inserted says Out of date (Locked parts). The handle and menu show when you point at the item, select it or reach it with the keyboard. Click an item to select it; the arrow before its name opens and closes it.
- A full-width layout with one column (the usual case) draws no Layout or Column boxes: its items sit right under the section's name, with a small full tag; click the tag to select the layout. It's still there for the keyboard and screen readers: arrow down from the section to the layout, then its column (outlined when it has focus), then the items. Layouts with more columns are drawn as their columns.
- Dragging works here exactly as on the canvas (below): drag an item's handle to move it, or a Library item in, and Plan shows the same places (a line, an edge, a column, a "New section" band) for the same rules. The empty area below the last section makes a new section. The outline scrolls when you drag near its top or bottom.
- Column dividers show between the columns of the selected layout when they sit side by side (on the device you've chosen), and work as on the canvas; while you drag one, the layout's grid columns show behind it.
- It's a tree for the keyboard and screen readers: ↑/↓ move through it, →/← open and close items, Home/End go to the first and last, and typing a name jumps to the next item that starts with it (except M, which is Move…). Enter selects, F2 goes to the first field, Alt+↑/Alt+↓ move the item, M (or Enter on its handle) moves it anywhere, Shift+F10 opens its menu, Delete removes it and Ctrl+D (⌘D) duplicates it. Tab from an item reaches its chips, + Add, handle and menu.
- Selecting several items side by side in a column, to save them as a pattern: Shift-click the last one, or Shift+↑/Shift+↓ from the first. They're all marked selected, and their menu offers Save N items as a pattern….
With the canvas showing, switch to Plan with Canvas | Plan (F6 reaches it) whenever you want the outline: the selection stays as it is.
Adding
The Library always lists everything this field allows, whatever is selected, on two tabs: Components (blank sections, components and layouts) and Patterns (section and content patterns); Tokens is the third (Tokens). ←/→ move between the tabs. The line at its top says where a click puts an item:
- with nothing selected: at the end of the page. A section goes there; a component, content pattern or layout goes in a new section there (the field's default section, the item in one full-width column);
- with a section selected: into it, at the end of its column ("Adds into Section."), or, when it has more than one, of its last column ("Adds into Call to action › Column 2.");
- with a layout selected: into its last column;
- with a column selected: into the column, at its end;
- with a component selected: after it, in the same column;
- with a container selected (a row of buttons, a list of features, a panel): inside it, if it holds that kind of item.
Sections and section patterns always go after the selected section (or at the end of the page): they never go inside one.
When it doesn't fit there. A locked or structured pattern copy, or a section whose layout is fixed, takes nothing inside it; a column may be too narrow for an item (a story teaser in a quarter-width column, say); or a layout may nest deeper than the field allows. Clicking such an item opens a small menu by its row: Add above Hero or Add below Hero (the section you're in) makes a new section there, from the field's default section, with the item in it. ↑/↓ move in the menu, Enter chooses, Escape closes it and changes nothing. The line at the top says so beforehand ("Adds after Hero; Hero is locked, so new items go in a new section above or below."). If the field has no default section, the menu offers Choose a place… instead (add mode, below).
When it fits nowhere. An item that can't go anywhere on this page (it needs more of the page grid's columns than any place here has, or its layouts would nest too deep) is still listed, but dimmed; point at it, or listen to its name, for why. Each component and layout says how many of the page grid's columns it needs. Components that show entries from your site, such as the latest journal stories, are marked LIVE.
Click or drag. Each item is a row with its type's icon, its name and a line of its description (point at it to read all of it; screen readers read all of it). Click a row (or press Enter on it) to add it where the line at the top says. Drag it instead (a grip shows when you point at it) to put it exactly where you want on the page or in Plan: dragging shows only the places it fits, empty sections and a new section between sections included (below). Its + (Add to page…) does the same from the keyboard (below). A new section, however it's added, is scrolled into view.
Compact and Comfortable (the two buttons beside the search box) switch between these rows and taller cards with two lines of description. The editor remembers your choice for you in this browser.
+ Add section (at the end of Plan) and + Add (in each column in Plan) take you straight to the Library for that place (on the canvas, + Add opens a menu by it instead); after + Add section the line says the section goes after the selected one ("Adds a section after Section."), just for that add. Search the Library at its top narrows every tab, tokens too, to what matches.
Dragging and dropping
On the canvas and in Plan you can build by dragging: Library items onto the page, items already on it to a new place, the dividers between columns to change a layout's widths, and tokens onto items (Tokens). Everything dragging does can also be done from the keyboard (below), and every drag is one step in Undo.
Drop targets
Press on a Library item (or an item's drag handle) and move: a label follows the pointer, and the page shows where it can go near the pointer, with the one it will use highlighted and named ("After Heading in Column 1 of 8/4 in Call to action"). Let go to drop it there. Only places where it fits are ever shown, so where nothing is shown, nothing fits.
- A line above or below an item: it goes in the same column (or container), before or after that item.
- A highlighted edge on an item's left or right side: the item and the new one go side by side (below).
- A shaded column: an empty column takes it.
- A "New section" band at a section's top or bottom edge, or on the page outside any section: a new section, from the field's default section, with the item in it. (Only when the field has a default section and allows open sections.)
- Sections go only between sections: dragging one shows a line between the sections.
Locked sections and locked or structured parts take nothing inside them: they only show places above and below. Something too wide for a column, or a layout that would nest too deep, never gets a target there.
Near the top or bottom of the page the canvas scrolls. Escape, or letting go outside the page, cancels and changes nothing. A dropped item is selected, and the page updates as it does for any change.
Moving an item: drag its handle (six dots): in Plan every item has one; on the canvas it's on the selected item's tab. The item is dimmed in its place while it moves, and it takes everything inside it. Moving the last item out of a column leaves the column empty.
On a touch screen (a tablet), press and hold an item for a moment to start dragging it; a touch that moves straight away scrolls as usual.
Splitting into columns
Drop beside an item (on its left or right edge) to put the new item next to it:
- An item alone in a full-width column becomes two halves (6/6), the new one on the side you dropped. Beside one of two halves, it becomes three across (4/4/4), then four across (3/3/3/3), and so on through your grid's equal layouts, as long as everything in every column still fits. When the next one doesn't fit, or there isn't one, there's no side target.
- An item that shares its column with others (or sits in a layout with unequal columns, such as 8/4) is wrapped with the new one in a two-column layout inside that column, if it fits there.
Resizing columns
Select a layout (or point at the gap between its columns) to show a divider between each pair of columns. Drag a divider sideways: it snaps to the layout presets with the same number of columns that fit (6/6, 8/4, 4/8…), and a label shows the result ("8 / 4"). Let go to apply it; Escape cancels.
If the field allows any column (its Column dividers setting), hold Alt (⌥ on a Mac) while dragging to see a stop at every single grid column instead (7 / 5, say), as long as every column stays at least the grid's narrowest width and fits what's in it. A width that isn't a preset is kept as the layout's own (shown as "custom" in Plan); choosing a preset in the inspector later replaces it. Sections that allow only some layouts offer only those.
From the keyboard: Tab to a divider, then ← and → move between stops (hold Alt/⌥ for single columns where allowed), Enter applies and Escape cancels.
Changing content
The inspector's Content shows each field with the matching control: text, longer text, rich text, numbers, choices, on/off, links (URL and label) and images. A change is made when you leave the field.
An image shows its thumbnail and file name, with Replace and Remove. With none yet, the field is a drop zone:
- Drop an image file on it, or Upload one. It goes into the File Manager like any upload, into the field's folder (pick it under Upload to when there are several).
- Choose file opens EE's File Manager.
- From Assets lists Variflow's assets (Tokens › Assets), such as the logo. The page then follows the asset: replace the file on the Assets page and every page shows the new one.
Alt text says what the image shows. Leave it empty and the file's description is used (the
field shows it greyed). Tick Decorative for an image that's only there for looks: screen
readers skip it, and the publish check doesn't ask for alt text. Advanced shows the stored
value (a file ID, a path, an https:// address or asset:<name>).
Appearance shows only the options the part has: the Look (a scheme, drawn in its colours), the Style (a component's variant), spacing and colour options as token pickers, and the Content width (Default, Wide or Full) for sections. Every choice is one of your design tokens; there's nowhere to type a colour or a size.
Space above and Space below are on every component: the gap before and after that one item. Standard (the default) is the site's usual spacing; pick a step to open it up or tighten it, and Use standard spacing goes back. The step applies at every screen size.
A long colour list (an Accent) comes in groups from the token file, with the palette closed until you open it, the current colour pinned on top and a filter box; colours the token file hides from editors are never offered.
Picking entries
Some components list entries you choose yourself, such as Featured stories: their field shows the picked entries in order, each with its title, channel, status and date, and how many you've picked of the most allowed (2 of 6 picked).
- Add entries… opens a search under the list. It only ever offers entries the field takes (its channels and statuses, on this site) and that you can see in the control panel. Type to search by title; with several channels, choose one. Results come 20 at a time, newest first, with Previous and Next. Click one (or press Enter) to add it to the end of the list. Entries you've already picked say Added and can't be added twice. When the list is full, adding stops and the search says why: remove one to add another. Done or Escape closes it.
- Reorder by dragging a row's grip (⠿), or with the keyboard: Tab to the grip and press Alt+↑ or Alt+↓.
- Remove with the row's ✕.
Each add, remove and move is one step you can undo ("Add 'Linen apron' to Featured stories"), and the page on the canvas updates that section. The page shows the entries in your order.
An entry someone has switched off (closed, scheduled for later, or expired) stays in the list under its title, with a quiet note: "Not shown while it's closed". It isn't a problem: the site leaves it out, saving goes ahead, and it shows again when the entry is reopened. So you can turn a case study or story off without touching the pages that feature it.
An entry that can't come back by itself (deleted, or moved to another channel or site) stays in the list as Entry 48 with the reason ("Deleted", "Not in Journal") instead of its title, and is a problem on the page. The site leaves it out quietly. Remove it.
Components that show entries (marked LIVE) have What it shows: a line saying what the query is ("Latest 3 from Journal") and its options, such as a topic and how many to show.
Layouts
Select a layout to change its Layout preset. Only presets that fit where the layout sits are listed. The columns keep their content: if the new layout has fewer columns, the items of the columns that go move to the end of the last column; if it has more, the new columns start empty. Changing the number of columns asks first.
Phone order
A layout with two or more columns has On phones in the inspector: In order (the first column on top) or Last column first (stacked in reverse: a 6/6 shows its right column first; a layout of three columns stacks 3, 2, 1). It's one step you can undo. Choose Phone above the page to see it: the canvas shows the real page at phone width, and Plan draws the columns in their phone order. Plan marks such a layout phone: reversed on every device.
A locked or structured pattern copy keeps its pattern's phone order, unless the pattern lets editors change it.
Narrow layouts
Some components have a layout for narrow columns (your developer's narrowLayout): Latest from
the journal becomes a list in a column narrower than two-thirds of the page, say. Where one does,
Plan shows Shown as List here on it and the inspector says so, with why (how wide the column
is in the page's grid, and how wide it needs to be for the full layout). The choice is made from
the column's width in the grid, so it's the same on every screen: at tablet and phone widths the
note says the column is wider there but the layout stays. Move the component to a wider column,
or change the layout, to get its full layout back.
Moving, copying and removing
The inspector's Item actions, for whatever is selected:
These are icon buttons, each with its name as a tooltip (the toolbar's buttons):
- Move…, to move it anywhere it fits, with the keyboard (below);
- Move up and Move down, within its column, container or the page;
- To previous column and To next column, when the item fits there;
- Out of this layout, for an item in a layout that's inside another column;
- Duplicate, which puts a copy right after it;
- Remove, a word rather than an icon, set apart from the rest. A message offers Undo straight away.
Moving and adding with the keyboard
Move mode moves the selected item anywhere it fits: choose Move… in the inspector or the selection tab's menu or an item's menu in Plan, press M in Plan, or press Enter on a drag handle. Add mode is the same for something new: the + button beside each Library item (Add to page…).
A bar above the page says what's moving and where it would go ("4 of 37: After Heading in Column 1 of 8/4 in Call to action"); the canvas (or Plan) draws that place and scrolls to it, and a screen reader reads it.
- ↓ or →, ↑ or ←: the next or previous place (the same places dragging offers);
- Page Down, Page Up: the first place in the next or previous section; Home, End: the first or last place;
- Enter drops it there; Escape cancels and changes nothing.
Tokens
Your site's design tokens are on the Library's Tokens tab: the schemes (looks), the variants of each component (Button, Card…), and every spacing, colour or other token group a part's appearance uses (Space, Color, Radius…), each with a swatch drawn as the pickers draw it. With an item selected, the tab lists only what that item takes; tick All tokens to see everything. The search box narrows it too.
Chips. In Plan each item shows the tokens it uses as chips, small rounded pills with a swatch: its look ("Aa Light"), its variant, and its appearance values (space above and below, an accent…). A chip with a dashed edge is the part's default, not something set on this item. Each chip starts with which option it's for: ↑ and ↓ for space above and below (and ←, → for left and right), otherwise the option's first word ("Look", "Accent"); its full name is in its tooltip and what screen readers read ("Space above: 3XL · 96px"). The menu that asks which option a dropped token sets marks them the same way.
Dropping a token on an item sets it, as one step in Undo ("Set Card look to Dark"):
- a scheme goes on an item with a Look that allows that scheme;
- a variant goes on an item with a variant (Style) of that component;
- any other token goes on an item with an appearance option from that token's group.
The item's lock has to allow it too: a locked copy takes nothing, a structured copy only the options its pattern allows. While you drag, the items it can go on are marked and the others are dimmed; pointing at one says what the drop does, or why it can't ("Hero is locked", "Text has no variant"). When an item has two options from the same group (space above and space below, say), dropping asks which.
- Click a Library token to set it on the selected item.
- Drag a chip to another item to copy its value; hold Alt (⌥) to move it instead, and the item it came from goes back to its default. Letting go anywhere else does nothing.
- Delete on a focused chip puts that option back to its default (or change it in the inspector).
- From the keyboard, Apply to… (the target button beside each Library token, or Enter on a chip, Alt+Enter to move it) steps through the items that take it, announcing each: ↓/↑ choose, Enter applies, Escape cancels.
Tokens drop on the canvas the same way: point at the item on the page.
Locked parts
Some sections come from patterns your developer (or a site builder) has locked, so they stay as designed. They're marked with a lock in Plan and on the canvas, and the inspector says what you can change:
- Locked: only the words, links and images. You can't add, move or remove anything inside it, or change its look; you can still move, copy or remove the whole section.
- Structured: the words, links and images, and the appearance options the pattern allows.
- Fixed layout: a section whose layout is fixed (a footer, say): fill it in and style it, but its parts stay where they are.
When Builder's licence has lapsed (after the 14-day trial, on a site without a licence: see Licensing), the whole page behaves like a locked copy. The editor says so once, under its toolbar: "Builder's licence has lapsed, so page layout is locked. Text and images can still be edited." The Library, the start prompt, + Add section and the item actions are gone, and appearance and tokens can't change; edit the words, links, images and picked entries and save as usual.
Out of date. When a pattern changes after a copy of it was inserted (a new tree or lock is a new version), its copies are marked Out of date in Plan, and the inspector says which version each is. Nothing changes on the page: copies don't update from their pattern yet (that comes with synced patterns in a later release).
Detaching
Where the field allows it (Allow detaching in its settings), a locked or structured copy can be cut loose from its pattern: Detach from pattern in its menu (in Plan, or on the canvas's selection tab) or in the inspector's Item actions. After a confirm, the copy is open: you can change anything on it, and it no longer follows the pattern (later changes to the pattern, and syncing, won't reach it). It remembers which pattern it came from. Detaching is one step: Undo puts the link back. Where the field doesn't allow it, there's no Detach, and saving refuses a copy that was detached some other way.
A copy of a saved pattern that has since been deleted is open already: nothing holds it to a pattern any more.
Saving a pattern
If your role has Save patterns (a super admin grants it on Builder › Patterns), you can turn part of a page into a pattern that editors can insert anywhere the field allows it:
- Select what to save: a section, or one or more items side by side in a column (Shift-click, or Shift+↑/↓ in Plan, above). Sections make a section pattern; items make a content pattern, which goes in any column it fits.
- Choose Save as pattern… from its menu (in Plan or on the canvas's selection tab) or the inspector's Item actions.
- Give it a label (the name follows it; you can change it: lowercase letters, digits and underscores, unique on the site), a description and an icon, and choose its lock: Locked (copies change only their words, links and images), Structured (and the appearance options you tick) or Open (a starting point). What will be saved shows the outline.
- Save pattern is enabled once the server says the pattern is valid (it's checked as a developer's pattern file is, and can't hold HTML or a name that's taken); problems show in the dialog.
By default the selection becomes a copy of the new pattern, as if you'd inserted it there (untick
Make this … a copy of the new pattern to leave it as it is); that's one step you can undo. The
pattern itself is saved straight away, in the database, and appears in the Library's Patterns
tab, marked Saved, for every Builder field that allows it. To change or delete it, use
Builder › Patterns; a developer can export it to a file with variflow:builder:export-pattern
(Parts).
Problems
The page is checked as you work. Problems show in the inspector beside what they're about, and as a ⚠ problem badge in Plan and on the page (never as colour alone). With nothing selected, the inspector lists every problem on the page. You can keep working with problems.
Whether the entry saves with them depends on the field's When the page has problems setting and the entry's status (Pages). The toolbar says which, beside Done: ⚠ 2 problem(s): won't save (the entry's Save is refused, and says what's wrong, naming each place) or ⚠ 2 problem(s): saves with a warning (the entry saves, and the publish form lists the problems after saving). Click it for the list, with a fix for each problem that has one (Publish checks). Problems with the page's structure or its tokens (integrity problems) always stop the save; unfinished content (a required field left empty, text too long, a query limit out of range) can be saved where the field allows it. A new field allows it while the entry isn't published (Save drafts only); a field saved before the setting existed refuses.
Publish checks
Before an entry is published, Builder lists what's wrong with the page, each with a fix where there is one.
-
When: when you use the entry's Save (or Save & Close) with a status that publishes it (open), after opening the editor, Builder checks the page first. If it has problems (or images without alt text), Before you publish opens instead of saving. With nothing to fix, the entry saves straight away. Drafts aren't checked. The list is also there any time from the toolbar's problems button (⚠ 2 problem(s): …), as Problems on this page.
-
The list is grouped by section, in page order. It has the page's problems (the same ones the inspector shows: required fields left empty, text too long, picked entries that can't be shown any more…), and two more:
- an empty column: a column with nothing in it;
- an empty section: a section with nothing in it (its columns aren't listed one by one).
Each says whether it refuses the save: that follows the field's When the page has problems (Problems). Empty columns and sections are unfinished content, so drafts still save with them.
-
Advice: an image with no alt text, where the page shows the image's own alt text, is listed as advice. The site uses the file's description (or its title) instead, so it never stops a save, but describe the photo for people who can't see it. Parts that have their own alt text field aren't listed: that field is required instead.
-
Fixes, one click each, and each one step you can undo (the list has its own Undo after each):
- Remove the column: the layout drops to the layout with one column fewer. An even layout takes the grid's even layout (three across with one empty becomes halves, halves become full width); otherwise the column's width goes to the column beside it (8/4 with the 4 empty becomes full width) and the button says which. Where neither is a layout the section allows, there's no fix. An empty layout with one column is removed.
- Remove the section.
- Remove the unavailable entries (or Remove entry 48): the deleted picks and those in another channel or site; the others, switched-off ones included, keep their order.
- Cut to 160 characters: text cut to its field's length limit.
- Select it, for everything, and the only choice for problems without a fix (a required field to fill in): the list closes and the item (or column) is selected.
Fixes are never offered where the page can't change: a locked or structured pattern copy's columns, or a fixed section's, aren't listed as empty at all.
-
Saving anyway: Save with these problems (they don't stop this save) or Try saving anyway (some refuse it: EE shows them on the field) saves the entry as it is. Keep editing closes the list and leaves the editor open.
Undo
Every change is a step you can undo: Ctrl+Z (⌘Z on a Mac) undoes, Ctrl+Shift+Z (⇧⌘Z) or Ctrl+Y redoes, and the toolbar has Undo and Redo. The editor remembers the last 100 steps while it's open.
Keyboard shortcuts
| Keys | What they do |
|---|---|
| F6, Shift+F6 | Next or previous column (the Library, the page or Plan, the inspector) |
| Ctrl+Z (⌘Z) | Undo |
| Ctrl+Shift+Z (⇧⌘Z), Ctrl+Y | Redo |
| Alt+Shift+↑ | Select the parent of what's selected |
| Escape | Close the editor (asks first if you've changed anything); cancels a drag or move first |
| Moving or adding (move and add mode) | |
| ↓ / →, ↑ / ← | Next or previous place |
| Page Down, Page Up, Home, End | Next or previous section's first place; the first or last place |
| Enter, Escape | Drop it there; cancel |
| Applying a token (Apply to…) | |
| ↓ / →, ↑ / ← | Next or previous item that takes it |
| Page Down, Page Up, Home, End | Next or previous section's first item; the first or last item |
| Enter, Escape | Apply it there (a menu asks which option when two fit); cancel |
| The publish check | |
| Tab, Shift+Tab | Through its fixes and Select it buttons |
| Escape | Close it (keep editing) |
| On a column divider | |
| ←, → (Alt/⌥ for single columns) | Move between stops |
| Enter, Escape | Apply; cancel |
| On the canvas | |
| Escape | Select the parent of what's selected |
| Enter | Edit the selected item's first field in place |
| Enter on the drag handle | Move the selected item with the keyboard (move mode) |
| Enter, Escape (editing in place) | Save a one-line field; cancel |
| Ctrl+K (⌘K) (editing rich text) | Add a link |
| ↓ on the selection's tab | Open its menu (↑, ↓, Home, End, Escape inside it) |
| The Library's tabs | |
| ←, →, Home, End | Previous or next tab; the first or last |
| In Plan | |
| ↑, ↓, Home, End | Move through the outline |
| A letter | Jump to the next item whose name starts with it (M is Move) |
| →, ← | Open or close an item; go to its first child or its parent |
| Enter | Select the item; Enter again goes to its first field |
| F2 | Select the item and go to its first field |
| Alt+↑, Alt+↓ | Move the item up or down |
| Alt+←, Alt+→ | Move the item to the previous or next column |
| Delete | Remove the item |
| Ctrl+D (⌘D) | Duplicate the item |
| M | Move the item anywhere it fits (move mode) |
| Shift+F10, the menu key | Open the item's menu |
| Shift+↑, Shift+↓; Shift-click | Select items side by side in a column (to save them as a pattern) |
| Tab | The item's chips, + Add, handle and menu |
| On a token chip | |
| Enter, Alt+Enter | Apply to…: copy it to another item; move it |
| Delete | Put that option back to its default |
| In an entries field | |
| Alt+↑, Alt+↓ (on a row's grip) | Move the picked entry up or down |
| Enter (on a search result) | Add it |
| Escape (in the search) | Close the search |
| In a token picker | |
| Arrow keys, Home, End | Move through the choices |
| Space, Enter | Choose |
Saving
The editor never saves anything itself. When you've finished, close it and use the entry's Save (or Save & Close). The page is checked again on save. If it has problems the field refuses, EE shows them on the field and keeps your changes in the form; if the field saves with problems, the entry saves and a warning above the form lists them (Problems).
For developers
With $config['variflow_builder_json_editor'] = 'y' in config.php, the editor's toolbar has
Edit JSON: the page's tree to edit by hand. Applying it is one step you can undo, and it's
checked like any other change. See Pages for the tree.
With $config['variflow_builder_save_with_problems'] = 'y', every Builder field on the site
saves pages with content problems and warns, whatever its setting: for development sites, while
structure and templates are changing (Pages).