Define a content type

entry template with link

Locomotive allows you to create content types without imposing a specific pre-built structure. No SQL knowledge is required here.

Your content types can then be used directly in your Liquid templates.

Generate it with Wagon


Before further reading, make sure you created a site with Wagon.

Wagon provides you the generate command to help you to create the YAML file describing your content type.

cd ~/workspace/my_first_site
wagon generate content_type events title:string description:text event_date:date

It will generate 2 files:

  • app/content_types/events.yml
  • data/events.yml

The first one contains the content_type declaration, the second contains sample data so that you can test your site with fake data. Some random data have been added.


Use plural for your content type names.

Examples: posts, articles, photos, success_stories, ...etc.


The available field types are

string, text, file, select, boolean, date, date_time, tags, integer, float, belongs_to, has_many, many_to_many.


Good practice

It is strongly advised to declare a string field type as the first entry even if it's not used.

Description of the YAML file

Here are the properties you can use on app/content_types/*.yml files. All the content types should be plural filenames.

Example of an Article content type:

name: Articles
description: Just a simple blog module
order_by: posted_at
order_direction: desc
slug: articles
label_field_name: title
- title:
    label: Title
    type: string
    hint: The title of the article
- posted_at:
    label: Posted at
    type: date
    hint: The date when the article has been or will be posted.
- body:
    label: Body
    type: text
    text_formatting: html
    hint: The body of the article
nameStringPublic name of the content type. Use plural.
slugStringSlug of the content type. Must be plural, lowercase and snake_case (any spaces replaced with underscores).
descriptionStringExplanation displayed in the backoffice.
label_field_nameStringField slug. Default field slug (generally title), it must be a string field. It is advised to not use relationship fields as it might cause issues with public entry submissions.
order_byStringChanges the order of content entries in Back Office.

Available values:
- 'manually'
- 'created_at'
- 'updated_at'
- the slug of any field
order_directionStringChanges the order direction.

Available values:
- 'asc'
- 'desc'
group_byStringGroups entries in tabs in the Back Office.

Available value:
- slug of any select field
tree_parent_field_nameStringSlug of the field used as to organize content entries as a tree (WIP)
public_submission_enabledBooleanActivates public 'create' API (e.g for a contact form)
public_submission_accountsArrayArray of email addresses to be notified of new entries made with the public API.

Note: Works only in the Engine, not with Wagon.
public_submission_title_templateStringSubject of the notification email sent when a new content entry has been created.
display_settingsHashControls the display of the following content type tabs in the Back Office.

Available values:
- seo: [Boolean]
- advanced: [Boolean]
- position: [Integer]
- hidden: [Boolean]
entry_templateStringBy default, the Back Office lists content entries using the _label property (see label_field_name) of the content entry. This can be modified by writing your own Liquid template.

Example: entry_template: 'Name: <strong><a href="{{ link }}">{{ entry._label }}</a></strong>'
filter_fieldsArray of slugsEnables a content entry search field in the Back Office.

This property accepts an array of field slugs that will be checked for matching with user inputs.

Example: filter_fields: [_slug, name]
fieldsHashList of fields whose structure is described below

Fields types

The minimal structure:

  type: <type>
  option: value

Common properties of fields

labelStringRequired. Label for the backoffice
requiredBooleandefault false
hintStringDisplays a hint in the backoffice.
localizedBooleanDefault false. Makes this field localized: each language will have a different value.
uniqueBooleanDefault false. Makes this field unique. Useful for email fields.
groupStringRearrange your model fields in groups/tabs in the back-office. Do not use spaces in the string. (Underscores will be rendered as spaces in the Back Office, e.g. my_group will be displayed as MY GROUP).

Depending on the field type, you can provide one or more options.

stringStandard string field
textLonger field.
Use with the text_formatting option:
- html: option to display a wysiwyg editor in the backoffice
- markdown
- raw
selectAdd select_options: ["value 1", "value 2"] or for multilingual:
select_options: en: ["Value 1", "Value 2"] fr: ["Valeur 1", "Valeur 2"]
fileNo option, get the url with product.the_photo.url in your code.
integerInteger field. No option.
floatFloat field. No option.
dateDate field. No option.
date_timeDateTime field. No option.
booleantrue or false field. No option.
tagsTags field. No option.
belongs_toDeclare a one-way relationship between two content types.

Example: product belongs to a category, field 'category' in products.yml: target: categories
has_manyDeclare a recursive relationship between two content types.

Example: category has many products (field 'products' in categories.yml):
target: products inverse_of: category ui_enabled: true
Notice the plurals and singulars.
many_to_manyDeclare a many-to-many relationship between two content types.

Example: products has and belongs to many categories. In products.yml:
target: products inverse_of: category ui_enabled: true

Protected Field Names

There are a number of protected words that cannot be used in content_type slugs or fields. They are:

  • id
  • _id
  • send
  • class
  • destroy
  • system