ofClass -- English phrases for types

Synopsis

Usage:

ofClass T
Inputs:
- T, a type, an immutable type, or a list of types
Outputs:
- a sequence, an English phrase in hypertext, using a synonym for each type, together with appropriate indefinite articles, and, if a list is presented, the word or as a conjunction at the end

Description

When viewed in html, words in the phrase hot link(s) to the documentation node(s) for the class(es).

i1 : ofClass class 3

o1 = an "integer"

i2 : peek oo

o2 = SPAN{"an ", TO2{Macaulay2Doc :: ZZ, "integer"}}

i3 : ofClass Ring

o3 = a "ring"

i4 : needsPackage "Text"

o4 = Text

o4 : Package

i5 : SPAN ofClass {HashTable, ProjectiveVariety}

o5 = a "hash table" or a "projective variety"

i6 : document { Key => foo, "We may need ", ofClass ZZ, " and ", ofClass HashTable, "." }

o6 = HashTable{Description => (We may need , an "integer",  and , a "hash table", .)                 }
               DocumentTag => User :: foo
               "filename" => ../../BUILD/doug/Macaulay2/packages/Macaulay2Doc-temporary/currentString
               Key => foo
               "linenum" => 7

o6 : HashTable

i7 : help foo

o7 = foo
     ***

     Description
     ===========

     We may need an "integer" and a "hash table".

     For the programmer
     ==================

     The object "foo" is a "symbol".

Ways to use ofClass :

ofClass(ImmutableType)
ofClass(List)
ofClass(Type)

For the programmer

The object ofClass is a method function.