Keyboard

↓ ↑
move between the rows you can see
→
open a feature, then step into it
←
close a feature, or step out to the one above
Enter
go to the page in focus
Tab
the same rows, plus everything else on the page
/
search the whole report
m
open or close the navigation drawer
Esc
leave the search box, or close the drawer
?
this list

Writes the declared front matter above a text page

All 6 scenarios hold

A site generator reads an AsciiDoc or Markdown page. The generator decides how that page looks and where it sits in the site. Front matter is what a project tells the generator. Declare it once, in the frontMatter section of the tabletest-reporter.yaml sidecar. The reporter then writes it above every page of a text report. An HTML page carries none, because it is a finished page and not source for a generator.

Both rules below read a report of two test classes in one package, com.example.orders.OrderTest and com.example.orders.ProductTest, with one table each.

Each format takes the shape its own tooling reads. Markdown fences a YAML block. AsciiDoc writes document attributes. The keys hold the order you declared them in, so a reader meets the block as you wrote it.

Markdown fences YAML, so the reporter writes a value as it stands only where YAML reads that value back as the same text. It adds the quotes where YAML would not: around a value holding a colon, and around one a reader takes for a number or a boolean. An AsciiDoc attribute is not YAML and takes every value as it stands.

expected outcome broken scenario
ScenarioFormatDeclaredPage opens with?
A section of literal keysmarkdown
  • layout: report
  • type: docs
  • ---
  • layout: report
  • type: docs
  • ---
  • # orders
A section of literal keysasciidoc
  • layout: report
  • type: docs
  • :layout: report
  • :type: docs
  • = ++orders++
Values YAML would misreadmarkdown
  • version: '2.0'
  • draft: 'no'
  • note: 'a: b'
  • ---
  • version: "2.0"
  • draft: "no"
  • note: "a: b"
  • ---
  • # orders
Values YAML would misreadasciidoc
  • version: '2.0'
  • draft: 'no'
  • note: 'a: b'
  • :version: 2.0
  • :draft: no
  • :note: a: b
  • = ++orders++
No front matter declaredmarkdown
  • # orders
No front matter declaredasciidoc
  • = ++orders++