Markdown

Authors

Learn how to add authors to your e-mails

AI assisted, human approved — novem uses AI to review and keep our documentation up to date.

Available in: documents and e-mails.

{{ author                               # section type
  username: novem_demo
  include bio: true
  override bio: Novem Demo is the novem
                example account used to
                create illustrations of
                how the novem platform
                can be used.
  include picture: true
}}

Overview

The author section lets you include an author information block in your e-mail. This displays the author's name, profile picture and biography pulled from their novem profile. You can also override the biography text with a custom message.

Including authors

An author block is added by creating a {{ author }} section in the content file. The author section is a single statement section — it does not require a closing tag.

Restrictions

The author must have the allow_as_author permission set on their profile. In addition, the visualisation must be shared with the author before the author can be tagged. A public sharing is not sufficient — there must be a joint group membership.

Options

Options to the section are supplied as yaml within the double brackets.

Username

keyword: username
options: novem username

The novem username of the author to include. This is required.

Include Name

keyword: include name
options: true | false
default: true

Controls whether the author's profile name is displayed.

Include Biography

keyword: include bio
options: true | false
default: true

Controls whether the author's biography is displayed. If an override bio is supplied, this is automatically set to true.

Override Biography

keyword: override bio
options: "Custom biography text"

Replaces the author's profile biography with custom text. Supports simple markdown formatting.

Include Picture

keyword: include picture
options: true | false
default: true

Controls whether the author's profile picture is displayed.

Examples

Adding an author

{{ author
  username: novem_demo
}}

Writing a custom bio

{{ author
  username: novem_demo
  override bio: Senior analyst at Acme Corp with 10 years of
                experience in quantitative research.
  include picture: true
}}