[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

99.0. "<KEY>, <BOX> and <CTRL>( )" by LOLITA::KEEFE () Thu Mar 12 1987 16:27

p 2-2 says you can only use the <KEY> tag now with a SOFTWARE doctype, and 
for other doctypes you should use <BOX> instead. Fortunately though <KEY>,
and even the supposedly obsolete <CTRL> tag do still work in a non-software 
doctype.

<CTRL>(X)  (old way)    and    <KEY>(CTRL/X\BOX)   (new way)

both do exactly the same thing, in the HARDWARE doctype, no less. Which
is fine by me. The old way is easier to remember and involves less typing. 
It's not only software manuals that use this tag - our hardware books are 
infested with it. So if this is an inadvertent leftover, please don't fix it.

Since <KEY> worked in HARDWARE, I wondered why I couldn't find a description
in the User's Guide list of doctype-independent tags.
T.RTitleUserPersonal
Name
DateLines
99.1CLOSET::ADLERThu Mar 12 1987 23:562
HARDWARE is a local doctype. The <KEY> tag does not work with any standard
doctypes other than SOFTWARE.*.
99.2LOCAL - unclear on the conceptLOLITA::KEEFEFri Mar 13 1987 15:157
    It wasn't obvious to me that HARDWARE was a 'local' doctype, since
    it was distributed as part of the internal kit, and is described as the
    CUP standard doctype for hardware documentation. It isn't really in
    the same category as a true local (as in locally developed) doctype.
    
    I'll stay tuned to note 107 for a clearer definition.
     
99.3CLOSET::ADLERFri Mar 13 1987 17:301
I meant local to internal DEC folks, sorry for the confusion.  --Brian
99.4<key> was omitted! I need an <oops> tag! :-)VAXUUM::CORMANMon Mar 16 1987 15:525
    And <key> was left out of the User's Guide doctype-independent tags
    accidentally... it should have been there...will be there for the
    Field Test Update.
    
    -barbara
99.5playing the devil's avocado LOLITA::KEEFEMon Mar 16 1987 20:359
    Now I'm more confused. If the <key> tag only works in the software
    and internal DEC doctypes, then it's doctype dependent, and
    shouldn't be in the User's Guide list of doctype independent tags
    after all. It's only a local-and-DEC-internal tag, yes?
    
    
    
    
    
99.6So sorry.VAXUUM::CORMANTue Mar 17 1987 09:548
    OH NUTS! Yes, you are right. I confused the whole thing, myself.
    I simply had a momentary lapse, I guess... <KEY> is a software doctype
    tag, and DOES NOT belong in the list of doctype-independent tags,
    so was left out of the list on purpose. (I forgot that I remembered
    to forget the <key> tag on purpose. :-]  That's what I get for
    answering notesfile questions on the day I return from vacation.)
    
    -Barbara
99.7<key> is a version 1.0 doctype-specific tagCLOSET::OTTETue Mar 17 1987 10:0422
Hmm, lets see if I can clear things up. I think Barb got a bit confused
    over the ug part 2 tag ( <key> ) and a new tag for the ug part 1 that has 
    much the same behavior ( <box> ).
    
    <key> is a SOFTWARE doctype-specific tag.  It is documented in the
    VAX DOCUMENT Users Guide part 2.  This tag  will ship with version 1.0 
    of VAX DOCUMENT. 
    
    <box> is a GLOBAL tag (doctype independent). It will be documented
    in the VAX DOCUMENT Users Guide Part 1.  This tag provides the ability
    to place text in a box like the <key> tag, only this tag works in
    all doctypes.  It has the added virtue of being more generic; ie,
    if you just want a box around something you code it as <box> and
    not as <key>....definitely makes your source file more readable,
    and more kosher as a generically marked up file.
    <BOX> is being made available for the FT update release of DOCUMENT,
    and will also be shipped with version 1.0 of DOCUMENT.
    
    
    Hope this helps,
    
    -Randy 
99.8Faster than a speeding bullet!VAXUUM::CORMANTue Mar 17 1987 19:163
    P.S. It looks like Randy and I entered our answers at the exact
    same time. Thanks, Randy, for the additional clarification.
    -Barbara