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

<!-- $XConsortium: genloc.sgm /main/2 1996/09/20 11:11:57 cdedoc $ -->
<!-- (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. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDE.INFO.genlocformat">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.INFO.genlocformat">]]>

<RefMeta>
<RefEntryTitle>Generalized Locator Format</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>

<RefNameDiv>
<RefName>Generalized Locator Format</RefName>
<RefPurpose>address infolibs as document collections with external navigation references
</RefPurpose>
</RefNameDiv>

<RefSynopsisDiv>
<Synopsis>
&lt;GLF> ::= &lt;MMDB> | &lt;ULV> | &lt;URI>

&lt;MMDB> ::= mmdb:  &lt;IBL> | &lt;IB> | &lt;IL> | &lt;INFOLIB> | &lt;BL> | &lt;BOOKCASE> |
           &lt;LOCATOR>

&lt;IBL> ::= &lt;INFOLIB> & &lt;BOOKCASE> & &lt;LOCATOR>

&lt;IB> ::= &lt;INFOLIB> & &lt;BOOKCASE>

&lt;IL> ::= &lt;INFOLIB> & &lt;LOCATOR>

&lt;BL> ::= &lt;BOOKCASE> & &lt;LOCATOR>

&lt;INFOLIB> ::= INFOLIB= &lt;NAME>

&lt;BOOKCASE> ::= BOOKCASE= &lt;NAME>

&lt;LOCATOR> ::= LOCATOR= &lt;ULV> &lt;NAME>

&lt;ULV> ::= uuid_ | xsm_ | isbn_

&lt;NAME> ::= &lt;CHAR> { &lt;CHAR> )

&lt;CHAR> ::= a-z | A-Z | 0-9 | &lt;SPECIAL_CHAR>

&lt;SPECIAL_CHAR> ::= everything but ":" and "&"

&lt;URI> ::= Uniform Resource Identifier (as defined by the Web Consortium)
</Synopsis>
</RefSynopsisDiv>

<RefSect1>
<Title>DESCRIPTION</Title>

<Para>
For the purpose of addressing infolibs as document collections with external navigation references, a generalized 
locator format is defined for use in applications and by the end-user. This mechanism is more precise than those that 
operate on the DtInfoLib level. This mechanism can be used by applications that want to tightly integrate to their on-
line documentation, within the action system, or for printing specific sections from a command line. 
The syntax of a generalized locator format string is defined above.
</Para>
<Para>
As shown above, there are several reserved terms that are used to identify locator format including 
<literal>uuid</literal> (for DCE 
style Unique ID), <literal>xsm</literal> (for XSession Manager style Unique ID), and 
<literal>ISBN</literal> (for International Standard Book 
Number).  Of these only <literal>xsm</literal> is supported directly in the sample implementation.
</Para>
</RefSect1>

</RefEntry>