(load-xref sources [ #:render% using-render% #:root root-path]) → xref? sources : (listof (-> any/c)) using-render% : (subclass?/c render%) = (render-mixin render%) root-path : (or/c path-string? false/c) = #f
Since the format of serialized information is specific to a rendering class, the optional using-render% argument accepts the relevant class. It default to HTML rendering.
If root-path is not #f, then file paths that are serialized as relative to an instantiation-supplied root-path are deserialized as relative instead to the given root-path.
(xref-binding->definition-tag xref binding mode) → (or/c tag? false/c) xref : xref?
(or/c identifier? (list/c (or/c module-path? module-path-index?) symbol?) (listof module-path-index? symbol? module-path-index? symbol? (one-of/c 0 1) (or/c exact-integer? false/c) (or/c exact-integer? false/c))) mode : (or/c exact-integer? false/c)
The mode argument specifies the relevant phase level for the binding. The binding is specified in one of four ways:
If binding is an identifier, then identifier-binding is used with mode to determine the binding.
If binding is a two-element list, then the first element provides the exporting module and the second the exported name. The mode argument is effectively ignored.
If binding is a seven-element list, then it corresponds to a result from identifier-binding using mode.
If binding is a five-element list, then the first element is as for the two-element-list case, and the remain elements are as in the last four elements of the seven-element case.
If a documentation point exists in xref, a tag is returned, which might be used with xref-tag->path+anchor or embedded in a document rendered via xref-render. If no definition point is found in xref, the result is #f.
(xref-tag->path+anchor xref tag [ #:external-root-url root-url #:render% using-render%])
(or/c false/c path?) (or/c false/c string?) xref : xref? tag : tag? root-url : (or/c string? #f) = #f using-render% : (subclass?/c render%) = (render-mixin render%)
If root-url is provided, then references to documentation in the main installation are redirected to the given URL.
The optional using-render% argument is as for load-xref.
(xref-render xref doc dest [ #:render% using-render% #:refer-to-existing-files? use-existing?]) → (or/c void? any/c) xref : xref? doc : part? dest : (or/c path-string? false/c) using-render% : (subclass?/c render%) = (render-mixin render%) use-existing? : any/c = (not dest)
If dest is #f, no file is written, and the result is an X-expression for the rendered page. Otherwise, the file dest is written and the result is #<void>.
The optional using-render% argument is as for load-xref. It determines the kind of output that is generated.
If use-existing? is true, then files referenced during rendering (such as image files) are referenced from their existing locations, instead of copying to the directory of dest.
(xref-transfer-info renderer ci xref) → void? renderer : (is-a?/c render%) ci : collect-info? xref : xref?
The words list corresponds to index-element-plain-seq. The content list corresponds to index-element-entry-seq. The desc value corresponds to index-element-desc. The tag is the destination for the index link into the main document.