Module
jinks/listing_options
src/jinks/listing_options.pookaA 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(
collection: String,
url: String,
layout: String,
title: String,
size: Int,
page_path: String
)
collection: String
INFERRED
Stringurl: String
INFERRED
Stringlayout: String
INFERRED
Stringtitle: String
INFERRED
Stringsize: Int
INFERRED
Intpage_path: String
INFERRED
String
INFERRED
fn(String, String, String, String, Int, String) -> jinks/listing_options.Archiveclass Tags(
enabled: Bool,
path: String,
layout: String,
index: Option(String),
index_layout: String,
index_title: String,
size: Int,
collection: String,
page_path: String
)
enabled: Bool
INFERRED
Boolpath: String
INFERRED
Stringlayout: String
INFERRED
Stringindex: Option(String)
INFERRED
Option(String)index_layout: String
INFERRED
Stringindex_title: String
INFERRED
Stringsize: Int
INFERRED
Intcollection: String
INFERRED
Stringpage_path: String
INFERRED
String
INFERRED
fn(Bool, String, String, Option(String), String, String, Int, String, String) -> jinks/listing_options.Tagsclass Options(archives: List(Archive), tags: Tags)
archives: List(Archive)
INFERRED
List(jinks/listing_options.Archive)tags: Tags
INFERRED
jinks/listing_options.Tags
INFERRED
fn(List(jinks/listing_options.Archive), jinks/listing_options.Tags) -> jinks/listing_options.Optionsparse(doc: tome.Toml) -> Result(Options, String)
INFERRED
fn($package/tome/tome.Toml) -> Result(jinks/listing_options.Options, String)tags(doc: tome.Toml) -> Result(Tags, String)
INFERRED
fn($package/tome/tome.Toml) -> Result(jinks/listing_options.Tags, String)text(doc: tome.Toml, key: String, fallback: String) -> Result(String, String)
INFERRED
fn($package/tome/tome.Toml, String, String) -> Result(String, String)positive(doc: tome.Toml, key: String, fallback: Int) -> Result(Int, String)
INFERRED
fn($package/tome/tome.Toml, String, Int) -> Result(Int, String)optional_url(doc: tome.Toml, key: String) -> Result(Option(String), String)
INFERRED
fn($package/tome/tome.Toml, String) -> Result(Option(String), String)relative(value: String) -> Result(String, String)
INFERRED
fn(String) -> Result(String, String)layout(name: String) -> Result(String, String)
INFERRED
fn(String) -> Result(String, String)