CDE/cde/doc/C/guides/man/man4/dthelpta.sgm

<!-- $XConsortium: dthelpta.sgm /main/6 1996/09/08 20:18:06 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMX.MAN96.rsml.1">
<RefMeta>
<RefEntryTitle>dthelptagdtd</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dthelptagdtd</Filename></RefName>
<RefPurpose>markup syntax specification for authored &str-XZ; help information
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- **  (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- **  (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- **  (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- **  (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>The
<Emphasis>HelpTag</Emphasis> markup syntax (ISO 8879: 1986) SGML.
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Emphasis>HelpTag</Emphasis> is a markup
language used for authoring &str-XZ; help volumes.
It is based on the ISO 8879:&thinsp;1986 Standard Generalized Markup Language
(SGML) standard and is defined with the following
Document Type Description (DTD).
</Para>
<Para>The HelpTag marked-up help information is part of the source code
for a conforming &str-XZ; application.
The compilation process that is required to install
this information into help volumes for the &str-XZ; help services
is implementation dependent.
</Para>
</RefSect1>
<RefSect1>
<Title>SGML DECLARATION</Title>
<InformalExample>
<ProgramListing>&lt;!SGML "ISO 8879:1986"
CHARSET
BASESET "ISO 646-1983//CHARSET International Reference Version
          (IRV)//ESC 2/5 4/0"
DESCSET      0        9      UNUSED
             9        2      9
            11        2      UNUSED
            13        1      13
            14       18      UNUSED
            32       95      32
           127        1      UNUSED
BASESET "ISO Registration Number 100//CHARSET ECMA-94
          Right Part of Latin Alphabet  Nr. 1//ESC  2/13  4/1"
DESCSET    128       32      UNUSED
           160        5      32
           165        1      UNUSED
           166       88      38
           254        1      127
           255        1      UNUSED
CAPACITY SGMLREF
    TOTALCAP 350000
    ENTCAP   100000
    ENTCHCAP  50000
    ELEMCAP   50000
    GRPCAP   210000
    EXGRPCAP  50000
    EXNMCAP   50000
    ATTCAP    50000
    ATTCHCAP  50000
    AVGRPCAP  50000
    NOTCAP    50000
    NOTCHCAP  50000
    IDCAP     50000
    IDREFCAP  50000
    MAPCAP   210000
    LKSETCAP  50000
    LKNMCAP   50000
SCOPE DOCUMENT
SYNTAX -- The Core Reference Syntax except with ATTCNT, LITLEN, NAMELEN,
          GRPCNT, and GRPGTCNT changed --
SHUNCHAR CONTROLS   0   1   2   3   4   5   6   7   8   9
                   10  11  12  13  14  15  16  17  18  19
                   20  21  22  23  24  25  26  27  28  29
                   30  31 127 255
BASESET "ISO 646-1983//CHARSET International Reference Version
          (IRV)//ESC 2/5 4/0"
DESCSET      0      128      0
FUNCTION     RE      13
             RS      10
             SPACE   32
             TAB     SEPCHAR    9
NAMING
   LCNMSTRT ""
   UCNMSTRT ""
   LCNMCHAR "-."
   UCNMCHAR "-."
   NAMECASE
      GENERAL YES
      ENTITY  YES
DELIM
   GENERAL  SGMLREF
   SHORTREF SGMLREF -- Removed short references --
   NAMES    SGMLREF
   QUANTITY SGMLREF
       ATTCNT    140
       LITLEN   4096
       NAMELEN    64
       GRPCNT    100
       GRPGTCNT  253
       TAGLVL     48
FEATURES
    MINIMIZE
        DATATAG    NO
        OMITTAG    NO
        RANK       NO
        SHORTTAG   YES
    LINK
        SIMPLE     NO
        IMPLICIT   NO
        EXPLICIT   NO
    OTHER
        CONCUR     NO
        SUBDOC     NO
        FORMAL     NO
        APPINFO  NONE
>
&lt;!DOCTYPE helpvolume [
&lt;!ELEMENT helpvolume   - - (metainfo?,
                            hometopic?,
                            (chapter* | (s1*, rsect*)),
                            message?,
                            glossary?)
                           +(memo | idx) >
&lt;!ELEMENT metainfo     - - (idsection, abstract?, otherfront*)
                           -(footnote) >
&lt;!ELEMENT idsection    - - (title, copyright?) >
&lt;!ELEMENT title        - - (partext)
                           -(memo | location | idx) >
&lt;!ELEMENT partext      - - ((#PCDATA | acro   | emph     | computer |
                             user    | term   | var      | circle   |
                             quote   | keycap | graphic  | super    |
                             sub     | book   | xref     | footnote |
                             esc     | link   | location | newline  )*) >
&lt;!ELEMENT acro         - - ((#PCDATA | esc | super | sub)*) >
&lt;!ELEMENT emph         - - (partext) -(emph) >
&lt;!ELEMENT computer     - - ((#PCDATA | quote | var | user | esc)*) >
&lt;!ELEMENT user         - - ((#PCDATA | var | esc)*) >
&lt;!ELEMENT term         - - (partext)
                           -(emph  | computer | term | var     |
                             quote | user     | book | footnote) >
&lt;!ATTLIST term             base         CDATA             #IMPLIED
                           gloss        (gloss | nogloss) gloss >
&lt;!ELEMENT var          - - ((#PCDATA | esc)*) >
&lt;!ELEMENT circle       - - CDATA >
&lt;!ELEMENT quote        - - (partext) -(quote) >
&lt;!ELEMENT keycap       - - ((#PCDATA | super | sub | esc)+) >
&lt;!ELEMENT graphic      - O EMPTY >
&lt;!ATTLIST graphic          id           ID                #IMPLIED
                           entity       ENTITY            #REQUIRED >
&lt;!ELEMENT super        - - (#PCDATA) >
&lt;!ELEMENT sub          - - (#PCDATA) >
&lt;!ELEMENT book         - - (partext) -(book) >
&lt;!ELEMENT xref         - O EMPTY >
&lt;!ATTLIST xref             id           IDREF             #REQUIRED >
&lt;!ELEMENT footnote     - - (p+) -(footnote) >
&lt;!ELEMENT esc          - - CDATA >
&lt;!ELEMENT link         - - (partext) -(link | xref) >
&lt;!ATTLIST link             hyperlink    CDATA             #REQUIRED
                           type         (jump        |
                                         jumpnewview |
                                         definition  |
                                         execute     |
                                         appdefined  |
                                         man)    jump
                            description CDATA             #IMPLIED >
&lt;!ELEMENT location     - - (partext) -(location) >
&lt;!ATTLIST location         id           ID                #REQUIRED >
&lt;!ELEMENT copyright    - - (text)
                            -(memo | location | idx) >
&lt;!ELEMENT text         - - ((p       | note      | caution   | warning |
                             lablist | list      | ex        | vex     |
                             esc     | otherhead | procedure | syntax  |
                             figure  | image     )*) >
&lt;!ELEMENT p            - - (head?, partext)
                           +(newline) >
&lt;!ATTLIST (p | image)      indent       (indent)          #IMPLIED
                           id           ID                #IMPLIED
                           gentity      ENTITY            #IMPLIED
                           gposition    (left | right)    left
                           ghyperlink   CDATA             #IMPLIED
                           glinktype    (jump        |
                                         jumpnewview |
                                         definition  |
                                         execute     |
                                         appdefined  |
                                         man)    jump
                           gdescription CDATA             #IMPLIED >
&lt;!ELEMENT head         - - (partext)
                           -(memo | location | idx) >
&lt;!ELEMENT newline      - O EMPTY >
&lt;!ELEMENT (note    |
           caution |
           warning)   - - (head?, text)
                            -(note | caution | warning | footnote) >
&lt;!ELEMENT lablist      - - (head?, labheads?, lablistitem+) >
&lt;!ATTLIST lablist          spacing      (loose | tight)   loose
                           longlabel    (wrap  | nowrap)  wrap >
&lt;!ELEMENT labheads     - - (labh, labhtext)
                           -(memo | location | idx) >
&lt;!ELEMENT labh         - - (partext) >
&lt;!ELEMENT labhtext     - - (partext) >
&lt;!ELEMENT lablistitem  - - (label, text) >
&lt;!ELEMENT label        - - (partext) >
&lt;!ELEMENT list         - - (head?, item+) >
&lt;!ATTLIST list             type         (order   |
                                         bullet  |
                                         plain   |
                                         check)        bullet
                           ordertype    (ualpha  |
                                         lalpha  |
                                         arabic  |
                                         uroman  |
                                         lroman)        arabic
                           spacing      (tight   |
                                         loose)        tight
                           continue     (continue)        #IMPLIED >
&lt;!ELEMENT item         - - (text) >
&lt;!ATTLIST item             id           ID                #IMPLIED >
&lt;!ELEMENT ex           - - (head?, (exampleseg, annotation?)+)
                           -(ex      |
                             vex     |
                             note    |
                             caution |
                             warning |
                             syntax  |
                             footnote) >
&lt;!ATTLIST ex               notes        (side | stack)    side
                           lines        (number   |
                                         nonumber)       nonumber
                           textsize     (normal   |
                                         smaller  |
                                         smallest)       normal >
&lt;!ELEMENT exampleseg   - - (partext) +(lineno) >
&lt;!ELEMENT annotation   - - (partext) +(newline) >
&lt;!ELEMENT lineno       - O EMPTY >
&lt;!ATTLIST lineno           id           ID                #IMPLIED >
&lt;!ELEMENT vex          - - CDATA >
&lt;!ATTLIST vex              lines        (number   |
                                         nonumber)       nonumber
                           textsize     (normal   |
                                         smaller  |
                                         smallest)       normal >
&lt;!ELEMENT otherhead    - - (head, text?) >
&lt;!ELEMENT procedure    - - (chaphead, text?)
                           -(procedure) >
&lt;!ELEMENT chaphead     - - (head, abbrev?)
                           -(memo | location | idx | footnote) >
&lt;!ELEMENT abbrev       - - (partext) -(footnote) >
&lt;!ELEMENT syntax       - - (head?, synel) >
&lt;!ELEMENT synel        - - ((#PCDATA | esc | var |
                            optblock | reqblock  )+) >
&lt;!ELEMENT (optblock |
           reqblock)  - - (synel+) >
&lt;!ELEMENT figure       - - (caption?)
                           -(figure | graphic) >
&lt;!ATTLIST figure           number       NUMBER            #IMPLIED
                           tonumber     (number  |
                                         nonumber)        number
                           id           ID                #IMPLIED
                           entity       ENTITY            #REQUIRED
                           figpos       (left   |
                                         center |
                                         right)         #IMPLIED
                           cappos       (capleft   |
                                         capcenter |
                                         capright)      #IMPLIED
                           ghyperlink   CDATA             #IMPLIED
                           glinktype    (jump        |
                                         jumpnewview |
                                         definition  |
                                         execute     |
                                         appdefined  |
                                         man)    jump
                           gdescription CDATA             #IMPLIED >
&lt;!ELEMENT caption      - - (partext, abbrev?)
                           -(memo | location | idx) >
&lt;!ELEMENT image        - - (head?, partext) -(footnote) >
&lt;!ELEMENT abstract     - - (head?, text?, frontsub*) >
&lt;!ELEMENT frontsub     - - (head?, text) >
&lt;!ELEMENT otherfront   - - (head?, text?, frontsub*) >
&lt;!ATTLIST otherfront       id           ID                #IMPLIED >
&lt;!ELEMENT hometopic    - - (chaphead, text?) >
&lt;!ELEMENT chapter      - - (chaphead, text?, (s1*, rsect*)) >
&lt;!ATTLIST (chapter |
           s1      |
           s2      |
           s3      |
           s4      |
           s5      |
           s6      |
           s7      |
           s8      |
           s9)       id           ID                #IMPLIED >
&lt;!ELEMENT s1           - - (chaphead, text?, s2*, rsect*) >
&lt;!ELEMENT s2           - - (chaphead, text?, s3*, rsect*) >
&lt;!ELEMENT s3           - - (chaphead, text?, s4*, rsect*) >
&lt;!ELEMENT s4           - - (chaphead, text?, s5*, rsect*) >
&lt;!ELEMENT s5           - - (chaphead, text?, s6*, rsect*) >
&lt;!ELEMENT s6           - - (chaphead, text?, s7*, rsect*) >
&lt;!ELEMENT s7           - - (chaphead, text?, s8*, rsect*) >
&lt;!ELEMENT s8           - - (chaphead, text?, s9*, rsect*) >
&lt;!ELEMENT s9           - - (chaphead, text?) >
&lt;!ELEMENT rsect        - - (chaphead, text?, rsub*) >
&lt;!ATTLIST rsect            id           ID                #IMPLIED >
&lt;!ELEMENT rsub         - - (chaphead, text?) >
&lt;!ELEMENT message      - - (chaphead?, text?, (msg+ | msgsub+)) >
&lt;!ELEMENT msg          - - (msgnum?, msgtext, explain?) +(newline) >
&lt;!ELEMENT msgnum       - - ((#PCDATA | esc)+) >
&lt;!ELEMENT msgtext      - - (partext) >
&lt;!ELEMENT explain      - - (text) >
&lt;!ELEMENT msgsub       - - (chaphead, text?, msg+) >
&lt;!ELEMENT glossary     - - (text?, glossent+) >
&lt;!ELEMENT glossent     - - (dterm, definition) >
&lt;!ELEMENT dterm        - - (partext) -(term) >
&lt;!ELEMENT definition   - - (text) >
&lt;!ELEMENT idx          - - (indexprimary, indexsub?)
                           -(term | footnote | location | idx) >
&lt;!ELEMENT indexprimary - - (partext, sort?) >
&lt;!ELEMENT indexsub     - - (partext, sort?) >
&lt;!ELEMENT sort         - - ((#PCDATA | esc)+) >
&lt;!ELEMENT memo         - - CDATA >
&lt;!ENTITY MINUS     SDATA "-">
&lt;!ENTITY PM        SDATA '[plusmn]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY DIV       SDATA '[divide]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY TIMES     SDATA '[times ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY LEQ       SDATA '[le    ]'>    &lt;!-- ISOtech -->
&lt;!ENTITY GEQ       SDATA '[ge    ]'>    &lt;!-- ISOtech -->
&lt;!ENTITY NEQ       SDATA '[ne    ]'>    &lt;!-- ISOtech -->
&lt;!ENTITY COPY      SDATA '[copy  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY REG       SDATA '[reg   ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY TM        SDATA '[trade ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY ELLIPSIS  SDATA '[hellip]'>    &lt;!-- ISOpub  -->
&lt;!ENTITY VELLIPSIS SDATA '[vellip]'>    &lt;!-- ISOpub  -->
&lt;!ENTITY PELLIPSIS SDATA "....">  &lt;!-- ellipsis followed by a period -->
&lt;!ENTITY A.M.      SDATA "a.m.">
&lt;!ENTITY P.M.      SDATA "p.m.">
&lt;!ENTITY MINUTES   SDATA '[prime ]'>    &lt;!-- ISOtech -->
&lt;!ENTITY SECONDS   SDATA '[Prime ]'>    &lt;!-- ISOtech -->
&lt;!ENTITY DEG       SDATA '[deg   ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY SQUOTE    SDATA "`">
&lt;!ENTITY DQUOTE    SDATA '"'>
&lt;!ENTITY ENDASH    SDATA "-">
&lt;!ENTITY EMDASH    SDATA '[mdash ]'>    &lt;!-- ISOpub  -->
&lt;!ENTITY VBLANK    SDATA "_">
&lt;!ENTITY CENTS     SDATA '[cent  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY STERLING  SDATA '[pound ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY SPACE     SDATA " ">
&lt;!ENTITY SIGSPACE  SDATA "&amp; ">
&lt;!ENTITY SIGDASH   SDATA "&amp;-">
&lt;!ENTITY MICRO     SDATA '[micro ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY OHM       SDATA '[ohm   ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY UP        SDATA '[uarr  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY DOWN      SDATA '[darr  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY LEFT      SDATA '[larr  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY RIGHT     SDATA '[rarr  ]'>    &lt;!-- ISOnum  -->
&lt;!ENTITY HOME      SDATA "home key">
&lt;!ENTITY BACK      SDATA "&lt;--">
&lt;!ENTITY HALFSPACE SDATA " ">
&lt;!ENTITY % user-defined-entities SYSTEM "helptag.ent">
%user-defined-entities;
] >
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtHelpDialog;, &cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpReturnSelectedWidgetId;, &cdeman.DtHelpDialog;, &cdeman.DtHelpQuickDialog;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->