Content modelling

Create the type fileCopy Anchor Link

Either write the file by hand or let the engine scaffold it with a template:

engine-dmo new type walk

new type writes config/schema/walk.yaml with a title, a slug and a summary (ids included), and templates/_shared/walk/entry.html. It reads the project’s configuration first, so every ${VAR} in engine.yaml without a default must be set, even with no database: DATABASE_URL=postgres://unused engine-dmo new type walk is enough when only DATABASE_URL is missing. engine-dmo dev type add walk writes the same type file without that requirement, but no template. Edit the type file so it reads:

# config/schema/walk.yaml
key: walk
label: Walk
plural: Walks
ordering: { field: title, direction: asc }

fields:
  - { name: title, type: text, required: true, index: true }
  - { name: slug, type: slug, source: title, required: true }
  - { name: summary, type: text, multiline: true, max: 280, required: true }
  - name: difficulty
    type: select
    required: true
    index: true
    options:
      - { value: easy, label: { en: Easy } }
      - { value: moderate, label: { en: Moderate } }
      - { value: hard, label: { en: Hard } }
  - { name: distanceKm, type: number, min: 0.1, max: 200, unit: km, index: true }
  - { name: startPoint, type: geo, required: true }
  - { name: heroImage, type: asset }
  - name: stages
    type: repeater
    min: 1
    item_label: "{{ title }}"
    fields:
      - { name: title, type: text, required: true }
      - { name: directions, type: portable_text, styles: [normal], lists: [bullet], marks: [strong, em] }
  - { name: isAccessible, type: boolean, index: true }
  - { name: accessibility, type: portable_text, styles: [normal], marks: [strong, em, link] }

validation:
  - rule: "isAccessible == false or accessibility != empty"
    message: Describe the surfaces and gradients before marking the walk accessible.
    fields: [accessibility]

Give it an addressCopy Anchor Link

A type has pages only where a site routes it. Add a route to the site’s routes.yaml:

# config/sites/main/routes.yaml
routes:
  - { type: walk, uri: "/walks/{slug}" }

See Sites, locales and routes for every route option.

Write the idsCopy Anchor Link

Every type, field, block, select option and group carries a stable id. You never write one by hand: check --fix writes an id for every element that has none, keeping your comments and layout, then checks the project.

engine-dmo check --fix

After it runs, each element in the file has an id: such as typ_vydpz07cy9 or fld_0c6c697g4f. Commit them with the file. An element without an id is an error (field "stages" has no id), so a project never reaches the database half identified. Ids are what let you rename a field later without losing its values: see Schema changes.

Write the templateCopy Anchor Link

templates/_shared/walk/entry.html renders one walk. Each field is a property of entry:

{% extends "base.html" %}
{% block body %}
<article>
  <h1>{{ entry.title }}</h1>
  {% if entry.heroImage %}{{ entry.heroImage.figure("hero", priority=true) }}{% endif %}
  <p>{{ entry.summary }}</p>
  <dl>
    <dt>Difficulty</dt><dd>{{ entry.difficulty.label }}</dd>
    {% if entry.distanceKm %}<dt>Distance</dt><dd>{{ entry.distanceKm }} km</dd>{% endif %}
  </dl>
  <ol>
    {% for stage in entry.stages %}
    <li>
      <h2>{{ stage.title }}</h2>
      {{ stage.directions|ptext }}
    </li>
    {% endfor %}
  </ol>
  {% if entry.isAccessible %}<section><h2>Accessibility</h2>{{ entry.accessibility|ptext }}</section>{% endif %}
</article>
{% endblock %}

hero is a transform declared in config/images.yaml (Images). engine-dmo check type-checks the template against the schema, so {{ entry.difficultee }} fails with entry has no field "difficultee" in this project's schema and a suggestion.

Check, plan and applyCopy Anchor Link

engine-dmo check
engine-dmo schema plan
engine-dmo schema apply

check validates the configuration and templates and needs no database with --no-db. Read every line it prints: its closing summary (0 errors, 0 warnings) counts configuration problems only, so a template warning printed above it, such as the starter layout’s this head has no head(), is not in the count and does not change the exit code. schema plan prints what will change in the database (+ type walk, + field walk.title, and so on) and exits with code 2 while changes are pending. schema apply applies them in one transaction. Both need a reachable database in DATABASE_URL; Schema changes says what apply does with each kind of change. Under engine-dmo dev up, the development server does the check, plan and safe apply on every save.

Add contentCopy Anchor Link

Editors now see Walks in the admin. To create content from the command line or a seed set, see Seeding and importing.