Skip to main content
Cartegraph Campus

Cartegraph Engage: Guide Building Blocks

Overview

Building blocks are used to add content to guides. Building blocks have controls for easily adding and formatting text, buttons, images, polls, and embedded videos. Text and button building blocks can be styled in advance using Theme.

Building Block Types

Add a Building Block

  1. Open a guide in the Visual Design Studio and view a guide step.
  2. Click the +Click to Add Content button if you have a blank step.

If you already have content on the step, do the following:

  • Add a new row by hovering above or below an existing building block.
  • Ad a new column by hovering to the left or right of a text, button, or image building block.hover-add-bb-blank.gif
  1. Select the type of building block from the menu.

Adopt_BuldingBlocks.png

  1. Click into an existing building block to open the Edit menu and make any changes.
    BBClicktoEdit.png

Row and Block Formatting

Building blocks can be added to guides vertically by adding new rows or horizontally by adding new columns. Several formatting options are available to position and edit building blocks in the guide step.

Row Formatting

RowEditBB.png

BBEditRow.png Edit Row opens the Edit Row menu, which has settings for background color, padding, margin, and alignment. Alignment positions content laterally across the row or vertically relative to content in the same row.

BBEditRowMenu.png

BBDuplicate.png Duplicate clones the entire row and creates a new adjacent row with the same content. This is helpful for cloning the style settings used in a building block even when you're making changes to the content inside the block.

BBRowPosition.png Row positioning moves the entire row up or down, swapping it with the content that's currently there. You can easily adjust the order of building blocks and test different layouts to find the design you like the best.

Block Formatting

ColumnEditBB.png

EditRow.png Edit Building Block opens the Edit menu for that building block, where you can edit the content and style settings. In most cases, you can access this menu directly by clicking on the building block but some building blocks, like videos, may play content or have other native behavior instead of opening the edit menu when clicked.

BBDuplicate.png Duplicate in the same row is available for text, button, and image building blocks when the row capacity hasn't been reached yet. This will clone the selected content in the same row, just like adding a column with that building block type.

BBDelete.png Delete permanently removes that building block. Be careful when you delete a building block. There is no warning modal and there isn't an undo button.

BBColumnPosition.png Column positioning moves the building block left or right, swapping it with the content next to it, in the same row. If the building block can't be moved, the arrow is grayed out and isn't clickable. Column positioning is only available for text, button, and image blocks.

Text

Text blocks support limited markdown with additional styling options for the text and container. The Text Block loads with filler text, demonstrating the supported markdown. Any styling options applied in the Styling menu apply to the entire text block. Create another text block to apply different styling to different text elements, like a title and paragraph.

Two columns of text can be placed next to each other by clicking Add Column in the same row and selecting another text building block. A button or an image can also be placed next to a text building block. When a text building block is next to another building block, the width of the individual building block can be set, otherwise, the default width is the width of the container.

Style within your text using the WYSIWYG controls or markdown. When you choose a styling option, the markdown syntax is applied to the text and the style is rendered in the preview. Take a look at the Markdown Syntax article to learn more about the supported markdown styles.

Supported Markdown

  • **bold**
  • *italics* or _italics_
  • ++underline++
  • --strikethrough--
  • [links]
  • Ordered (numbered) lists
  • -Unordered Lists
  • *Unordered Lists
  • +Unordered Lists
  • {color: #ec2059}Individual colored text{/color}

edit-text-theme-styles.gif

If you choose the custom options, you will see additional styling and spacing options to apply to the entire text block:

edit-text-styles.gif

Button

ButtonBB.png

The Button building block adds a single button that can trigger button actions, like next step or dismiss guide, to your guide. Add additional buttons next to any text, button, or image building blocks. A row can support up to four buttons or one button next to a text or image building block.

Select the style, button text, and actions for each button individually.

EditButton.png

Button Style

Buttons can use primary, secondary, or tertiary styles to quickly pull in designs from the guide Theme or a custom style.

ButtonStyling.png

Styles contain all of the available design options for the button. When you're using a theme, the only option is margin.

Custom Style Settings

  • Text
  • Background
  • Border
  • Width
  • Margin
  • Padding
  • Hover styles for text, background, and border

Button Text

The General section contains the button text field. Any text entered will appear in the button. If the button width is set to Auto, the button will get wider until it reaches the width of the guide container. If the button container is set to fixed, the text will break and form a new line and the button will get taller. Keep button text short and direct for the best results.

Actions

Guide buttons actions set what happens when a user clicks the button. There are many available actions for the most popular use cases.

Available Button Actions

  • Dismiss Guide
  • Next Step
  • Submit All Polls + Advance Guide
  • URL Link
  • Launch Guide
  • Previous Step
  • Snooze Guide
  • Go to Step

Some button actions can be paired together to make a compound action when the button is clicked. For example, Dismiss Guide and URL link can be paired together to end the guide and take the user to the new page.

Image

ImageBB.png

Image building blocks are used to add pictures and GIFs to your guide. Images can be uploaded and hosted by Cartegraph Engage or you can add a URL for your own hosted content. We recommend file sizes under 5 MB for fast loading times and the best guide performance. The maximum size limit is 30 MB.

Images can be used to add eye-catching headers, product screenshots, icons next to text, or GIFs showing a new workflow. Using Add Column, two images, an image and text, or an image and a button can be placed next to each other in the same row.

AddImageBB.png

Supported File Types

  • .jpeg
  • .png
  • .svg
  • .gif

Image Styling

EditImageBB.png

After uploading an image, additional options appear.

  • Image Alt Text: Displayed on the screen when the image fails to load and read by screen readers
  • Fill: Sets image size as a percentage relative to the guide container size or actual image resolution
  • Margin: Sets the margin around the outside of the image

Open Text Poll

open-text-poll-block.png

When you choose the open text poll option, you will be prompted to edit your question:

open-text-poll-block.png

Once you're happy with your question, click Apply. If you want to adjust the size of your open text field, hover over the field and choose the edit icon:

open-text-field-edit-options.gif

Multi-Choice Poll

Use this block to add your own multiple-choice options. Once you select the building block, you can add your question:

multi-choice-block-question.png

Then, hover over the multiple-choice drop-down menu to edit and add all the choices you want to give your user:

multi-choice-block-options.png

Video

Video building blocks embed videos from supported streaming platforms using only the video URL. Embed code isn't needed. The embed formatting is applied automatically. Autoplay is turned off automatically to provide the best guide experience.

Supported Video Platforms

  • YouTube
  • Vimeo
  • Wistia
  • Brightcove
  • Microsoft 365 Stream
  • Vidyard
  1. Select the Video building block.
    Adopt_bb_video_new.png
  2. Select Video Provider and enter the video URL and title.
    BBEditVideo.png
  3. The video thumbnail displays automatically in the Guide step. The default width is set to 100% of the guide container. Toggle Fill Container off to set the width manually.
    BBVideoPreview.png

Video streaming providers typically support all browsers except Internet Explorer. Check the browser compatibility of your video platform and that of your users for the best results.

Supported Video URL Formats

YouTube

Either of the formats provided by YouTube in the address bar or with the share button can be used.

  • http(s)://www.youtube.com/watch?v=[Video ID]
  • http(s)://youtu.be/[Video ID]

Vimeo

The URL provided in the address or with the share button can be used.

  • http(s)://vimeo.com/[Video ID]

Wistia

The formats provided in the address bar or from the Embed & Share link can be used.

  • http(s)://[Your Account ID].wistia.com/medias/[Video ID]
  • http(s)://[Your Account ID].wistia.com/embed/[Video ID]
  • http(s)://[Your Account ID].wi.st/medias/[Video ID]
  • http(s)://[Your Account ID].wi.st/embed/[Video ID]

Brightcove

Brightcove URLs must match this format. Shortened video links will not work.

  • http(s)://brightcove.net/account_id/player_type/index.html?videoId=[Video ID]

Microsoft 365 Stream

  • http(s)://[Your Account ID].microsoftstream.com/video/[Video ID]

Vidyard

  • http(s)://embed.vidyard.com/[Video ID]
  • http(s)://play.vidyard.com/[Video ID]
  • http(s)://share.vidyard.com/[Video ID]
  • http(s)://[Your AccountID].hubs.vidyard.com/[Video ID]

Frequently Asked Question

How can I add a column or add a building block to another building block?

Not all building block types can be placed next to each other. Only text, button, and image building blocks support side-by-side placement. There are limits to how many building blocks can be placed in a single row. A row can have up to four buttons or two building blocks consisting of any combination of text, button, and image building blocks. For example, two text blocks can be placed next to each other, or a button and a text block can be next to each other.

Existing button or multi-button building blocks will work with the new side-by-side functionality. But only new text and image building blocks support side-by-side placement. Text and image building blocks created prior to the release of side-by-side building blocks on May 26, 2021, will not support Add Column. Duplicating the building block will clone the legacy functionality without side-by-side placement. You must add a new text or image building block in a new row to use side-by-side placement. You can copy and paste the content from the old building block into the new building block and then delete the old building block to use the new functionality with your existing content.