API
The one function you need to convert URNs to URLs in a markdown source:
CiteDown.rewrite — FunctionRewrite contents of file f with URNs replaced by URLs if they are configured for citable services in the file's YAML header.
rewrite(f)
A publicly exported function so that linkedMarkdownImage can work from a URN and a CiteDown.Settings instance.
CitableImage.linkedMarkdownImage — FunctionCompose markdown wrapping IIIF URL for image linked to an image citation tool installation.
linkedMarkdownImage(ict, img, service; ht, caption)
Arguments
ictURL of an instance of the CiteArchitecture ImageCitationTool.imgCite2Urnfor an image.serviceIIIFServicehtHeight of resulting image in pixels.captionCaption to embed in resulting linked markdown string.
Compose markdown wrapping IIIF URL for image linked to an image citation tool installation.
linkedMarkdownImage(img, cdsettings)
Arguments
imgURN stringcdsettingsCiteDown.Settings
Internal structures and functions
CiteDown.Settings — TypeSettings for interpreting URNs in markdown.
CiteDown.pageparts — FunctionSplit markdown file into YAML header and markdown body. Returns a tuple of 2 strings. If there is no YAML header, the first string will be empty.
pageparts(f)
CiteDown.settings — FunctionCreate document settings object from a string source.
settings(src)
CiteDown.null_settings — FunctionInitialize a Settings instance with empty values.
null_settings()
CiteDown.urlize — FunctionConvert URNs in markdown image references to URL values.
urlize(md, cdsettings)