Shojiku

日本語

English

日本語

English

Appearance

type: page_number ​

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

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

ソースを見る

Draws the current page number. Band-only (header/footer): the page count is known only at assembly, and bands are the per-page surface. In a body or container it warns (page_number_in_body / page_number_in_container) and is skipped.

Syntax ​

yaml
sections:
  footer:
    repeat: every_page
    items:
      - type: page_number
        # Bands share the margin-box origin (top-left) with the body —
        # there is no footer-local origin, so a footer needs a y near
        # the bottom: A4 + default margin 25 → margin box is 791.89pt
        # tall, and y: 780 leaves 12pt for the line.
        box: { x: 0, y: 780, w: "100%", h: 12 }
        format: "{page} / {pages}"      # the default
        style: { fontSize: 8, textAlign: center }

Keys ​

KeyTypeDefaultDescription
formatstring"{page} / {pages}"{page} = current page (1-based), {pages} = total. Other text passes through (- {page} -, p.{page}).
box / style / styleNamesUsual text forms (style.md).

Combine with the band's repeat mode (every_page / except_first_page / …) to control which pages show it.

Capability key: page_number.

Limitations ​

  • Bands only. In a body it warns (page_number_in_body) and in a container (page_number_in_container), and is skipped either way: the page count is known only at assembly.
  • The format string interpolates {page} and {pages} and nothing else. There is no numbering-style key (roman, kanji) and no per-section restart.

See also ​