This section documents the browser. Below, current position refers to the current position in the document being browsed. The object at this current position is referred to as the current selection. The phrases moving current position and changing current selection are used synonymously.
read-pointer [FUNCTION]
Return current position in the document. This points to the object that was just rendered.
save-pointer-excursion &body body [MACRO]
Preserve the current position in the document when rendering the current selection. This macro remembers the current position in the document and restores it afterexecution of body. Note: Current position is accessible by calling read-pointer.
move-up &optional (n 1) [FUNCTION]
Move current position up by n levels. The defaultthe is one level.
move-forward &optional (n 1) [FUNCTION]
Move current position forward (to the right) by n. The default is to move to the next sibling.
move-back &optional (n 1) [FUNCTION]
Move current position backward (to the left) by n. The default is to move to the previous sibling.
move-above [FUNCTION]
If in a table, then move to the element above the current selection. Produce an appropriate spoken message if on the top row of a table.
move-below [FUNCTION]
If in a table, then move to the element below the current selection. Produce an appropriate spoken message if on the bottom row of a table.
move-to-children [FUNCTION]
Move to the children of the current selection.
move-to-contents [FUNCTION]
Move to the contents of the current selection.
move-to-top-of-math [FUNCTION]
Move to the top of the current mathematical expression the root of the internal tree representation.
The next six functions move the current position to the various attributes of a math object.
move-to-subscript [FUNCTION]
Move to subscript.
move-to-superscript [FUNCTION]
Move to superscript.
move-to-accent [FUNCTION]
Move to accent.
move-to-underbar [FUNCTION]
Move to underbar.
move-to-left-superscript [FUNCTION]
Move to left-superscript.
move-to-left-subscript [FUNCTION]
Move to left-subscript.
forward-sentence &optional (c 1) [FUNCTION]
Move forward c sentences. Move back if c is negative.
summarize document [GENERIC FUNCTION]
Summarize a document object. Methods on this function specify how different object types are summarized. Summarizing an object produces a succinct audio rendering sufficient to cue the listener to the identity of the object.
read-current [FUNCTION]
Render the object at the current position, indicated by read-pointer. Object will be rendered in the global state.
read-current-relatively [FUNCTION]
Same as read-current except that the object is rendered in the context in which it occurs. Especially useful when browsing table entries; using this function places them at the correct spatial location.
Calling any of the following functions affects current position.
read-previous &optional (n 1) [FUNCTION]
Render left sibling if any. n specifies amount by which to move left.
read-next &optional (n 1) [FUNCTION]
Render right sibling if any. n specifies amount by which to move right.
read-children [FUNCTION]
Render the children of the object at the current position.
read-parent &optional (n 1) [FUNCTION]
Move up by n levels and render the resultant selection. The default is to move up one level and render the parent.
read-rest start-position &optional (read-this-node t) [FUNCTION]
Render rest of the document starting at the current position. Optional argument read-this-node specifies if current selection should be rendered as well.
read-above [FUNCTION]
If in a table, then render the element above the element at the current position. Produces appropriate spoken message if on the top row of a table or outside a table.
read-below [FUNCTION]
If in a table, then render the element below the element at the current position. Produces appropriate spoken message if on the bottom row of a table or outside a table.
read-just-the-node [FUNCTION]
Render only the node at the current position. Useful when browsing mathematical expressions. Use this function to listen to the current term rather than the entire sub-expression rooted at current position.
read-sentence &optional (count 1) [FUNCTION]
REnder the next count sentences.
*follow-cross-ref-wait* 1 [PARAMETER]
The value of this parameter determines how cross-reference tags are rendered. If *follow-cross-ref-wait* = 0, then the cross-reference tag is rendered and the system continues without waiting to check if the user wishes to follow the cross-reference. If *follow-cross-ref-wait* = n, then AS TE R prompts the user by playing *cross-ref-cue* (a short sound cue) and waits for n seconds before continuing. If the user presses y in this time, the cross-referenced object is rendered.
read-follow-cross-ref direction-flag [FUNCTION]
Follow and render the closest cross reference.
mark-read-pointer [FUNCTION]
Mark current location of read pointer.
remove-bookmark tag [FUNCTION]
Remove this bookmark.
follow-bookmark [FUNCTION]
Prompt for a bookmark and render the object marked by it. Does not affect the current position in the document.
goto-bookmark [FUNCTION]
Prompt for bookmark and move to this position. Affects current position in the document.