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

<!-- $XConsortium: dtsdlfil.sgm /main/5 1996/08/31 14:56: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.MAN85.rsml.1">
<RefMeta>
<RefEntryTitle>dtsdlfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtsdlfile</Filename></RefName>
<RefPurpose>CDE runtime help volume files
</RefPurpose>
</RefNameDiv>
<!-- *************************************************************************-->
<!-- **  (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- **  (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- **  (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Semantic Delivery Language (sdl) files are used for presenting online
information or application specific contextual help information in CDE.
They
are referred to as Help Volumes, and contain the equivalent of a runtime
version of the original, authored help information.
Help Volumes can be
viewed via one of the two CDE help dialog widgets provided as part of the CDE
Development Environment.
</Para>
<RefSect2>
<Title>File Generation</Title>
<Para>Refer to the
&cdeman.dthelptag; man page for detailed information on the creation of <Filename>*.sdl</Filename> files within CDE.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The CDE Help system uses two environment variables for locating
Help volumes and Family files
within the desktop environment:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>DTHELPSEARCHPATH</Emphasis></Term>
<ListItem>
<Para><Emphasis>System</Emphasis> search path environment variable for locating
Help volumes on local and/or remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTHELPUSERSEARCHPATH</Emphasis></Term>
<ListItem>
<Para><Emphasis>Users</Emphasis> search path environment variable for locating user
specific Help volumes on local and/or remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The environment variables contain colon-separated lists of directory paths.
Each directory path can contain environment variable names as well as
special field descriptors that are expanded at runtime.
</Para>
<Para>Field descriptors consist of a <Literal>%</Literal>
followed by a single character.
Field descriptors and their substitution values are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>%H</Literal></Term>
<ListItem>
<Para>This value is replaced with the current volume or Family name being searched
for.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%L</Literal></Term>
<ListItem>
<Para>Replaced with the current value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%%</Literal></Term>
<ListItem>
<Para>Replaced with a single <Literal>%</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The default value for
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> is:
</Para>
<Para><Filename>$HOME/.dt/help/$DTUSERSESSION/%H:$HOME/.dt/help/$DTUSERSESSION/%H.sdl:$HOME/.dt/help/$DTUSERSESSION/%H.hv:$HOME/.dt/help/%H:$HOME/.dt/help/%H.sdl:$HOME/.dt/help/%H.hv</Filename>
</Para>
<Para>The
<Emphasis>DTHELPUSERSEARCH</Emphasis> is first searched for the requested volume.
If
the volume is not found, the
<Emphasis>DTHELPSEARCHPATH</Emphasis> value is searched.
</Para>
<Para>The default value for
<Emphasis>DTHELPSEARCHPATH</Emphasis> path is:
</Para>
<Para><Filename>/etc/dt/appconfig/help/%L/%H:/etc/dt/appconfig/help/%L/%H.sdl:/etc/dt/appconfig/help/%L/%H.hv:/etc/dt/appconfig/help/C/%H:/etc/dt/appconfig/help/C/%H.sdl:/etc/dt/appconfig/help/C/%H.hv:/usr/dt/appconfig/help/%L/%H:/usr/dt/appconfig/help/%L/%H.sdl:/usr/dt/appconfig/help/%L/%H.hv:/usr/dt/appconfig/help/C/%H:/usr/dt/appconfig/help/C/%H.sdl:/usr/dt/appconfig/help/C/%H.hv</Filename>
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtCreateHelpDialog;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.dthelptag;, <Emphasis>CDE Help System Author's and Programmer's Guide</Emphasis>
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->