Module

jinks/collection

src/jinks/collection.pooka

Arrange the shelves once before rendering. Ties use source paths, even for descending order, so a filesystem's enumeration order never decides which article sits next to another. Neighbours are summaries, not recursive page graphs, keeping the template boundary finite.

API reference

class

Neighbours

src/jinks/collection.pooka:20
class Neighbours(previous: Option(content.Page), next: Option(content.Page))
field

previous

src/jinks/collection.pooka:20
previous: Option(content.Page)
INFERREDOption(jinks/content.Page)
field

next

src/jinks/collection.pooka:20
next: Option(content.Page)
INFERREDOption(jinks/content.Page)
constructor

new

src/jinks/collection.pooka:20
class

Catalog

src/jinks/collection.pooka:22
class Catalog(
  groups: List(#(String, List(content.Page))),
  context: json.Json,
  neighbours: dict.Dict(String, Neighbours)
)
field

groups

src/jinks/collection.pooka:23
groups: List(#(String, List(content.Page)))
INFERREDList(#(String, List(jinks/content.Page)))
field

context

src/jinks/collection.pooka:24
context: json.Json
INFERRED$package/pooka_json/pooka/json.Json
field

neighbours

src/jinks/collection.pooka:25
neighbours: dict.Dict(String, Neighbours)
INFERRED$package/pooka_stdlib/pooka/dict.Dict(String, jinks/collection.Neighbours)
constructor

new

src/jinks/collection.pooka:23
INFERREDfn(List(#(String, List(jinks/content.Page))), $package/pooka_json/pooka/json.Json, $package/pooka_stdlib/pooka/dict.Dict(String, jinks/collection.Neighbours)) -> jinks/collection.Catalog
function

summary

src/jinks/collection.pooka:28
summary(page: content.Page) -> json.Json
INFERREDfn(jinks/content.Page) -> $package/pooka_json/pooka/json.Json
function

members

src/jinks/collection.pooka:64
members(spec: section.Spec, pages: List(content.Page)) -> Result(
  List(content.Page),
  String
)
INFERREDfn(jinks/section.Spec, List(jinks/content.Page)) -> Result(List(jinks/content.Page), String)
function

day

src/jinks/collection.pooka:94
day(page: content.Page) -> String
INFERREDfn(jinks/content.Page) -> String
function

prepare

src/jinks/collection.pooka:102
prepare(specs: List(section.Spec), pages: List(content.Page)) -> Result(
  Catalog,
  String
)
INFERREDfn(List(jinks/section.Spec), List(jinks/content.Page)) -> Result(jinks/collection.Catalog, String)

Sort each configured collection once and reuse it for every page context.

function

index

src/jinks/collection.pooka:128
index(specs: List(section.Spec), pages: List(content.Page)) -> Result(
  json.Json,
  String
)
INFERREDfn(List(jinks/section.Spec), List(jinks/content.Page)) -> Result($package/pooka_json/pooka/json.Json, String)
function

page_context

src/jinks/collection.pooka:136
page_context(
  page: content.Page,
  specs: List(section.Spec),
  pages: List(content.Page)
) -> Result(json.Json, String)
INFERREDfn(jinks/content.Page, List(jinks/section.Spec), List(jinks/content.Page)) -> Result($package/pooka_json/pooka/json.Json, String)
function

context_for

src/jinks/collection.pooka:145
context_for(page: content.Page, catalog: Catalog) -> json.Json
INFERREDfn(jinks/content.Page, jinks/collection.Catalog) -> $package/pooka_json/pooka/json.Json
function

context_with

src/jinks/collection.pooka:149
context_with(
  page: content.Page,
  catalog: Catalog,
  project: fn(content.Page) -> json.Json
) -> json.Json
INFERREDfn(jinks/content.Page, jinks/collection.Catalog, fn(jinks/content.Page) -> $package/pooka_json/pooka/json.Json) -> $package/pooka_json/pooka/json.Json
function

index_neighbours

src/jinks/collection.pooka:171
index_neighbours(
  pages: List(content.Page),
  previous: Option(content.Page),
  found: dict.Dict(String, Neighbours)
) -> dict.Dict(String, Neighbours)
INFERREDfn(List(jinks/content.Page), Option(jinks/content.Page), $package/pooka_stdlib/pooka/dict.Dict(String, jinks/collection.Neighbours)) -> $package/pooka_stdlib/pooka/dict.Dict(String, jinks/collection.Neighbours)