Candy Database · Documentation

Header and footer A database can show a header above all its pages, and a footer below them: a logo, the name and version, a few links, a copyright notice. Each is a page of its own. Write it in BBCode, in a file named _header.txt or _footer.txt, and place it:
  • in the database folder, to show it on every page of every version and language, or
  • in a version folder, to give that version its own. This one wins over the database's, or
  • in a language folder, to give that language its own. This one wins over the version's.
The header and the footer are found separately: a version can have its own header and share the database's footer. To use other names, set header and footer in database.json. Examples A header, in _header.txt:
[center][img height=80]_images/logo.png[/img][/center] [center][b]My Add-on[/b] · documentation[/center] [hr]
A footer, in _footer.txt:
[hr] [center]© 2026 My Studio · [url=page:Getting_Started/Installing]Installing[/url][/center]
How they behave
  • The header scrolls up with the page, unless the database sets header_scrolls to "0" in database.json: then it stays fixed above the page.
  • The footer follows the end of the text and scrolls with it. When the text is shorter than the page, the footer is displayed at the bottom of the page. If the database sets footer_scrolls to "0", the footer stays fixed below the page instead.
  • Both have the same text width as the page, centered. Their backgrounds (a color or an image) span the full width. See Settings and Style keys for the backgrounds.
  • Their height follows their content.
  • Readers can hide them in View > Show Page Header and View > Show Page Footer.