Page header

8TML > Reference

Every page starts with a header block:

---
8tml: 1
title: V8rms - news
style: news.8ss
case: mixed
platform: c64
---

Rules

  • The first line of the file is exactly ---. The header ends at the next --- line.
  • Each line is key: value. Spaces around the value are trimmed.
  • Lines starting with # are comments.
  • Unknown keys are ignored.
  • 8tml must be the first key.

A file is an 8TML page exactly when its first line is --- and the first key in that block is 8tml. Anything else, including a --- block that starts with another key, is shown as plain text: no markup, no links, just the text. That keeps error pages and .txt files readable.

Keys

Key Value
8tml The format version: 1. Required.
title The page title, shown by the client (title bar, history, bookmarks).
style Address of the page’s own stylesheet, relative to the page.
case upper (default) or mixed.
platform The machine the page was made for (c64, zx, …).
any stylesheet key Overrides that key for this page.

8tml

The version of the format. For 8TML 1 the value is 1. It proves that the response really is an 8TML page.

title

A short name for the page. Clients show it where they have room for it, and use it in the history and for bookmarks.

style

The page’s own stylesheet, for example style: news.8ss. It overrides single keys of the site’s /site.8ss. See Where styles come from.

case

With upper, the default, letters are shown in uppercase. With mixed, clients that have lowercase show both cases. The page file keeps its case either way, and the setting also applies to preformatted text.

---
8tml: 1
---
Shown in uppercase: the default.

Preview: Commodore 64, 40 columns

                                            
SHOWN IN UPPERCASE: THE DEFAULT.
---
8tml: 1
case: mixed
---
Shown in Mixed Case.

Preview: Commodore 64, 40 columns

                                            
Shown in Mixed Case.

platform

The machine the page was designed for: c64, zx, and so on (the names are listed under Machine prefixes). It is only a hint: a client may tell the reader that the page was made for another machine, and still shows it.

Stylesheet keys

Any stylesheet key can also be set in the header and then wins over every stylesheet, for this page only:

---
8tml: 1
case: mixed
bg: blue
border: lightblue
h1: yellow
---
# A blue page

Only this page is blue.

Preview: Commodore 64, 40 columns

                                            
A blue page

Only this page is blue.