EXAMPLE -- hypertext EXAMPLE item

Synopsis

• Usage:
EXAMPLE x
• Inputs:
• x, , , or an instance of the type PRE, containing strings or objects of class PRE
• Outputs:
• an instance of the type TABLE, a table containing the examples

Description

If the table is included in the input provided to document, the input string will be evaluated by installPackage and the result will be displayed in the documentation. Each object of class PRE will be inserted unchanged into the documentation as example output. For example, the code

EXAMPLE { "1+1" }

produces a display that looks like this:

 i1 : 1+1 o1 = 2

• examples -- list the examples in documentation
• hypertext -- prepare hypertext for display
• document -- create a documentation node
• installPackage -- load and install a package and its documentation

Ways to use EXAMPLE :

• "EXAMPLE(String)"
• "EXAMPLE(VisibleList)"

For the programmer

The object EXAMPLE is .