Module

jinks/listing_options

src/jinks/listing_options.pooka

A listing is an explicit invitation to create more pages. Keeping these options separate from collection membership lets an ordinary collection stay just a list until its author chooses an archive address and layout.

API reference

class

Archive

src/jinks/listing_options.pooka:14
class Archive(
  collection: String,
  url: String,
  layout: String,
  title: String,
  size: Int,
  page_path: String
)
field

collection

src/jinks/listing_options.pooka:15
collection: String
INFERREDString
field

url

src/jinks/listing_options.pooka:16
url: String
INFERREDString
field

layout

src/jinks/listing_options.pooka:17
layout: String
INFERREDString
field

title

src/jinks/listing_options.pooka:18
title: String
INFERREDString
field

size

src/jinks/listing_options.pooka:19
size: Int
INFERREDInt
field

page_path

src/jinks/listing_options.pooka:20
page_path: String
INFERREDString
constructor

new

src/jinks/listing_options.pooka:15
INFERREDfn(String, String, String, String, Int, String) -> jinks/listing_options.Archive
class

Tags

src/jinks/listing_options.pooka:23
class Tags(
  enabled: Bool,
  path: String,
  layout: String,
  index: Option(String),
  index_layout: String,
  index_title: String,
  size: Int,
  collection: String,
  page_path: String
)
field

enabled

src/jinks/listing_options.pooka:24
enabled: Bool
INFERREDBool
field

path

src/jinks/listing_options.pooka:25
path: String
INFERREDString
field

layout

src/jinks/listing_options.pooka:26
layout: String
INFERREDString
field

index

src/jinks/listing_options.pooka:27
index: Option(String)
INFERREDOption(String)
field

index_layout

src/jinks/listing_options.pooka:28
index_layout: String
INFERREDString
field

index_title

src/jinks/listing_options.pooka:29
index_title: String
INFERREDString
field

size

src/jinks/listing_options.pooka:30
size: Int
INFERREDInt
field

collection

src/jinks/listing_options.pooka:31
collection: String
INFERREDString
field

page_path

src/jinks/listing_options.pooka:32
page_path: String
INFERREDString
constructor

new

src/jinks/listing_options.pooka:24
INFERREDfn(Bool, String, String, Option(String), String, String, Int, String, String) -> jinks/listing_options.Tags
class

Options

src/jinks/listing_options.pooka:35
class Options(archives: List(Archive), tags: Tags)
field

archives

src/jinks/listing_options.pooka:35
archives: List(Archive)
field

tags

src/jinks/listing_options.pooka:35
tags: Tags
constructor

new

src/jinks/listing_options.pooka:35
function

parse

src/jinks/listing_options.pooka:37
parse(doc: tome.Toml) -> Result(Options, String)
INFERREDfn($package/tome/tome.Toml) -> Result(jinks/listing_options.Options, String)
function

tags

src/jinks/listing_options.pooka:67
tags(doc: tome.Toml) -> Result(Tags, String)
INFERREDfn($package/tome/tome.Toml) -> Result(jinks/listing_options.Tags, String)
function

text

src/jinks/listing_options.pooka:124
text(doc: tome.Toml, key: String, fallback: String) -> Result(String, String)
INFERREDfn($package/tome/tome.Toml, String, String) -> Result(String, String)
function

positive

src/jinks/listing_options.pooka:132
positive(doc: tome.Toml, key: String, fallback: Int) -> Result(Int, String)
INFERREDfn($package/tome/tome.Toml, String, Int) -> Result(Int, String)
function

optional_url

src/jinks/listing_options.pooka:140
optional_url(doc: tome.Toml, key: String) -> Result(Option(String), String)
INFERREDfn($package/tome/tome.Toml, String) -> Result(Option(String), String)
function

relative

src/jinks/listing_options.pooka:171
relative(value: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)
function

layout

src/jinks/listing_options.pooka:187
layout(name: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)