Conference vaxuum::document_ft

61.0. "Documentation glitches and basic q's" by ZEPPO::ROMBERG (Kathy Romberg DTN 276-8189) Thu Mar 05 1987 12:08

	I looked  for  a  note  on  general documentation  glitches, but I
    couldn't find one, so ...

	Page A-2 of Release Notes:
	    It says I can use the SOFTWARE.SPEC doctype for the 
	    DEVELOPMENT_PLAN and PRODUCT_SPECIFICATION templates,
	    but <byline> is only recognized only by the GENERAL
	    doctype.

	Page 2-3 of Release Notes:
	    Page 3-9 says that <include_tex_file> is supported for 
	    Digital Internal Use Only, but it's not lised here under
	    'Internal Use Only Tags'.  (I hope it's not gonna go away
	    'cuz we use it *a lot*.)


	Now a general document question - 

	I tried  processing the templates just to see how they looked in
    comparison  to  what  our group was using. I did what the comment at
    the top of the file told me to do:

	    Document <file> general ln03 /contents/index/nodevice
	    Document <file>_contents general ln03 /notag/nodevice
	    Document <file> general ln03 /notag/notext_formatter

	It gave  me  2  messages  that it was including the _contents. I
    would have expected only one. How come 2?

	By the  way  -  I  like all the different doctypes - now we just
    have to decide which ones we like best!!!!

	That's all for now, folks....

				Kathy Romberg

    
    I don't think it included the contents twice. The device converter
    makes 2 passes over the file, and issues messages during both. If
    you'all think this is confusing, we'll take a look at it.
    
    Also, I just checked the doc. and it looks like something fell through
    the cracks on SOFTWARE.SPEC: it accepts and processes the following
    in <FRONT_MATTER>:
    
    -<DATE_LINE>, <AUTHOR>, <SIGNATURES>
    
    The tag translator also recognizes <BYLINE>, but unfortunately there
    is a bug in that the text formatter doesn't. This will be fixed
    in the FT update. (The inclusion of these tags in the SPECIFICATION
    style was intended to supply the functions previously done in GENERAL)
    
    patti anklam
    

    By the way, there is no note in here for general documentation errors
    or questions, because there's an account set up specifically for
    that purpose. Send all comments on the FT documentation (via VAXmail)
    to VAXUUM::DOCDOC.
    
    -Barbara Corman

    Re .2
    
    If people send mail, though, then others cannot learn about
    documentation problems, work-arounds, and the like. As much as I've had
    good dealings with DOCDOC, it would have saved me a day or two of
    working with a user to solve one particular problem. 
    
    kh