mirror of
git://git.code.sf.net/p/cdesktopenv/code
synced 2025-03-09 15:50:02 +00:00
389 lines
17 KiB
Text
389 lines
17 KiB
Text
<!-- $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: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><!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
|
|
>
|
|
<!DOCTYPE helpvolume [
|
|
<!ELEMENT helpvolume - - (metainfo?,
|
|
hometopic?,
|
|
(chapter* | (s1*, rsect*)),
|
|
message?,
|
|
glossary?)
|
|
+(memo | idx) >
|
|
<!ELEMENT metainfo - - (idsection, abstract?, otherfront*)
|
|
-(footnote) >
|
|
<!ELEMENT idsection - - (title, copyright?) >
|
|
<!ELEMENT title - - (partext)
|
|
-(memo | location | idx) >
|
|
<!ELEMENT partext - - ((#PCDATA | acro | emph | computer |
|
|
user | term | var | circle |
|
|
quote | keycap | graphic | super |
|
|
sub | book | xref | footnote |
|
|
esc | link | location | newline )*) >
|
|
<!ELEMENT acro - - ((#PCDATA | esc | super | sub)*) >
|
|
<!ELEMENT emph - - (partext) -(emph) >
|
|
<!ELEMENT computer - - ((#PCDATA | quote | var | user | esc)*) >
|
|
<!ELEMENT user - - ((#PCDATA | var | esc)*) >
|
|
<!ELEMENT term - - (partext)
|
|
-(emph | computer | term | var |
|
|
quote | user | book | footnote) >
|
|
<!ATTLIST term base CDATA #IMPLIED
|
|
gloss (gloss | nogloss) gloss >
|
|
<!ELEMENT var - - ((#PCDATA | esc)*) >
|
|
<!ELEMENT circle - - CDATA >
|
|
<!ELEMENT quote - - (partext) -(quote) >
|
|
<!ELEMENT keycap - - ((#PCDATA | super | sub | esc)+) >
|
|
<!ELEMENT graphic - O EMPTY >
|
|
<!ATTLIST graphic id ID #IMPLIED
|
|
entity ENTITY #REQUIRED >
|
|
<!ELEMENT super - - (#PCDATA) >
|
|
<!ELEMENT sub - - (#PCDATA) >
|
|
<!ELEMENT book - - (partext) -(book) >
|
|
<!ELEMENT xref - O EMPTY >
|
|
<!ATTLIST xref id IDREF #REQUIRED >
|
|
<!ELEMENT footnote - - (p+) -(footnote) >
|
|
<!ELEMENT esc - - CDATA >
|
|
<!ELEMENT link - - (partext) -(link | xref) >
|
|
<!ATTLIST link hyperlink CDATA #REQUIRED
|
|
type (jump |
|
|
jumpnewview |
|
|
definition |
|
|
execute |
|
|
appdefined |
|
|
man) jump
|
|
description CDATA #IMPLIED >
|
|
<!ELEMENT location - - (partext) -(location) >
|
|
<!ATTLIST location id ID #REQUIRED >
|
|
<!ELEMENT copyright - - (text)
|
|
-(memo | location | idx) >
|
|
<!ELEMENT text - - ((p | note | caution | warning |
|
|
lablist | list | ex | vex |
|
|
esc | otherhead | procedure | syntax |
|
|
figure | image )*) >
|
|
<!ELEMENT p - - (head?, partext)
|
|
+(newline) >
|
|
<!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 >
|
|
<!ELEMENT head - - (partext)
|
|
-(memo | location | idx) >
|
|
<!ELEMENT newline - O EMPTY >
|
|
<!ELEMENT (note |
|
|
caution |
|
|
warning) - - (head?, text)
|
|
-(note | caution | warning | footnote) >
|
|
<!ELEMENT lablist - - (head?, labheads?, lablistitem+) >
|
|
<!ATTLIST lablist spacing (loose | tight) loose
|
|
longlabel (wrap | nowrap) wrap >
|
|
<!ELEMENT labheads - - (labh, labhtext)
|
|
-(memo | location | idx) >
|
|
<!ELEMENT labh - - (partext) >
|
|
<!ELEMENT labhtext - - (partext) >
|
|
<!ELEMENT lablistitem - - (label, text) >
|
|
<!ELEMENT label - - (partext) >
|
|
<!ELEMENT list - - (head?, item+) >
|
|
<!ATTLIST list type (order |
|
|
bullet |
|
|
plain |
|
|
check) bullet
|
|
ordertype (ualpha |
|
|
lalpha |
|
|
arabic |
|
|
uroman |
|
|
lroman) arabic
|
|
spacing (tight |
|
|
loose) tight
|
|
continue (continue) #IMPLIED >
|
|
<!ELEMENT item - - (text) >
|
|
<!ATTLIST item id ID #IMPLIED >
|
|
<!ELEMENT ex - - (head?, (exampleseg, annotation?)+)
|
|
-(ex |
|
|
vex |
|
|
note |
|
|
caution |
|
|
warning |
|
|
syntax |
|
|
footnote) >
|
|
<!ATTLIST ex notes (side | stack) side
|
|
lines (number |
|
|
nonumber) nonumber
|
|
textsize (normal |
|
|
smaller |
|
|
smallest) normal >
|
|
<!ELEMENT exampleseg - - (partext) +(lineno) >
|
|
<!ELEMENT annotation - - (partext) +(newline) >
|
|
<!ELEMENT lineno - O EMPTY >
|
|
<!ATTLIST lineno id ID #IMPLIED >
|
|
<!ELEMENT vex - - CDATA >
|
|
<!ATTLIST vex lines (number |
|
|
nonumber) nonumber
|
|
textsize (normal |
|
|
smaller |
|
|
smallest) normal >
|
|
<!ELEMENT otherhead - - (head, text?) >
|
|
<!ELEMENT procedure - - (chaphead, text?)
|
|
-(procedure) >
|
|
<!ELEMENT chaphead - - (head, abbrev?)
|
|
-(memo | location | idx | footnote) >
|
|
<!ELEMENT abbrev - - (partext) -(footnote) >
|
|
<!ELEMENT syntax - - (head?, synel) >
|
|
<!ELEMENT synel - - ((#PCDATA | esc | var |
|
|
optblock | reqblock )+) >
|
|
<!ELEMENT (optblock |
|
|
reqblock) - - (synel+) >
|
|
<!ELEMENT figure - - (caption?)
|
|
-(figure | graphic) >
|
|
<!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 >
|
|
<!ELEMENT caption - - (partext, abbrev?)
|
|
-(memo | location | idx) >
|
|
<!ELEMENT image - - (head?, partext) -(footnote) >
|
|
<!ELEMENT abstract - - (head?, text?, frontsub*) >
|
|
<!ELEMENT frontsub - - (head?, text) >
|
|
<!ELEMENT otherfront - - (head?, text?, frontsub*) >
|
|
<!ATTLIST otherfront id ID #IMPLIED >
|
|
<!ELEMENT hometopic - - (chaphead, text?) >
|
|
<!ELEMENT chapter - - (chaphead, text?, (s1*, rsect*)) >
|
|
<!ATTLIST (chapter |
|
|
s1 |
|
|
s2 |
|
|
s3 |
|
|
s4 |
|
|
s5 |
|
|
s6 |
|
|
s7 |
|
|
s8 |
|
|
s9) id ID #IMPLIED >
|
|
<!ELEMENT s1 - - (chaphead, text?, s2*, rsect*) >
|
|
<!ELEMENT s2 - - (chaphead, text?, s3*, rsect*) >
|
|
<!ELEMENT s3 - - (chaphead, text?, s4*, rsect*) >
|
|
<!ELEMENT s4 - - (chaphead, text?, s5*, rsect*) >
|
|
<!ELEMENT s5 - - (chaphead, text?, s6*, rsect*) >
|
|
<!ELEMENT s6 - - (chaphead, text?, s7*, rsect*) >
|
|
<!ELEMENT s7 - - (chaphead, text?, s8*, rsect*) >
|
|
<!ELEMENT s8 - - (chaphead, text?, s9*, rsect*) >
|
|
<!ELEMENT s9 - - (chaphead, text?) >
|
|
<!ELEMENT rsect - - (chaphead, text?, rsub*) >
|
|
<!ATTLIST rsect id ID #IMPLIED >
|
|
<!ELEMENT rsub - - (chaphead, text?) >
|
|
<!ELEMENT message - - (chaphead?, text?, (msg+ | msgsub+)) >
|
|
<!ELEMENT msg - - (msgnum?, msgtext, explain?) +(newline) >
|
|
<!ELEMENT msgnum - - ((#PCDATA | esc)+) >
|
|
<!ELEMENT msgtext - - (partext) >
|
|
<!ELEMENT explain - - (text) >
|
|
<!ELEMENT msgsub - - (chaphead, text?, msg+) >
|
|
<!ELEMENT glossary - - (text?, glossent+) >
|
|
<!ELEMENT glossent - - (dterm, definition) >
|
|
<!ELEMENT dterm - - (partext) -(term) >
|
|
<!ELEMENT definition - - (text) >
|
|
<!ELEMENT idx - - (indexprimary, indexsub?)
|
|
-(term | footnote | location | idx) >
|
|
<!ELEMENT indexprimary - - (partext, sort?) >
|
|
<!ELEMENT indexsub - - (partext, sort?) >
|
|
<!ELEMENT sort - - ((#PCDATA | esc)+) >
|
|
<!ELEMENT memo - - CDATA >
|
|
<!ENTITY MINUS SDATA "-">
|
|
<!ENTITY PM SDATA '[plusmn]'> <!-- ISOnum -->
|
|
<!ENTITY DIV SDATA '[divide]'> <!-- ISOnum -->
|
|
<!ENTITY TIMES SDATA '[times ]'> <!-- ISOnum -->
|
|
<!ENTITY LEQ SDATA '[le ]'> <!-- ISOtech -->
|
|
<!ENTITY GEQ SDATA '[ge ]'> <!-- ISOtech -->
|
|
<!ENTITY NEQ SDATA '[ne ]'> <!-- ISOtech -->
|
|
<!ENTITY COPY SDATA '[copy ]'> <!-- ISOnum -->
|
|
<!ENTITY REG SDATA '[reg ]'> <!-- ISOnum -->
|
|
<!ENTITY TM SDATA '[trade ]'> <!-- ISOnum -->
|
|
<!ENTITY ELLIPSIS SDATA '[hellip]'> <!-- ISOpub -->
|
|
<!ENTITY VELLIPSIS SDATA '[vellip]'> <!-- ISOpub -->
|
|
<!ENTITY PELLIPSIS SDATA "...."> <!-- ellipsis followed by a period -->
|
|
<!ENTITY A.M. SDATA "a.m.">
|
|
<!ENTITY P.M. SDATA "p.m.">
|
|
<!ENTITY MINUTES SDATA '[prime ]'> <!-- ISOtech -->
|
|
<!ENTITY SECONDS SDATA '[Prime ]'> <!-- ISOtech -->
|
|
<!ENTITY DEG SDATA '[deg ]'> <!-- ISOnum -->
|
|
<!ENTITY SQUOTE SDATA "`">
|
|
<!ENTITY DQUOTE SDATA '"'>
|
|
<!ENTITY ENDASH SDATA "-">
|
|
<!ENTITY EMDASH SDATA '[mdash ]'> <!-- ISOpub -->
|
|
<!ENTITY VBLANK SDATA "_">
|
|
<!ENTITY CENTS SDATA '[cent ]'> <!-- ISOnum -->
|
|
<!ENTITY STERLING SDATA '[pound ]'> <!-- ISOnum -->
|
|
<!ENTITY SPACE SDATA " ">
|
|
<!ENTITY SIGSPACE SDATA "& ">
|
|
<!ENTITY SIGDASH SDATA "&-">
|
|
<!ENTITY MICRO SDATA '[micro ]'> <!-- ISOnum -->
|
|
<!ENTITY OHM SDATA '[ohm ]'> <!-- ISOnum -->
|
|
<!ENTITY UP SDATA '[uarr ]'> <!-- ISOnum -->
|
|
<!ENTITY DOWN SDATA '[darr ]'> <!-- ISOnum -->
|
|
<!ENTITY LEFT SDATA '[larr ]'> <!-- ISOnum -->
|
|
<!ENTITY RIGHT SDATA '[rarr ]'> <!-- ISOnum -->
|
|
<!ENTITY HOME SDATA "home key">
|
|
<!ENTITY BACK SDATA "<--">
|
|
<!ENTITY HALFSPACE SDATA " ">
|
|
<!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-->
|