Relayter Help

Appearance

Manage HTML Project Files ​

HTML project files are used in dynamic content templates to generate web-based output such as banners, emails, or interactive content. An HTML project is a ZIP file containing HTML, CSS, JavaScript, and image files that Relayter processes to identify dynamic content placeholders.

Upload an HTML project file ​

  1. Go to Templating → Dynamic content → HTML.
  2. Click Add an HTML project file.
  3. Enter a name for the project.
  4. Upload a ZIP file containing your HTML project.
  5. Relayter extracts and validates the project.
  6. Click Save.

Relayter will scan your ZIP file for all .html and .htm files and treat each as a potential entry point (called an "index file"). You can later select which entry point to use when creating templates.

Project file structure and requirements ​

Your HTML project must be packaged as a single ZIP file. Inside the ZIP:

  • Include one or more .html or .htm files as entry points
  • Mark dynamic content areas using the relayter:tag attribute
  • Include all supporting files (CSS, JavaScript, images)
  • Use relative paths for file references within the project
  • Ensure all dependencies are included in the ZIP

Marking dynamic content with relayter:tag ​

To mark an element for dynamic content injection, add a relayter:tag attribute with a unique identifier:

html
<h1 relayter:tag="title">Placeholder text</h1>
<img relayter:tag="hero" src="placeholder.png" />
<div relayter:tag="description">Description text</div>

Within each HTML file, all relayter:tag values must be unique. Duplicate tags in the same file will cause the upload to fail.

Supported content ​

Your HTML project can include:

  • HTML and CSS (any valid HTML5/CSS3)
  • JavaScript (any code supported by standard browsers)
  • Images, fonts, and other media files
  • External CSS and JavaScript files (referenced by relative paths)

Relayter does not restrict HTML, CSS, or JavaScript patterns. All standard web technologies are supported.

Use a project file in a template ​

  1. Open or create a dynamic content template.
  2. Set the Engine to HTML.
  3. In the Project file section, select the HTML project you want to use.
  4. Choose an Index file (one of the HTML files from your project).
  5. Save the template.

Update a project file ​

To update an HTML project with a new or modified ZIP file:

  1. Go to Templating → Dynamic content → HTML.
  2. Find the project and click the edit icon.
  3. Click Update an HTML project file.
  4. Upload a new ZIP file containing your updated project.
  5. Relayter re-extracts and re-validates the new files.
  6. Click Save.

When you upload a new ZIP file, Relayter replaces all project files and regenerates the list of index files by scanning the new ZIP. If the new ZIP has a different structure (different HTML files or different relayter:tag values), templates using this project may need adjustment.

Templates and rulesets that reference the old project will continue to work if the index file structure remains compatible. If you significantly change the HTML structure or rename entry point files, you may need to update templates that use this project.

Edit project metadata ​

To change only the project name:

  1. Go to Templating → Dynamic content → HTML.
  2. Find the project and click the edit icon.
  3. Update the name field without uploading a new ZIP file.
  4. Click Save.

This will update the name without reprocessing the HTML files.

Delete an HTML project ​

  1. Go to Templating → Dynamic content → HTML.
  2. Find the project and click the delete icon.
  3. Confirm the deletion.

You cannot delete a project that is currently in use by templates or rulesets. If you need to delete it, first remove all references to it from your templates and rulesets.