6.1 – Hiding and swapping

Every instance listens to one frontmatter field. What it is called is set by frontmatterKey; without one it is layoutBox.

The four forms

Hide it:

---
layoutBox: false
---

A different snippet:

---
layoutBox: imprint.html
---

The name is relative to dir, exactly as in the configuration.

Several things at once:

---
layoutBox:
  file: imprint.html
  title: About this page
  collapsed: true
---

Different markup for this page only:

---
layoutBox:
  html: "<p>This page is a draft.</p>"
---

Written as an object, hidden, file, html, title, collapsible and collapsed are allowed. dir and frontmatterKey are not — one is an installation path, the other the name the page is speaking under right now.

The order of precedence

From strong to weak:

1. the page’s frontmatter
2. byLang for the page’s language (chapter 7)
3. the base options from the configuration

Each level overrides only what it names itself. A frontmatter with title: leaves file: from the configuration untouched.

html against file does not follow the precedence

The source is not decided per level but once for all of them: if there is an html anywhere — in the frontmatter, under byLang or in the base options — it is taken, and file is never looked at. So a layoutBox: imprint.html in the frontmatter does nothing when the configuration uses html:, and a byLang.en.file does nothing when the base options have html:. Without a message. Measured; and it is exactly what the empty-file trick in 6.2 rests on.

An example that comes up often

A site has a donation box after the body — on the imprint page it feels wrong:

---
title: Imprint
layoutBoxDonate: false
---