DocumentTag -- the class of all document tags

Description

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

i1 : makeDocumentTag (res, Module)

o1 = OldChainComplexes :: resolution(Module)

o1 : DocumentTag

i2 : peek oo

o2 = DocumentTag{Format => resolution(Module)}
                 Key => (resolution, Module)
                 Package => OldChainComplexes
                 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 = OldChainComplexes :: resolution(...,PairLimit=>...)

o5 : DocumentTag

i6 : peek oo

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

Methods that use a document tag:

format(DocumentTag)
locate(DocumentTag)
makeDocumentTag(DocumentTag)
examples(DocumentTag) -- see examples -- list the examples in documentation
help(DocumentTag) -- see help -- view documentation nodes
infoHelp(DocumentTag) -- see infoHelp -- view documentation in Info format
package(DocumentTag) -- see package -- get containing package
viewHelp(DocumentTag) -- see viewHelp -- view online documentation in a web browser

For the programmer

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

The source of this document is in Macaulay2Doc/ov_documentation.m2:251:0.