Blurbs

Blurbs are small, reusable packets of static and/or dynamic content which are incorporated into Pages and System Pages.

Overview

When creating new Pages for a Learndot instance, content can either be directly written onto the page, or inserted by means of a new blurb created as a placeholder for the content. While using blurbs is not necessary, it does provide some advantages, including:

  1. The content can easily be reused on another page if desired.
  2. The page structure is more modular, making it simpler to read and therefore maintain; having blurb placeholders instead of long blocks of code for complex dynamic content makes restructuring the page and adding/modifying select pieces of content far simpler.
  3. The content is simple to edit even for staff users inexperienced with Learndot Enterprise, as they can simply click on the edit button when mousing over the top-right of the blurb on the site frontend.

Predefined Blurbs

Your Learndot instance will ship with a number of blurbs which can be used to customize the content on the site, including on many of the System Pages which cannot be read or modified through the Pages function like Standard Pages.

Static and Dynamic Content

As stated previously, blurbs can contain both static and dynamic content.

Static content is displayed as it is typed - it does not change depending on the page, and can include things such as an informational block of text, or a generic thank-you message at the end of a course sign-up process.

Dynamic content is generated on-the-fly each time the blurb is loaded to reflect the current state of data, and is useful for things such as lists of upcoming classes, or addressing a customer personally on a page. Dynamic content in Learndot Enterprise uses the FreeMarker templating engine.

Using Blurbs

Creating a new blurb

  • Login as an Administrator
  • Navigate to System > Contents > Blurbs
  • Click New

  • When creating a new blurb, users will be able to set the following attributes:
FieldsDescription

Name

The name of the blurb. This is the primary key field; changing the name will break any references to the blurb on pages.

Enabled

Whether the blurb is active and can be used in pages or not.

Body

The contents of the blurb.

Dynamic

If set to yes, marks the blurb for pre-processing using FreeMarker.

Notes

This field can be used to record any additional information about the blurb, and can only be viewed by staff members.

  • Fill up the form 
  • Click Save

Existing Blurb

Here is an example of an existing Blurb:

Including a blurb on a page

Blurbs can be included on pages or in other blurbs using the following syntax:

<@s.blurb name="<blurbName>"/>

Pro Tip

Logged in Staff Users can identify the blurb responsible for a block of content by hovering the mouse over the top right corner of the content section. If the content is a blurb, a small edit icon will appear.

The highlighting of blurbs with the edit icon, can be toggled with Highlight Blurbs button located on the top right corner of the site.