Other Widget Types#

Goal Widgets#

Goal widgets let you place goal boxes in the page, of the same kind that appear in the corner of every node and deduction in proof charts.

Just like the goal boxes appearing in proof charts, users can click to record check marks, and right-click to record free-form notes. Thus, goal widgets provide a way to place study goals in pages. See this intro to PISE’s study features for more.

Goal widgets are not currently supported in Sphinx pages.

Format#

TYPE: goal
NAME: Required.
LABEL: Optional. May be a Markdown section heading, in order to put a goal box at the start of the heading. Otherwise, just leave blank, in order to place a goal box anywhere in inline Markdown.
ROLE_FIELD: None.
CONTENT_FIELD: None.

Note

A NAME is required for goal widgets in order to promote stability of users’ checkmarks and study notes, and the ability to carry these forward across version changes.

Fields#

Required#

None.

Optional#

None.

Label Widgets#

A label widget provides a point within an annotation page to which Link Widgets can link.

On mouse hover, a “paragraph” icon comes up, which, when clicked, copies the widget’s libpath to clipboard.

Label widgets are not currently supported in Sphinx pages.

Format#

TYPE: label
NAME: Optional.
LABEL: Required. Must be either a single line of inline Markdown, or else a Markdown section heading. This is the page content to which link widgets will scroll, and on which mouse hover will bring up a “paragraph” icon.
ROLE_FIELD: None.
CONTENT_FIELD: None.

Fields#

Required#

None.

Optional#

None.

Link Widgets#

Link widgets are for making a link from one annotation page to another, or directly to a particular widget within an annotation page.

Format#

TYPE: link
NAME: Optional.
LABEL: Required. Appears as clickable text in the page.
ROLE_FIELD: link widgets are not currently supported in Sphinx pages.
CONTENT_FIELD: None.

Fields#

Required#

Field	Type	Description
`ref`	libpath	A relative libpath pointing to the annotation or widget to which you wish to link.

Optional#

Field	Type	Description
`tab`	enum	Controls whether the content is loaded in the same tab where the link occurred, or another existing tab, or a new tab. In order to help define the policies, suppose the link occurs in annotation \(A\) and points (in)to annotation \(B\). Suppose the link has been clicked inside tab \(T\). If \(B\) is currently open in one or more tabs, let \(R\) be the one among these with which the user has most recently interacted. Policies: “same”: Load in \(T\) under all circumstances. “new”: Load in a new tab under all circumstances. “other”: The idea is that the content is to be loaded somewhere else. To be precise, if \(R\) exists, load there. Else load in a new tab. “existing”: The idea is that if \(B\) is already open in any tab, then load the content there. To be precise: If \(B \neq A\) and \(R\) exists, load in \(R\); otherwise load in \(T\). Default: “existing”

Field

Type

Description

tab

enum

Controls whether the content is loaded in the same tab where the link occurred, or another existing tab, or a new tab.

In order to help define the policies, suppose the link occurs in annotation \(A\) and points (in)to annotation \(B\). Suppose the link has been clicked inside tab \(T\). If \(B\) is currently open in one or more tabs, let \(R\) be the one among these with which the user has most recently interacted.

Policies:

“same”: Load in \(T\) under all circumstances.
“new”: Load in a new tab under all circumstances.
“other”: The idea is that the content is to be loaded somewhere else. To be precise, if \(R\) exists, load there. Else load in a new tab.
“existing”: The idea is that if \(B\) is already open in any tab, then load the content there. To be precise: If \(B \neq A\) and \(R\) exists, load in \(R\); otherwise load in \(T\).

Default: “existing”

Q-and-A Widgets#

Q-and-A widgets put a box in the page showing a question, and with an answer which remains hidden until the user hovers their mouse over the answer space.

Format#

TYPE: qna
NAME: Optional.
LABEL: Not accepted.
ROLE_FIELD: None.
CONTENT_FIELD: None.

Fields#

Required#

Field	Type	Description
`question`	string	Text posing a question.

`answer`	string	Text providing an answer.

Optional#

None.