Module

marksy/links

src/marksy/links.pooka

Brackets name the label; parentheses carry its address. This reader keeps them apart so punctuation in a URL does not become inline formatting. Nested parentheses are counted, and malformed links leave their source untouched for the ordinary text reader.

API reference

class

Target

src/marksy/links.pooka:16
class Target(
  label: String,
  destination: String,
  title: String,
  rest: List(String)
)
field

label

src/marksy/links.pooka:17
label: String
INFERREDString
field

destination

src/marksy/links.pooka:18
destination: String
INFERREDString
field

title

src/marksy/links.pooka:19
title: String
INFERREDString
field

rest

src/marksy/links.pooka:20
rest: List(String)
INFERREDList(String)
constructor

new

src/marksy/links.pooka:17
INFERREDfn(String, String, String, List(String)) -> marksy/links.Target
class

Definition

src/marksy/links.pooka:23
class Definition(label: String, destination: String, title: String)
field

label

src/marksy/links.pooka:23
label: String
INFERREDString
field

destination

src/marksy/links.pooka:23
destination: String
INFERREDString
field

title

src/marksy/links.pooka:23
title: String
INFERREDString
constructor

new

src/marksy/links.pooka:23
INFERREDfn(String, String, String) -> marksy/links.Definition
class

DefinitionRead

src/marksy/links.pooka:25
class DefinitionRead(value: Definition, lines: Int)
field

value

src/marksy/links.pooka:25
value: Definition
field

lines

src/marksy/links.pooka:25
lines: Int
INFERREDInt
constructor

new

src/marksy/links.pooka:25
function

read

src/marksy/links.pooka:28
read(chars: List(String)) -> Option(Target)
INFERREDfn(List(String)) -> Option(marksy/links.Target)

Input begins just after [. Read a direct link without definitions.

function

read_with

src/marksy/links.pooka:34
read_with(chars: List(String), definitions: List(Definition)) -> Option(Target)
INFERREDfn(List(String), List(marksy/links.Definition)) -> Option(marksy/links.Target)

Full/collapsed reference links take precedence over shortcut links. A syntactically valid but unknown full label does not fall back to a shortcut.

function

normalise

src/marksy/links.pooka:79
normalise(value: String) -> String
INFERREDfn(String) -> String

The original label spelling matters: backslash escapes are not decoded for matching. Collapse whitespace and fold case, keeping the first definition.

function

lookup

src/marksy/links.pooka:101
lookup(definitions: List(Definition), label: String) -> Option(Definition)
INFERREDfn(List(marksy/links.Definition), String) -> Option(marksy/links.Definition)
function

definition

src/marksy/links.pooka:324
definition(source: String) -> Option(DefinitionRead)
INFERREDfn(String) -> Option(marksy/links.DefinitionRead)

Read one reference definition at the beginning of a nonblank block. The block pass supplies normalised logical lines, including a final newline.

function

decode_literal

src/marksy/links.pooka:396
decode_literal(value: String) -> String
INFERREDfn(String) -> String

Decode only escapes/entities, as required by destinations and fence info.