ravenous_typst/setup/mod_tables.typ

578 lines
13 KiB
Plaintext

// =============================================================================
// DEPRECATED
// =============================================================================
// =============================================================================
// TABLE SYSTEM
// =============================================================================
//
// Generic, theme-aware table helpers.
//
// Every helper accepts an optional `theme` argument.
// When omitted, the project's global `theme` is used.
//
// This means the same table can be rendered with:
//
// #styled-table(...)
// #styled-table(..., theme: theme)
// #styled-table(..., theme: other-theme)
//
// without defining separate table styles.
//
// =============================================================================
#import "variables.typ": theme, theme-var
// =============================================================================
// DEFAULT TABLE CONFIGURATION
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Table geometry
// -----------------------------------------------------------------------------
//
// Geometry is intentionally independent from the theme.
// Colours and typography come from the theme; table dimensions don't.
//
// -----------------------------------------------------------------------------
#let table-geometry = (
column-gutter: 0pt,
row-gutter: 0pt,
inset: 0pt,
stroke: none,
)
// -----------------------------------------------------------------------------
// ----- Header configuration
// -----------------------------------------------------------------------------
#let table-header-config = (
text-size: 7.2pt,
weight: "bold",
inset-x: 4pt,
inset-y: 3pt,
)
// -----------------------------------------------------------------------------
// ----- Body configuration
// -----------------------------------------------------------------------------
#let table-body-config = (
text-size: 10pt,
inset-x: 4pt,
inset-y: 4pt,
border-width: 0.3pt,
)
// -----------------------------------------------------------------------------
// ----- Zebra configuration
// -----------------------------------------------------------------------------
#let table-alternating = (
enabled: true,
)
// -----------------------------------------------------------------------------
// ----- Fantasy configuration
// -----------------------------------------------------------------------------
#let fantasy-config = (
// Label
label-size: 7.5pt,
label-weight: "bold",
label-tracking: 0.12em,
// Section
section-spacing: 0.3em,
// Rule
rule-width: 0.65pt,
)
// -----------------------------------------------------------------------------
// ----- Resolve theme
// -----------------------------------------------------------------------------
#let resolve-table-theme(table-theme) = if table-theme == none {
theme
} else {
table-theme
}
// =============================================================================
// COLOURS
// =============================================================================
//
// All table colours are derived from the supplied theme.
//
// The important distinction:
//
// theme -> defines the actual visual identity
// table -> decides where those colours are used
//
// -----------------------------------------------------------------------------
#let table-header-fill(table-theme: none) = {
let t = resolve-table-theme(table-theme)
t.dark-gold
}
#let table-header-text(table-theme: none) = {
let t = resolve-table-theme(table-theme)
t.parchment-light
}
#let table-body-text(table-theme: none) = {
let t = resolve-table-theme(table-theme)
t.ink
}
#let table-border(table-theme: none) = {
let t = resolve-table-theme(table-theme)
t.border
}
// -----------------------------------------------------------------------------
// ----- Alternating row colours -----------------------------------------------
// -----------------------------------------------------------------------------
//
// Rather than storing colours in the table configuration, derive them from
// the selected theme.
//
// -----------------------------------------------------------------------------
#let table-row-fill(index, table-theme: none) = {
let t = resolve-table-theme(table-theme)
if not table-alternating.enabled {
none
} else if calc.even(index) {
t.parchment-light
} else {
t.parchment
}
}
// =============================================================================
// HEADER
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Single header cell ---------------------------------------------------
// -----------------------------------------------------------------------------
#let table-header(
body,
table-theme: none,
inset-x: none,
inset-y: none,
fill: none,
align: auto,
) = {
let t = resolve-table-theme(table-theme)
let inset-x = if inset-x == none {
table-header-config.inset-x
} else {
inset-x
}
let inset-y = if inset-y == none {
table-header-config.inset-y
} else {
inset-y
}
let fill = if fill == none {
t.dark-gold
} else {
fill
}
table.cell(
fill: fill,
align: align,
inset: (
x: inset-x,
y: inset-y,
),
)[
#text(
size: table-header-config.text-size,
weight: table-header-config.weight,
fill: t.parchment-light,
)[
#body
]
]
}
// =============================================================================
// BODY CELL
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Single body cell -----------------------------------------------------
// -----------------------------------------------------------------------------
#let table-cell(
body,
table-theme: none,
fill: none,
inset-x: none,
inset-y: none,
align: auto,
stroke: none,
) = {
let t = resolve-table-theme(table-theme)
let inset-x = if inset-x == none {
table-body-config.inset-x
} else {
inset-x
}
let inset-y = if inset-y == none {
table-body-config.inset-y
} else {
inset-y
}
let fill = if fill == none {
t.parchment
} else {
fill
}
let stroke = if stroke == none {
(bottom: table-body-config.border-width + t.border)
} else {
stroke
}
table.cell(
fill: fill,
align: align,
stroke: stroke,
inset: (
x: inset-x,
y: inset-y,
),
)[
#text(
size: table-body-config.text-size,
fill: t.ink,
)[
#body
]
]
}
// =============================================================================
// ROW
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Complete body row ----------------------------------------------------
// -----------------------------------------------------------------------------
//
// `inset-x` may be:
//
// 4pt
//
// or:
//
// column => if column == 1 { 2pt } else { 4pt }
//
// `align` may similarly be a fixed alignment or a function.
//
// -----------------------------------------------------------------------------
#let table-row(
cells,
index: 0,
table-theme: none,
inset-x: none,
align: auto,
fill: none,
) = {
let t = resolve-table-theme(table-theme)
let row-fill = if fill == none {
table-row-fill(index, table-theme: t)
} else {
fill
}
cells
.enumerate()
.map(((column, content)) => {
let cell-inset = if inset-x == none {
table-body-config.inset-x
} else if type(inset-x) == function {
inset-x(column)
} else {
inset-x
}
let cell-align = if align == none {
none
} else if type(align) == function {
align(column)
} else {
align
}
table-cell(
content,
table-theme: t,
fill: row-fill,
inset-x: cell-inset,
align: cell-align,
)
})
}
// =============================================================================
// SPECIAL ROWS
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Full-width title row -------------------------------------------------
// -----------------------------------------------------------------------------
#let table-title(
body,
colspan,
table-theme: none,
fill: none,
inset-x: 5pt,
inset-y: 2.5pt,
stroke: none,
) = {
let t = resolve-table-theme(table-theme)
let fill = if fill == none {
t.parchment-light
} else {
fill
}
let stroke = if stroke == none {
(top: 0pt, bottom: 0.6pt + t.border)
} else {
stroke
}
table.cell(
colspan: colspan,
fill: fill,
stroke: stroke,
inset: (
x: inset-x,
y: inset-y,
),
)[ #body ]
}
// -----------------------------------------------------------------------------
// ----- Separator -------------------------------------------------------------
// -----------------------------------------------------------------------------
#let table-rule(
colspan,
table-theme: none,
stroke-width: 0.5pt,
) = {
let t = resolve-table-theme(table-theme)
table.cell(
colspan: colspan,
stroke: (
bottom: stroke-width + t.border,
),
inset: 0pt,
)[]
}
// =============================================================================
// COMPLETE TABLE
// =============================================================================
// -----------------------------------------------------------------------------
// ----- Styled table ----------------------------------------------------------
// -----------------------------------------------------------------------------
#let styled-table(
columns,
table-theme: none,
align: none,
column-gutter: none,
row-gutter: none,
inset: none,
stroke: none,
children,
) = {
let t = resolve-table-theme(table-theme)
table(
columns: columns,
column-gutter: if column-gutter == none {
table-geometry.column-gutter
} else {
column-gutter
},
row-gutter: if row-gutter == none {
table-geometry.row-gutter
} else {
row-gutter
},
inset: if inset == none {
table-geometry.inset
} else {
inset
},
stroke: if stroke == none {
table-geometry.stroke
} else {
stroke
},
align: align,
..children,
)
}
// =============================================================================
// THEMATIC LABELS & DIVIDERS
// =============================================================================
// =============================================================================
// LABEL
// =============================================================================
#let fantasy-label(
body,
theme: none,
size: none,
weight: none,
tracking: none,
fill: none,
) = {
let t = resolve-table-theme(theme)
let size = if size == none {
fantasy-config.label-size
} else {
size
}
let weight = if weight == none {
fantasy-config.label-weight
} else {
weight
}
let tracking = if tracking == none {
fantasy-config.label-tracking
} else {
tracking
}
let fill = if fill == none {
t.dark-gold
} else {
fill
}
text(
size: size,
weight: weight,
fill: fill,
tracking: tracking,
)[
#body
]
}
// =============================================================================
// RULE
// =============================================================================
#let fantasy-rule(
theme: none,
stroke-width: none,
stroke: none,
) = {
let t = resolve-table-theme(theme)
let stroke-width = if stroke-width == none {
fantasy-config.rule-width
} else {
stroke-width
}
let stroke = if stroke == none {
stroke-width + t.border
} else {
stroke
}
line(
length: 100%,
stroke: stroke,
)
}
// =============================================================================
// SECTION
// =============================================================================
#let fantasy-section(
title,
body,
theme: none,
label-size: none,
label-weight: none,
label-tracking: none,
spacing: none,
) = {
let t = resolve-table-theme(theme)
let spacing = if spacing == none {
fantasy-config.section-spacing
} else {
spacing
}
fantasy-label(
title,
theme: t,
size: label-size,
weight: label-weight,
tracking: label-tracking,
)
v(spacing)
body
}