7.8 Cross-Reference Utilities
| |||||||||||||||||||||
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.
Use load-collections-xref from setup/xref to get all cross-reference information for installed documentation.
| |||||||||||||||||||||
xref : xref? | |||||||||||||||||||||
| |||||||||||||||||||||
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 : xref? | ||||||||||||
tag : tag? | ||||||||||||
using-render% : (subclass?/c render%) = (render-mixin render%) |
The optional using-render% argument is as for load-xref.
| ||||||||||||||||||||
→ (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? |
(xref-index xref) → (listof entry?) |
xref : xref? |
| ||||||
words : (and/c (listof string?) cons?) | ||||||
content : list? | ||||||
tag : tag? | ||||||
desc : any/c |
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.