The Heading DTD

The elements in this DTD describe an index browse display or a record browse display in the WebPAC.

NOTE

The output from the XML Server is a combination of WebPAC page and record data. XML records are defined by the record DTD.

The heading DTD is as follows:

<!ELEMENT WXROOT (NullResult | (UserMessage?, PAGEINFO, Heading*)) >

<!ELEMENT NullResult (UserMessage) >

<!ELEMENT UserMessage (#PCDATA) >

<!ELEMENT PAGEINFO (WXREQ_ROOT, GROUPCOUNT, ENTRYCOUNT, METHOD, SCOPEINDEX, SCOPEMASK, SCOPENAME,
    NEXTPAGEURL?, PREVPAGEURL?, PREVSRCHSTACK?) >

<!ENTITY % wxreq SYSTEM "/dtd/WXREQ_ROOT.dtd" >
%wxreq;

<!ELEMENT GROUPCOUNT (#PCDATA) >
<!ELEMENT ENTRYCOUNT (#PCDATA) >
<!ELEMENT METHOD (#PCDATA) >
<!ELEMENT SCOPEINDEX (#PCDATA) >
<!ELEMENT SCOPEMASK (#PCDATA) >
<!ELEMENT SCOPENAME (#PCDATA) >
<!ELEMENT NEXTPAGEURL (#PCDATA) >
<!ELEMENT PREVPAGEURL (#PCDATA) >
<!ELEMENT PREVSRCHSTACK (PREVSRCHURL)+ >
<!ELEMENT PREVSRCHURL (#PCDATA) >

<!ELEMENT Heading ((HeadingSeq, HeadingEntry, HeadingText, HeadingSize, TitleCount,
    HeadingField, Title*) | YourEntry | NullResult) >

<!ELEMENT HeadingSeq (#PCDATA) >
<!ELEMENT HeadingEntry (#PCDATA) >
<!ELEMENT HeadingText (#PCDATA) >
<!ELEMENT HeadingSize (#PCDATA) >
<!ELEMENT TitleCount (#PCDATA) >
<!ELEMENT HeadingField (VARFLDPRIMARYALTERNATEPAIR?) >

<!ELEMENT Title (AvsRank?, TitleSeq, TitleText, TitleField, PubYear, RecordId, IIIRECORD?) >

<!ELEMENT AvsRank (#PCDATA) >
<!ELEMENT TitleSeq (#PCDATA) >
<!ELEMENT TitleText (#PCDATA) >
<!ELEMENT TitleField (VARFLDPRIMARYALTERNATEPAIR?) >
<!ELEMENT VARFLDPRIMARYALTERNATEPAIR ((VARFLDPRIMARY?) | (VARFLDPRIMARY, VARFLDALTERNATE)) >
<!ELEMENT VARFLDPRIMARY (VARFLD) >
<!ELEMENT VARFLDALTERNATE (VARFLD) >
<!ELEMENT PubYear (#PCDATA) >
<!ELEMENT YourEntry (#PCDATA) >

<!ENTITY % IIIRecordEntity SYSTEM "/dtd/iiirecord.dtd" >
%IIIRecordEntity;

Explanation of the Heading DTD Elements

Element Explanation Attributes Required
WXROOT The WXROOT element contains either
  • NullResult
  • UserMessage, PAGEINFO, and one or more Heading elements

    UserMessage is not required, but PAGEINFO and Heading are required.
None. Yes.
NullResult The NullResult element, if present, contains the UserMessage element.
NullResult typically is used in the event that the XML Server cannot retrieve results in response to a request. 		None. NullResult is required if PAGEINFO and Heading are absent.
UserMessage The UserMessage element, if present, is character data.
UserMessage is typically used to display a message in the event that the XML Server cannot retrieve results in response to a request. 		None. Yes.
PAGEINFO The WXREQ_ROOT, GROUPCOUNT, ENTRYCOUNT, METHOD, SCOPEINDEX, SCOPEMASK, SCOPENAME, NEXTPAGEURL, PREVPAGEURL, and PREVSRCHSTACK comprise the PAGEINFO element.

EXTPAGEURL, PREVPAGEURL, and PREVSRCHSTACK are not required. 		None. PAGEINFO is required if NullResult is absent.
WXREQ_ROOT This ENTITY is defined by the XML Request DTD. N/A. Yes.
GROUPCOUNT This element is character data. It is typically used to indicate the number of index entries retrieved. None. Yes.
ENTRYCOUNT This element is character data. It is typically used to indicate the number of titles retrieved. None. Yes.
METHOD This element is character data. It is typically used to indicate the method. None. Yes.
SCOPEINDEX This element is character data. It is typically used to indicate the scope number. None. Yes.
SCOPENAME This element is character data. It is typically used to indicate the scope name. None. Yes.
NEXTPAGEURL Not used. None. No.
PREVPAGEURL Not used. None. No.
PREVSRCHSTACK Not used. None. No.
PREVSRCHURL Not used. None. No.
Heading Headings and index entries are the same thing. The Heading element is composed of either:
  • HeadingSeq, HeadingEntry, HeadingText, HeadingSize, TitleCount, and one or more Title elements
  • a YourEntry element
  • a NullResult element
 None. Heading is required if NullResult is absent.
HeadingSeq This element is character data. It is typically used for a number indicating the heading's position in a sequential list of headings. None. Yes.
HeadingEntry This element is character data. It is typically used for a standardized index entry (an index entry with the punctuation, capitalization, etc. standardized according to rules on the system.) None. Yes.
HeadingText This element is character data. It is typically used for the heading text. None. Yes.
HeadingSize This element is character data. It is typically used for the total number of titles in a heading. None. Yes.
TitleCount This element is character data. It is typically used for the number of titles retrieved. None. Yes.
Title The Title element is comprised of AvsRank, TitleSeq, TitleText, PubYear, RecordId, and IIIRecord. There can be multiple Title elements. None. Yes.
AvsRank This element is character data. It is typically used for the method of ranking retrieved results (such as by date or relevance). None. Yes.
TitleSeq This element is character data. It is typically used for a number indicating the title's position in a sequential list. None. Yes.
TitleText This element is character data. It is typically used for the title text. None. Yes.
PubYear This element is character data. It is typically used for the year of publication. None. Yes.
YourEntry This element is character data. It is typically used to indicate that your retrieved record, if it existed, would appear in this position in the WebPAC. None. This element is required if NullResult and Heading are absent.
IIIRecordEntity This ENTITY is defined by the iiirecords DTD. None. Yes.