OurBigBook logoOurBigBook Docs OurBigBook logoOurBigBook.comSite Source code

Table (|| , | , \Table, \Tr, \Th and \Td)

The shorthand syntax marks:
  • headers with || (pipe, pipe space) at the start of a line
  • regular cells with | (pipe, space) at the start of a line
  • separates rows with double newline
For example:
|| Header 1
|| Header 2

| 1 1
| 1 2

| 2 1
| 2 2
which renders as:
Header 1Header 2
1 11 2
2 12 2
Empty cells are allowed without the trailing space however:
| 1 1
|
| 1 3

| 2 1
|
| 2 3
which renders as:
1 11 3
2 12 3
Equivalent fully explicit version:
\Table[
\Tr[
  \Th[Header 1]
  \Th[Header 2]
]
\Tr[
  \Td[1 1]
  \Td[1 2]
]
\Tr[
  \Td[2 1]
  \Td[2 2]
]
]
which renders as:
Header 1Header 2
1 11 2
2 12 2
Any white space indentation inside an explicit \Tr can make the code more readable, and is automatically removed from final output due to remove_whitespace_children which is set for \Table.
To pass further arguments to an implicit table such as title or id, you need to use an explicit table macro as in: Table 3. "My table title".
\Table
{title=My table title}
{id=table-my-table}
[
|| Header 1
|| Header 2

| 1 1
| 1 2

| 2 1
| 2 2
]
which renders as:
Table 3.
My table title
.
Header 1Header 2
1 11 2
2 12 2
We would like to remove that explicit toplevel requirement as per: github.com/ourbigbook/ourbigbook/issues/186 The rules of when the caption shows up or not similar to those of images as mentioned at Section "Image caption".
Multiple source lines, including paragraphs, can be added to a single cell with shorthand syntax by indenting the cell with exactly two spaces just as for lists, e.g.:
|| h1
|| h2
|| h3

  h3 2

| 11
| 12

  12 2
| 13

| 21
| 22
| 23
which renders as:
h1h2
h3
h3 2
11
12
12 2
13
212223
Arbitrarily complex nested constructs may be used, e.g. a table inside a list inside table:
| 00
| 01

  * l1
  * l2

    | 20
    | 21

    | 30
    | 31

| 10
| 11
which renders as:
00
01
  • l1
  • l2
    2021
    3031
1011
And now a table outside of \OurBigBookExample to test how it looks directly under the \Toplevel implicit macro:
Table 4.
My table title
.
Header 1Header 2
1 11 2
2 12 2
And a fully shorthand one:
Header 1Header 2
1 11 2
2 12 2
And now a larger one to see how the style is looking:
Header 1Header 2Header 3Header 4
1 11 21 31 4
2 12 22 32 4
3 13 23 33 4
4 14 24 34 4
5 15 25 35 4
6 16 26 36 4
7 17 27 37 4
8 18 28 38 4

Ancestors (3)

  1. Macro
  2. OurBigBook Markup
  3. Home

Incoming links (4)