Building an embed creates the interface for your readers to interact with your guide.

You can create multiple embeds in a single election to keep them organized, but you can use races from other elections (your organization’s or ones shared with you from other organizations).

You can use your embed on more than one page, or even more than one website, but be aware that changes to an existing embed will be shown everywhere that embed is used.

If you want to to make a variation on an embed while leaving existing ones unchanged, always create a new embed.

Create an embed

Navigate to an election and click the “New” button under “Embeds” in the sidebar.

You have the option of starting with races prepopulated, or building your embed completely from scratch.

Preview your embed

As you build and edit your embed, you can preview your changes by clicking the preview button in the top right menu.

Embed settings

Title

This doesn’t show up to your readers, it’s just a way for you to keep track of your various embeds.

Domains

Your embed won’t load on any websites you don’t specify here. If you’re collaborating with a partner newsroom on a guide, for example, you’d add their web domain here.

URL Mode

There two options here. You’ll likely just want to stick with the default option, hash-based URLs, but if your CMS is having trouble with the embed you might try the Query String option. Still running into trouble? Reach out.

Embed content

The content tab is where you can arrange your embed.

Races

These are the races you’ve populated with candidates and responses. Click on the settings gear icon to edit

You can edit a race’s title (how it appears to your readers), it’s url slug (this race’s path in the browser) and whether or not it’s a default section (and shows up first to your readers). This is also where you can delete a race from your list.

Section order

You can rearrange in what order your race sections appear by grabbing the dotted bar next to a race.

Filtering a race by group

To have your embed only show specific groups (for example, limited to districts relevant to a particular region), click “Filter to groups” next to the race .

Adding text block to race sections

A text block is a section of formatted text, often used for an explanation of the guide or a particular race. You can add a text block to a race inside of the race’s settings.

You can add content blocks outside of a race by clicking “Add blank section” at the bottom of your list of race sections.

Get the embed code

The embed code is available. when you click the “View Code” button at the to right ofo. the embed screen for every saved embed (for new embeds, you must save before it shows up).

Copy that code into your web site as raw HTML or script (often a similar process to how you would embed something from social media or charting/visualization tools). The embed code does not change when you make changes to the embed code settings or races – once the embed is created, the code stays the same and changes are automatically reflected on your site.

Important: Remember, any races included in your embed must be published before they will appear on your site (by default races inherit their election’s status and are published when it is published, although they can override that setting to remain as a draft even when the election is published).

It can take up to five minutes for changes in ElectUp to be reflected in embeds on your site.