English
About this handbook

This handbook belongs to the Quartz plugin quartz-layout-box. And it is built with it: this box is a layout box.

It comes from a Markdown file, not from the configuration — which way is better when is in The snippet.

9.2 – Messages

Every message starts with [layout-box] and appears once per cause, not once per page. That is deliberate: with 300 pages and one missing file, 300 identical lines would be no help.

Refusing to read "…" outside of "…"

The path in file leads out of dir. The box outputs nothing.

Usually one .. too many, or a dir that is not what you thought it was. See 2.2.

Snippet file not found: /full/path/to/file

There is no file at that place. The message names the full path — comparing it with where the file actually is, is the fastest way to the cause.

Under --serve a dashed box appears on the page as well. In a normal build the spot stays empty.

Could not read snippet file (…)

The file is there but could not be read — permissions, a directory instead of a file, a broken symlink. What the operating system reported is in the brackets. Otherwise it behaves like the previous one: nothing in a normal build, a box under --serve.

`collapsible` requires a `title`; rendering non-collapsible

collapsible: true without a title. The box is rendered normally, only not collapsible. If the cause sits in a byLang entry, the message names it.

It is produced while the instance is built, so it only ever sees the configuration. When collapsible comes from a page’s frontmatter, the console stays silent and the box is quietly rendered non-collapsible.

No message, no box

There are two causes for that, and neither is a fault:

  • The snippet is empty. A box without content outputs nothing — deliberately, see 6.2.
  • The page has hidden the box in its frontmatter.

When nothing at all happens

If the box is absent and the console is silent too, usually the entry itself is not in effect: enabled: false, or the plugin is installed but not entered in quartz.config.yaml.

When the box sits somewhere else

An entry without a layout block still creates an instance. Quartz places any component that names no position at its manifest’s default — for this plugin left, with priority: 15 (3.2). Removing the layout block to switch a box off therefore puts it in the left column; enabled: false is what switches it off.