Doc Widgets#
The purpose of a doc widget is to navigate a document, in a doc panel. It can:
Highlight a “selection” in a document, meaning an arbitrary union of boxes
Cause a document to auto-scroll to make such a selection visible
Its visual appearance is like a link, i.e. clickable text.
Format#
TYPE
:doc
LABEL
: Yes. Provide the clickable text you want to appear in the annotation.
Fields#
Field |
Req |
Type |
Description |
---|---|---|---|
|
N |
libpath |
Indicate which document you are trying to point to, by giving a (relative) libpath that resolves to a doc info object. This field is optional because you may specify the document instead as a part of
the |
|
Y |
Indicate the desired selection within the document. |
|
string |
If you used the |
||
string |
If you omit the |