mixinafFandoc::LinkResolver

afFandoc::LinkResolver

@Js

An interface for resolving URI links.

cssLinkResolver

Source

static LinkResolver cssLinkResolver(|Str?,Uri->Uri? resolverLinkFn)

Returns a LinkResolver that validates CSS links - use in conjunction with CssLinkProcessor.

fandocResolver

Source

static LinkResolver fandocResolver()

Returns a LinkResolver that returns links to documentation on the Fantom website.

Supports qualified Fantom links as defined in compilerDoc::DocLink and resolves them to the Fantom website. (@ http://fantom.org/doc/)

Format

Display

Links To

pod::index

pod

absolute link to pod index

pod::pod-doc

pod

absolute link to pod doc chapter

pod::Type

Type

absolute link to type qname

pod::Types.slot

Type.slot

absolute link to slot qname

pod::Chapter

Chapter

absolute link to book chapter

pod::Chapter#frag

Chapter

absolute link to book chapter anchor

fromFn

Source

static new fromFn(|Str?,Uri->Uri? fn)

Creates a LinkResolver from the given fn.

idPassThroughResolver

Source

static LinkResolver idPassThroughResolver()

Returns a LinkResolver that returns the given url should it be prefixed with a #.

javascriptErrorResolver

Source

static LinkResolver javascriptErrorResolver(Uri errorUrl := `/error`)

Returns a LinkResolver that returns an errorUrl should the given url have a scheme of javascript:.

passThroughResolver

Source

static LinkResolver passThroughResolver()

Returns a basic LinkResolver that just returns the given url.

pathAbsPassThroughResolver

Source

static LinkResolver pathAbsPassThroughResolver()

Returns a LinkResolver that returns the given url should it be path only and path absolute.

resolve

Source

abstract Uri? resolve(Str? scheme, Uri url)

Resolve the given url.

schemePassThroughResolver

Source

static LinkResolver schemePassThroughResolver(Str[] schemes := "http https ftp data".split())

Returns a LinkResolver that returns the given url should it be qualified with a common scheme such as: http, https, ftp, data.