Shojiku

日本語

English

日本語

English

Appearance

type: page_break ​

このページはまだ日本語になっていません。本文は英語のままですが、内容は同じものです。

このページの本文は docs/engine/page_break.md.生成されているのは the sidebar and the demo below.

ソースを見る

An explicit page break: the next flow item starts on a fresh page. A bare item — no box, no style; just the type, an optional id, and visible: to make the break conditional.

Syntax ​

yaml
- { type: text, text: "1ページ目" }
- { type: page_break }
- { type: text, text: "2ページ目" }

Behavior ​

  • Flow-only: bands, absolute bodies, and containers/cells warn (page_break_in_band / page_break_in_absolute_body / page_break_in_container) and skip.
  • A break at the top of an untouched page is a no-op, so consecutive breaks collapse and blank pages are never generated (CSS forced-break collapsing).
  • Conditional: visible: decides whether the break happens. A break paints nothing and reserves no box, so collapse makes no difference to it — a predicate that does not hold simply means no break.
    yaml
    - type: page_break
  visible: { key: order.long_form }
  • The 500-page cap applies as usual.

Capability key: page_break.

Limitations ​

  • Flow bodies only. In a band, an absolute body or a container it is skipped (page_break_in_band, page_break_in_absolute_body, page_break_in_container).
  • No break-before/after on OTHER items: a break is its own item in the flow, not a property of its neighbours.
  • It cannot force a blank page — a break with nothing after it produces no page.

See also ​