Promotional banners

[rofe]

Some articles feature promotional HTML banners consisting of a background image, a title and text, an optional icon and a "call to action" button with label. There is a number of them that will be reused in different articles.

Example:

I discussed a potential implementation with @davidnuescheler and we thought it would be best to edit this data in Excel and use data embeds to render them. So the above would look like this in a spreadsheet format:

ID	Title	Lead	Text	CTA Text	CTA URL	Product Tag	Style
1234	Adobe Acrobat DC	Download a free trial of Acrobat Pro DC.	You can create, sign, and share PDFs faster and easier than ever — free for 7 days.	Get Started	https://adobe.ly/2ukSFQH	Acrobat DC	acrobat-dc-dark

The article would contain the URL to the spreadsheet incuding the ID of the banner to render. Helix would then apply a template and turn it into something like this:

<div class="banner acrobat-dc-dark">
  <imd src="/banners/1234/background-img.jpg">
  <div>
    <img src="/banners/1234/logo.png">
    <h2>Adobe Acrobat DC</h2>
  </div>
  <div>
    <h3>Download a free trial of Acrobat Pro DC.</h3>
    <span>You can create, sign, and share PDFs faster and easier than ever — free for 7 days.</span>
    <a href="https://adobe.ly/2ukSFQH" target="_blank" rel="noopener">Get Started</a>
  </div>
</div>

What we need:

• helix-data-embed needs to support an ID so it will only render a single row.
• Authors will need some way of selecting a banner and referencing it in their article. Maybe something similar to the tagger which renders preview images of the banners with QR codes, which they copy/paste into their doc
• helix-pipeline needs to turn the image with QR code into a data-embed

[trieloff]

What about this approach?

• we add a new folder banners
• the folder contains word documents that have
  • the icon as the first image
  • the title as a headline
  • the lead as the first paragraph (in bold)
  • the text as the second paragraph
  • the call to action as a link
  • the background image as the last image

The author then adds a relative link like this:

/banners/acrobat_free_trial.html

to the Markdown, which Pipeline will pick up as an internal embed, which will be included. We then use CSS and a bit of JS to render the banner.

Advantage:

• nothing new to build
• editing is more visual

Disadvantage:

• embedding is not as easy as QR codes
• bulk edits of links are harder

[rofe]

Would work for me as well. For ease of use, we could still provide a picker which has the QR-coded thumbnails.

@davidnuescheler wdyt?

[kptdobe]

For the record, here are some banner samples:

1. https://theblog.adobe.com/business-resilience-leading-through-change/
2. https://theblog.adobe.com/six-easy-steps-to-prepare-forms-like-a-boss/
3. https://theblog.adobe.com/make-experience-business/
4. https://theblog.adobe.com/adobe-scan-is-the-new-homework-lifehack/

[kptdobe]

This adobe/helix-pages#78 would be required to implement @trieloff's solution.

[kptdobe]

Also, if we embed the content in the page, how are we going to style it ? We should be able to define that this is a "banner" include that requires a "banner" style...

[trieloff]

@davidnuescheler has convinced me that the source data is more table-shaped than document-shaped, so the first approach would probably work better.

[kptdobe]

I would love to see an example of that because in the current state, I do not see of this can work ;)

1. How do you address the row id=1234 ?
2. Where do you define the "rendering template"? I do not think the goal is that the author defines each time how the banner should be rendered, i.e.

...
blablabla

---
/banners/1234
{{title}}
{{backgroundImage}}
({{buttonText}})[{{ctaUrl}}]
---

blablabla
...

As an author, I only want to do something like:

...
blablabla

/banners/1234

blablabla
...

[trieloff]

@davidnuescheler's approach depends on adobe/helix-data-embed#34 – @kptdobe you can look at the example there to see some ideas how the URL (and resulting markup) would look to the author.

In general, I think my approach favors the banner embedded, whereas @davidnuescheler's approach favors the banner author, especially when it comes to bulk editing.

I'm honestly not sure which way is better and the uncertainties about adobe/helix-data-embed#34 don't help either.

[rofe]

Fwiw, I don't know if bulk editing is really a thing for these promotions, @avanishgandhi can you find out? It might well be that these are created as one-offs, referenced on a few articles for a period of time, and then left alone without ever being edited again.

[trieloff]

Btw – just to throw another idea against the wall: These banners look like it would be really easy to author them using Adobe Spark Post. We do have an existing integration between helix-embed and Adobe Spark that we could use.

The only limitation that I see is that the entire banner would be the link target.

[kptdobe]

They are already able to do these "banners as an image": https://theblog.adobe.com/business-resilience-leading-through-change/
At the end of the page, they are 2 "banners": one is an html version, the other is an image that they built somewhere else, similar to your Adobe Spark Post proposal.

[rofe]

At the end of the page, they are 2 "banners"

I only see the html COVID-19 banner on this page... maybe I'm looking in the wrong place?

[rofe]

The only limitation that I see is that the entire banner would be the link target.

I don't think that would be a problem. I even think it would be better from a usability perspective 😄.

[kptdobe]

You do not see the "Summit is now online" banner-like-image right after the COVID-19 one ?!

[rofe]

Nope:

[kptdobe]

Fascinating:

Secret feature ?

[trieloff]

Another limitation with Spark: the link target needs to be specified somewhere. Maybe a staggered approach would work:

1. blog post embeds banner document
2. banner document embeds spark post and adds link (below)
3. JS combines image and link into one

[rofe]

Secret feature ?

Apparently I'm not in any targeted segment 😂

[rofe]

2. banner document embeds spark post and adds link (below)

I'm starting to think that Spark Post would be solving for the wrong a different problem: banner creation, which we excluded from the scope so far, instead of banner management (doc or spreadsheet) and referencing (embed).

[kptdobe]

Apparently I'm not in any targeted segment 😂

Scary. For me, it is part of the html response. So either they hide it client side for you... or the page is not cached at all!

[kptdobe]

While we are debating ;), I have made a test with what we already have + 2 minor fixes:

• fix(rendering): inject class from meta helix-pages#263
• feat(rendering): support for internal embeds helix-pages#257

For the 4 identified banners, I created one md file with the required content to represent each of them following the same pattern (a lot of differences between the various banners). See the promotions folder: https://adobe.sharepoint.com/sites/TheBlog/Shared%20Documents/Forms/AllItems.aspx?RootFolder=%2Fsites%2FTheBlog%2FShared%20Documents%2Ftheblog%2Fen%2Fpromotions&FolderCTID=0x012000291CC2F215041D41ADE01F0A04AB94F2

As an author, to get the banner, I simply add (markdown):

../promotions/covid-19-response.md

or

../promotions/covid-19-response.html

or

/en/promotions/covid-19-response.html

And the banner is injected in the DOM as:

<div class="default" style="opacity: 1; transform: translateY(0px);">
  <div class="default product-banner">
    <h1 id=""></h1>
    <p>As the situation with COVID-19 unfolds, Adobe is committed to giving you the support and resources to navigate this challenging time.</p>
    <p><a href="https://www.adobe.com/covid-19-response.html">Learn More</a></p>
    <h2 id="covid-19-response">COVID-19 Response</h2>
  </div>
</div>

Final step would be to "reorganise + style" this piece of DOM clientside like we do everywhere else.

While this does the job, the limited correspondances between the banners (text overlay in one case, text in the image in another, one has no title...) make the approach hard to generalise and would require the author to know exactly what are the options. This applies probably less for the spreadsheet approach but the grid would be pretty randomly empty and reveal the un-structured nature of those banners.
For the spreadsheet approach, we still need a place where to define "this is a product-banner" which I solved via the "class" in the frontmatter. Interestingly, this is our eternal issue that we solve with "components": I have the data, I have a way to include, just missing the piece in the middle that define how to render it.

[kptdobe]

Here are some first migrated examples with banners:

• https://promotion-banners--theblog--adobe.hlx.page/en/drafts/migrated/2020/05/05/stronger-together-supporting-indias-communities-amidst-covid-19.html
• https://promotion-banners--theblog--adobe.hlx.page/en/drafts/migrated/2018/07/26/forward-thinking-brands-re-engineer-hiring-for-the-future.html
• https://promotion-banners--theblog--adobe.hlx.page/en/drafts/migrated/2018/02/15/creative-refresher-capture-transforms-world-design-assets.html
• https://promotion-banners--theblog--adobe.hlx.page/en/drafts/migrated/2017/11/20/make-experience-business.html

With adobe/helix-theblog-importer#20, new banners are automatically created under /en/promotions and corresponding DOM is replaced by an internal embed.

Initial styling is here: #187

[rofe]

Found a broken Adobe Sign banner here: https://promotion-banners--theblog--adobe.hlx.page/en/drafts/migrated/2020/04/27/the-state-of-utah-uses-adobe-sign-to-accelerate-telework-during-crisis.html

[kptdobe]

First implementation with:

• imported banners under /en/promotions/<bannername>.md
• new banners can come as /en/promotions/<bannername>.docx
• banners should follow pattern:

---
class: banner
---

Title (Heading 1 - optional)

Background image (optional, black background otherwise)

Description (paragraph)

<cta link>cta button text</cta link>
  
Product icon (optional)

Notes:

• almost everything is optional except the cta link
• if no background image, black background is used
• class: banner frontmatter is mandatory (required for styling)

[kptdobe]

Found a broken Adobe Sign banner here: https://theblog--adobe.hlx.page/en/drafts/migrated/2020/04/27/the-state-of-utah-uses-adobe-sign-to-accelerate-telework-during-crisis.html

For now, only the few blog entries I manually imported are up-to-date.
I imported this specific posts to test and it renders as expected. But not super nicely. I'll create a follow up ticket to review the banner styling when the new design is implemented.

[kptdobe]

I am planning a full re-import (beginning of next week) of all the blog posts as soon as the embeds are stable and theblog.adobe.com cache has been flushed. This will re-import all banners in all blog posts and convert them properly as embeds.