Macaulay2 » Documentation
Packages » Macaulay2Doc > The Macaulay2 language > writing documentation > documentation keys > DocumentTag
next | previous | forward | backward | up | index | toc

DocumentTag -- the class of all document tags

Description

This class is mainly for internal use, in constructing documentation.

i1 : makeDocumentTag (res, Module)

o1 = Macaulay2Doc :: resolution(Module)

o1 : DocumentTag
i2 : peek oo

o2 = DocumentTag{Format => resolution(Module)}
                 Key => (resolution, Module)
                 Package => Macaulay2Doc
                 RawDocumentation => null
i3 : makeDocumentTag (koszul, ZZ, Matrix)

o3 = Macaulay2Doc :: koszul(ZZ,Matrix)

o3 : DocumentTag
i4 : peek oo

o4 = DocumentTag{Format => koszul(ZZ,Matrix)}
                 Key => (koszul, ZZ, Matrix)
                 Package => Macaulay2Doc
                 RawDocumentation => null
i5 : makeDocumentTag [res, PairLimit]

o5 = Macaulay2Doc :: resolution(...,PairLimit=>...)

o5 : DocumentTag
i6 : peek oo

o6 = DocumentTag{Format => resolution(...,PairLimit=>...)}
                 Key => [resolution, PairLimit]
                 Package => Macaulay2Doc
                 RawDocumentation => null

Methods that use a document tag:

For the programmer

The object DocumentTag is a type, with ancestor classes HashTable < Thing.