Module

jinks/taxonomy

src/jinks/taxonomy.pooka

A tag gathers visible pages without inventing another source document. Display names remain readable; their Unicode slugs are checked for clashes instead of allowing the last spelling to overwrite the first. Page links contain no page lists, keeping the resulting JSON graph finite.

API reference

class

Tag

src/jinks/taxonomy.pooka:20
class Tag(name: String, slug: String, output: String, pages: List(content.Page))
field

name

src/jinks/taxonomy.pooka:20
name: String
INFERREDString
field

slug

src/jinks/taxonomy.pooka:20
slug: String
INFERREDString
field

output

src/jinks/taxonomy.pooka:20
output: String
INFERREDString
field

pages

src/jinks/taxonomy.pooka:20
pages: List(content.Page)
INFERREDList(jinks/content.Page)
constructor

new

src/jinks/taxonomy.pooka:20
INFERREDfn(String, String, String, List(jinks/content.Page)) -> jinks/taxonomy.Tag
class

Index

src/jinks/taxonomy.pooka:22
class Index(
  groups: List(Tag),
  context: json.Json,
  by_label: dict.Dict(String, Tag),
  labels_by_page: dict.Dict(String, List(String))
)
field

groups

src/jinks/taxonomy.pooka:23
groups: List(Tag)
INFERREDList(jinks/taxonomy.Tag)
field

context

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

by_label

src/jinks/taxonomy.pooka:25
by_label: dict.Dict(String, Tag)
INFERRED$package/pooka_stdlib/pooka/dict.Dict(String, jinks/taxonomy.Tag)
field

labels_by_page

src/jinks/taxonomy.pooka:26
labels_by_page: dict.Dict(String, List(String))
INFERRED$package/pooka_stdlib/pooka/dict.Dict(String, List(String))
constructor

new

src/jinks/taxonomy.pooka:23
INFERREDfn(List(jinks/taxonomy.Tag), $package/pooka_json/pooka/json.Json, $package/pooka_stdlib/pooka/dict.Dict(String, jinks/taxonomy.Tag), $package/pooka_stdlib/pooka/dict.Dict(String, List(String))) -> jinks/taxonomy.Index
function

normalize

src/jinks/taxonomy.pooka:37
normalize(label: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)
function

slug

src/jinks/taxonomy.pooka:49
slug(label: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)
function

prepare

src/jinks/taxonomy.pooka:58
prepare(
  options: listing_options.Tags,
  catalog: collection.Catalog,
  pages: List(content.Page)
) -> Result(Index, String)
function

link

src/jinks/taxonomy.pooka:141
link(tag: Tag) -> json.Json
INFERREDfn(jinks/taxonomy.Tag) -> $package/pooka_json/pooka/json.Json
function

links

src/jinks/taxonomy.pooka:152
links(page: content.Page, index: Index) -> json.Json
INFERREDfn(jinks/content.Page, jinks/taxonomy.Index) -> $package/pooka_json/pooka/json.Json
function

page_summary

src/jinks/taxonomy.pooka:162
page_summary(index: Index, page: content.Page) -> json.Json
INFERREDfn(jinks/taxonomy.Index, jinks/content.Page) -> $package/pooka_json/pooka/json.Json
function

summary

src/jinks/taxonomy.pooka:169
summary(index: Index, tag: Tag) -> json.Json
INFERREDfn(jinks/taxonomy.Index, jinks/taxonomy.Tag) -> $package/pooka_json/pooka/json.Json
function

collections

src/jinks/taxonomy.pooka:185
collections(
  index: Index,
  catalog: collection.Catalog,
  pages: List(content.Page)
) -> json.Json
INFERREDfn(jinks/taxonomy.Index, jinks/collection.Catalog, List(jinks/content.Page)) -> $package/pooka_json/pooka/json.Json