API Reference Content Model Definitions

Element: apiArray

Content model

no content

Inheritance

topic/state reference/state

Element: apiData

Contains

apiname, b, boolean, cite, cmdname, codeph, draft-comment, filepath, fn, i, image, indexterm, indextermref, keyword, menucascade, msgnum, msgph, option, parmname, ph, q, required-cleanup, state, sub, sup, synph, systemoutput, term, tm, tt, u, uicontrol, userinput, varname, wintitle, xref

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/ph reference/ph

Element: apiDef

Contained by

apiDetail

Contains

apiArray, apiData, apiDefItem, apiDefNote, apiItemName, apiname, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiDefItem or apiItemName) (any number)

Inheritance

topic/section reference/section

Element: apiDefItem

Contained by

apiDef, apiDefItem

Contains

apiArray, apiData, apiDefItem, apiDefNote, apiItemName, apiname, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiDefItem) (any number)

Inheritance

topic/ph reference/ph

Element: apiDefNote

Contains

apiname, b, boolean, cite, cmdname, codeph, draft-comment, filepath, fn, i, image, indexterm, indextermref, keyword, menucascade, msgnum, msgph, option, parmname, ph, q, required-cleanup, state, sub, sup, synph, systemoutput, term, tm, tt, u, uicontrol, userinput, varname, wintitle, xref

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/ph reference/ph

Element: apiDesc

Contains

apiname, b, boolean, cite, cmdname, codeblock, codeph, dl, draft-comment, fig, filepath, fn, i, image, imagemap, indexterm, indextermref, keyword, lines, lq, menucascade, msgblock, msgnum, msgph, note, object, ol, option, p, parml, parmname, ph, pre, q, required-cleanup, screen, simpletable, sl, state, sub, sup, synph, syntaxdiagram, systemoutput, table, term, tm, tt, u, uicontrol, ul, userinput, varname, wintitle, xref

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/section reference/section

Element: apiDetail

Contained by

apiPackage, apiRef

Contains

apiDef, apiDesc, apiImpl, apiSyntax, example, section

Content model

( (apiSyntax) (any number) then (apiDef) (any number) then (apiDesc) (any number) then (example or section or apiImpl) (any number))

Inheritance

topic/body reference/refbody

Element: apiImpl

Contains

apiname, b, boolean, cite, cmdname, codeblock, codeph, dl, draft-comment, fig, filepath, fn, i, image, imagemap, indexterm, indextermref, keyword, lines, lq, menucascade, msgblock, msgnum, msgph, note, object, ol, option, p, parml, parmname, ph, pre, q, required-cleanup, screen, simpletable, sl, state, sub, sup, synph, syntaxdiagram, systemoutput, table, term, tm, tt, u, uicontrol, ul, userinput, varname, wintitle, xref

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/section reference/section

Element: apiItemName

Content model

(text data) (any number)

Inheritance

topic/keyword reference/keyword

Element: apiName

Contains

apiname, b, boolean, cmdname, codeph, filepath, i, image, keyword, menucascade, msgnum, msgph, option, parmname, ph, q, state, sub, sup, synph, systemoutput, term, tm, tt, u, uicontrol, userinput, varname, wintitle

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image) (any number)

Inheritance

topic/title reference/title

Element: apiQualifier

Content model

no content

Inheritance

topic/state reference/state

Element: apiRef

Contained by

apiRef, reference, topic

Contains

apiDetail, apiName, apiRef, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiDetail) then (related-links) (optional) then (apiRef) (any number))

Inheritance

topic/topic reference/reference

Element: apiRelation

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref

Element: apiSyntax

Content model

( (apiSyntaxText) (one or more) then (apiSyntaxItem) (any number))

Inheritance

topic/section reference/refsyn

Element: apiSyntaxItem

Contained by

apiSyntax

Content model

( (apiItemName) (any number) then (apiDefNote) (optional))

Inheritance

topic/p reference/p

Element: apiSyntaxText

Contained by

apiSyntax

Contains

apiData, apiItemName, apiname, apiRelation, apiType, cmdname, draft-comment, fn, indexterm, indextermref, keyword, msgnum, option, parmname, required-cleanup, varname, wintitle

Content model

(text data or apiRelation or apiType or apiItemName or apiData or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/pre reference/pre

Element: apiType

Content model

no content

Inheritance

topic/state reference/state

Element: apiItemRef

Contained by

apiItemRef, apiMap

Contains

apiItemRef, topicmeta, topicref

Content model

( (topicmeta) (optional) then (topicref) (any number) then (apiItemRef) (any number))

Inheritance

map/topicref

Element: apiMap

Contains

apiItemRef, reltable, topicmeta

Content model

( (topicmeta) (optional) then (apiItemRef) (any number) then (reltable) (any number))

Inheritance

map/map

Element: apiPackage

Contained by

apiPackage

Contains

apiClassifier, apiDetail, apiName, apiOperation, apiPackage, apiValue, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiDetail) then (related-links) (optional) then (apiPackage or apiClassifier or apiOperation or apiValue) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef

Element: apiBaseClassifier

Contained by

apiClassifierDef

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation

Element: apiClassifier

Contains

apiClassifier, apiClassifierDetail, apiName, apiOperation, apiValue, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiClassifierDetail) then (related-links) (optional) then (apiClassifier or apiOperation or apiValue) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef

Element: apiClassifierDef

Contained by

apiClassifierDetail

Contains

apiArray, apiBaseClassifier, apiClassifierMember, apiData, apiDefNote, apiItemName, apiname, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiBaseClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiClassifierMember or apiItemName) (any number)

Inheritance

topic/section reference/section apiRef/apiDef

Element: apiClassifierDetail

Contained by

apiClassifier

Contains

apiClassifierDef, apiDesc, apiImpl, apiSyntax, example, section

Content model

( ( (apiSyntax) (any number) or (apiClassifierDef) (any number)) then (apiDesc) (any number) then (example or section or apiImpl) (any number))

Inheritance

topic/body reference/refbody apiRef/apiDetail

Element: apiClassifierMember

Contains

apiArray, apiClassifierMember, apiData, apiDefNote, apiItemName, apiname, apiOtherClassifier, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOtherClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiClassifierMember) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem

Element: apiOtherClassifier

Contained by

apiClassifierMember

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation

Element: apiValue

Contains

apiName, apiOperation, apiValue, apiValueDetail, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiValueDetail) then (related-links) (optional) then (apiOperation or apiValue) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef

Element: apiValueClassifier

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation

Element: apiValueDef

Contained by

apiValueDetail

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiQualifier, apiRelation, apiType, apiValueClassifier, apiValueMember, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiValueClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiValueMember or apiItemName) (any number)

Inheritance

topic/section reference/section apiRef/apiDef

Element: apiValueDetail

Contained by

apiValue

Contains

apiDesc, apiImpl, apiSyntax, apiValueDef, example, section

Content model

( ( (apiSyntax) (any number) or (apiValueDef) (any number)) then (apiDesc) (any number) then (example or section or apiImpl) (any number))

Inheritance

topic/body reference/refbody apiRef/apiDetail

Element: apiValueMember

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiQualifier, apiRelation, apiType, apiValueClassifier, apiValueMember, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiValueClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiValueMember) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem

Element: apiclassifier

Content model

(text data)

Inheritance

topic/xref pr-d/xref

Element: apioperation

Content model

(text data)

Inheritance

topic/xref pr-d/xref

Element: apipackage

Content model

(text data)

Inheritance

topic/xref pr-d/xref

Element: apivalue

Content model

(text data)

Inheritance

topic/xref pr-d/xref

Element: apiConstructorDef

Contained by

apiOperationDetail

Contains

apiArray, apiData, apiDefNote, apiEvent, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiParam, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiParam or apiEvent or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem or apiItemName) (any number)

Inheritance

topic/section reference/section apiRef/apiDef

Element: apiEvent

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem

Element: apiOperation

Contains

apiClassifier, apiName, apiOperation, apiOperationDetail, apiValue, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiOperationDetail) then (related-links) (optional) then (apiClassifier or apiOperation or apiValue) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef

Element: apiOperationClassifier

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation

Element: apiOperationDef

Contained by

apiOperationDetail

Contains

apiArray, apiData, apiDefNote, apiEvent, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiParam, apiQualifier, apiRelation, apiReturn, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiReturn or apiParam or apiEvent or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem or apiItemName) (any number)

Inheritance

topic/section reference/section apiRef/apiDef

Element: apiOperationDefItem

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem

Element: apiOperationDetail

Contained by

apiOperation

Content model

( ( (apiSyntax) (any number) or (apiConstructorDef) (any number) or (apiOperationDef) (any number)) then (apiDesc) (any number) then (example or section or apiImpl) (any number))

Inheritance

topic/body reference/refbody apiRef/apiDetail

Element: apiParam

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem

Element: apiReturn

Contained by

apiOperationDef

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or apiOperationDefItem) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem