In-context campaign editing experience for business owners (beta)

Version 10

    Overview

    With our next release, we’re introducing a new editing experience for your business owner clients that’s intuitive and separates content from style inside your email campaigns. Using InContext Editing mark-up, you’re now able to define editable regions inside the HTML code of your email newsletter templates. Editable regions can be applied on both static (text, links, images or html) or dynamic (modules) content. When your client goes to edit the content of this template, they’re only manipulating the raw content itself, and hence are unable to break elements or the overall layout.

    How to use the new editing experience

    Enabling in-context editing for email campaigns

    Enabling this feature under Site Settings > Beta Features > Email Marketing will split the campaign editing experience for Partners into two tabs – “Developer Editor” and “Client Editor” – with the latter being the in-context editing experience your clients will see, if the editor will find editable regions inside the campaign content.

     

    ice-dev-overview-small.png

     

    To get you started, the campaign wizard also includes a sample email template that already has editable regions defined:

     

    ice-template-small.png

    Defining editable content

    In the "developer" state or  other HTML editors, Partner can mark elements from the campaign content to be Editable Regions by using a custom attribute on those elements:

    <div ice:editable="editable region type">
         SBO editable content here
    </div>

    The ice:editable attribute supports the following values corresponding to an ER type:

    • line - single line text; all formatting and break lines are ignored;
    • multiline - multi line text; break lines are allowed, all formatting is ignored;
    • image - change and resize image; image is server side resized using dimensions defined on the img tag
    • link - change link; can insert internal (site) or external links
    • html - html text; some formatting is allowed; partners can specify the formatting elements made available to business owners
    • module – allows partners to select which modules are editable; the business owners will access a simplified module manager user interface that will only allow them to change the cotent filters (tags, lists, etc) so that they can choose which content to display; in this release, all modules are editable by default once another editable region is found inside the page content;

     

    For the html value, you can list the editor options in the ice:options attribute, comma separated. Separators (for option groups) can be specified using the pipe character "|".

     

    For example:

    <div ice:editable="html" ice:options="bold,italic,deleted,|,link">

    The editor will only allow the following options:

    bold, italic, deleted, separator (|), fontcolor, link, unorderedlist, orderedlist, outdent, indent, alignment, alignleft, alignright, aligncenter, justify

    Editable regions can be applied on the following tags:

    • Line, Multiline editable region type can applied only on: p, h1, h2, h3, h4, h5, h6, pre, address, blockquote, div
    • Link editable region type can be applied only on: A tag
    • Image editable region type can be applied only on: IMG tag
    • HTML editable region type can be applied only on: generic section tag DIV, TD and TH
    • Module editable region type can be applied only on: Business Catalyst modules (ex: {module_faq ice:editable="module"})

    Restrictions using editable regions

    To assist partners provide a seamless editing experience in email campaigns and prevent users from breaking layouts, we restrict the html tags an editable regions can be applied as well as what HTML mark-up is allowed inside an editable region.

     

    Editable regions (of any kind) cannot be applied on any of the following self-closing tags:

    <link />
    <meta />
    <area />
    <br />
    <col />
    <hr />
    <input />
    <param />
    

    Also, editable regions cannot be applied on any of the following inline level tags:

    b, big, i, small, tt
    abbr, acronym, cite, code, dfn, em, kbd, strong, samp, var
    a, bdo, img, map, object, q, script, span, sub, sup
    button, input, label, select, textarea
    

    Additionally, editable regions cannot be applied on any FORM related elements:

    <form>
    <fieldset>
    <legend>
    <textarea>
    <select>
    

     

    Other restrictions

    • Editable regions canot be nested
    • Editable regions cannot be applied on elements containing Liquid mark-up. Liquid mark-up will be overwritten by its generated HTML if the mark-up is inside an editable region.

     

    The following tags are not allowed inside an editable region:

    iframe, script, map, area, object, embed, video, audio

    Using the in-context editor

    Once you have defined editable regions in your email templates, the customer will only see the in-context editor and  they’ll only manipulate the raw content itself, and hence are unable to break elements or the overall layout.

     

    Single line and multi line editors - will allow copywriters to change text without altering the text formatting:

     

    ice-sbo-singleline-small.png

     

    HTML editor - will allow copywriters to update campaign content while also applying some HTML formatting:

     

    ice-sbo-html-small.png

     

    Module editor - allows copywriters update module filters so that they can display different content:

     

    ice-edit-modules.png

     

    What's missing and known issues

    • The in-context editor will only be supported only inside the new admin user interface
    • Partners cannot choose which modules are editable; in this release, all modules inside a campaign are editable
    • Module preview inside the business owner editing experience does not refresh after updating module filters
    • Cannot create folders from the image browser
    • Cannot insert tags using the in-context editor

    Where to report issues

    Please use this thread to post your feedback or requests about this feature. We would like to have it as open discussion about what's currently in the release, and what is absolutely required to make it work for you.

     

    Note: Beta features are not officially supported and we do not offer a guaranteed response time. We usually respond within the next 48 to 72 hours, but this might vary depending on the team load and issue urgency.