[Search for users] [Overall Top Noters] [List of all Conferences] [Download this site]

Conference vaxuum::document_ft

Title:DOCUMENT T1.0
Notice:**New notesfile (DOCUMENT.NOTE) now available (see note 897)**
Moderator:CLOSET::ADLER
Created:Mon Feb 09 1987
Last Modified:Thu Oct 31 1991
Last Successful Update:Fri Jun 06 1997
Number of topics:897
Total number of notes:4397

377.0. "TOC Entry Without <head> Tags?" by PYONS::DCHAVEZ (Dale C. - CXO3 Colo Spgs) Thu May 14 1987 10:28

I'm converting a software reference manual that was originally done in 
DSRPLUS to DOCUMENT.  I'm using the <ROUTINE_SECTION> template tags to 
accomplish the same output that was originally typeset from DSRPLUS.

The problem is that I'm not going to get table of contents entries for all 
the routines (many) I'm writing about, because I'm not using <head> tags.  
Is there any way to get a TOC entry *without* using <head> tags.  I assume 
it can be done because the VMS DCL Dictionary was written using template tags 
and the manual has TOC entries.

Thanks for any help.

Dale
T.RTitleUserPersonal
Name		DateLines
377.1A working example, with TOCSHIRE::ZGRAGGENSearching for infinity...Thu May 14 1987 12:2848
    Dale
    
    If you are using the ROUTINE tags correctly then the routine name
    will appear in the table of contents. Below I've include a routine
    I've documented, the TOC entry is present. The inclusion needs to
    be between <ROUTINE_SECTION> and <ENDROUTINE_SECTION> tags.
    
    Peter
    
<COMMENT>(****Version 1****)    
<routine>($CLOSE\Close down a Database Session)

<overview>
Close the database, this services sends a close message to the attached
server.
<endoverview>

<format>
<frtn>(VAUD$CLOSE)
<fargs>(database-id)
<endformat>

<returns>(cond-value\longword (unsigned)\write only\by value)
<rettext>
Longword condition value. All services return (by immediate value) a condition
value in R0. Condition values that can be returned by the service are listed
under <quote>(RETURN VALUES).
<endrettext>

<argdeflist>
<argitem>(database-id\context\longword (unsigned)\read only\by value)
<argdef>
This parameter specifies a longword that is a unique database
session identification.
<endargdeflist>

<description>
This service should be called to logically close down the connection between
the client and the attached server session.
<enddescription>

<rsdeflist>
<rsitem>(VAUD$_BUSY\Database is busy, can not complete operation)
<rsitem>(VAUD$_INSARG\Insufficient arguments)
<rsitem>(VAUD$_NORMAL\Normal successful completion)
<rsitem>(VAUD$_NOSUCHDB\No such database)
<rsitem>(VAUD$_TOOMNYARGS\Too many arguments)
<endrsdeflist>
377.2Got a TOCPYONS::DCHAVEZDale C. - CXO3 Colo SpgsThu May 14 1987 13:147
RE: < Note 377.1 by SHIRE::ZGRAGGEN "Searching for infinity..." >

Peter,

Thanks for the response.  Is this documented anywhere?

Dale
377.3Yes, but...CLOSET::OTTEThu May 14 1987 15:5212
    No its not documented in any really accessible place, but it will
    be for version 1.0 of the documentation.  Page 8-2 of the VAX DOCUMENT
    User Manual Volume 1, Field Test Update Draft (BL8), lists the tags
    that create an entry in the table of contents.
      
    You should add to that list the SOFTWARE doctype <routine> <sdml_tag> 
    <command> <statement> and <function> tags, and the global <table> 
    <example> and <figure> tags when they are used with a caption 
    (and so are numbered).
    
    -randy
377.4BL8 Docs Available?PYONS::DCHAVEZDale C. - CXO3 Colo SpgsThu May 14 1987 16:0012
RE:< Note 377.3 by CLOSET::OTTE >
                                -< Yes, but... >-

>    No its not documented in any really accessible place, but it will
>    be for version 1.0 of the documentation.  Page 8-2 of the VAX DOCUMENT
>    User Manual Volume 1, Field Test Update Draft (BL8), lists the tags
>    that create an entry in the table of contents.

Does this mean that BL8 documentation is available online somewhere :-) ?

Dale
377.5Just around the corner, DaleCOOKIE::JOHNSTONThu May 14 1987 16:218
Hi Dale.  Cross over a node and copy the BL8 documentation from me, if
you like.   It's in COOKIE::DISK$FIG_4:[JOHNSTON.DOCUMENT.DOCS].  All 
the files in there are BL8 documentation.

By the way, which doctype are you using for your book with the routines?


Rose