primitive

ハイパーリンクに関するプリミティブです。

val register-link-to-uri : string -> point -> length -> length -> length -> ((length * color)) option -> unit

URLと座標、幅、高さ、深さ、枠線を指定してURLへのハイパーリンクを生成します。

val register-link-to-location : string -> point -> length -> length -> length -> ((length * color)) option -> unit

キーと座標、幅、高さ、深さ、枠線を指定してジャンプ先へのハイパーリンクを生成します。

val register-destination : string -> point -> unit

キーと座標を指定して、ジャンプ先を登録します。

module Annot: sig end

ハイパーリンクに関する関数とコマンドを提供します。

annot.satyhによって提供され、@require: annotとすると使うことができます。

コマンド

direct \href : [((length * color))?; string; inline-text] inline-cmd

第一引数にURLを、第二引数に文字列を入れると、URL先に飛べる文字列が出力されます。

オプション引数でハイパーリンク部分を囲う枠の色と太さを調節できます。この枠は印刷時には消えます。

装飾用関数

val link-to-uri-frame : string -> ((length * color)) option -> deco-set

URLとハイパーリンク部分を囲う枠の色と太さの情報を与えると deco-set を返してくれます。この deco-set をinline-frame-breakable等で処理すると、ハイパーリンク部分が生成されます。

link-to-url-frame `https://github.com/gfngfn/SATySFi` Some (0.5pt, Color.red)のようにして使用します。

val link-to-location-frame : string -> ((length * color)) option -> deco-set

文書内のハイパーリンクに関する関数です。 link-to-uri-frameと似た使い方ですが、第一引数にはURLではなく後述する“キー”を入れます。

link-to-url-frame `key` Some (0.5pt, Color.red)のようにして使用します。

val register-location-frame : string -> deco-set

キーを指定すると、 deco-set が返ってきます。これをinline-frame-breakable等で処理すると、文書内ハイパーリンクのジャンプ先を作ることができます。ここで指定したキーと同じキーをlink-to-location-frameで指定すると、そこから飛んでくることが可能になります。