Authors

Available in: documents and e-mails.

{{ author
  username: novem_demo
  include bio: true
  override bio: Public examples and datasets for novem documentation.
  include picture: true
}}

Overview

The author block displays a name, profile picture, and biography from a novem profile. You can override the name and biography, or supply a text byline without a username.

Including authors

An author block is added with {{ author }} in the document or e-mail content. It is a leaf block and takes no 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 are written inside the double braces, inline or as YAML on several lines.

Username

keyword: username
options: novem username

The novem username whose profile supplies the byline.

Display name

keyword: name
options: "Display name"

Override the displayed name. An author can also be a text byline without a username; a username resolves profile information.

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: Author of the public Novem Example Index dataset.
  include picture: true
}}