Conference vaxuum::document_ft

673.0. "BUG in <FIGURE_ATTRIBUTES>(KEEP)" by GENRAL::HEINTZE () Wed Jul 15 1987 18:55

    A couple of questions (listed in order of priority):
    
    (1) Is <FIGURE_ATTRIBUTES>(keep) broken?   I have a large figure (line_art)
    that it broke accros a page.   I did DIR/KEY=BUG in this notes file,
    and could find any references in this notes file.  So I used the
    <PAGE> and that fixed it.  I think what I might want is
    <FIGURE_ATTRIBUTES>(FLOAT).   Does FLOAT mean that it won't break
    the figure?
    
    (2) what do doc writters do when describing a DCL like
    command, specifically a qualifier that has many values that are
    keywords?    I though that <LIST>(stacked, braces) was too tedious
    for the <QUAL_LIST> section.   But I did use <LIST>(Stacked,braces)
    in the <QUALITEM> section.  Is this consistant with the VMS documenation?
    
    Here is what I did:

        <QUAL_LIST>(Command Qualifiers)
<qpair>(/FORMAT=keyword\/FORMAT=LPR)
<qpair>(/GRAPH=device-spec\None.)
<qpair>(/GLOBAL\None.)
<qpair>(/LOCAL\None.)
<qpair>(/PRINT\/PRINT=SYS$OUTPUT)
<qpair>(/RESCHEDULE[=delta-time]\/RESCHEDULE="30 0:00:00.00")
<qpair>(/WIDTH=integer\/WIDTH=80)
<ENDQUAL_LIST>


    and a little later:
    
    <QUALITEM>(/FORMAT=
<LIST>(stacked\braces)
<LE>MAIL
<LE>TERM
<LE>LPR
<LE>SDML
<LE>POSTSCRIPT
<LE>LN03
<ENDLIST>
)<QUALDEF>  This indicates the format of the generated report.
<LIST>(simple)
<LE><KEYWORD>(LPR) is the default, this generates a report suitable for printing
on a line printer.
<LE><KEYWORD>(MAIL) is the same as LPR, this generates a report that 
can be sent through the mail.
<LE><KEYWORD>(TERM)  generates a report suitable for view on a 
video terminal.  Advanced video options are utilized.
<LE><KEYWORD>(SDML) generates a report that must be post-processed
with DOCUMENT before printing.
<LE><KEYWORD>(LN03) generates  a report suitable for printing on a LN03
laser printer.
<LE><KEYWORD>(POSTSCRIPT) generates a report suitable for printing on a
POSTSCRIPT printer such as a LPS40.
<ENDLIST>

    
       (3)  What about /WIDTH= in the QPAIR?  Do doc writers just put
    "integer" or "<INTEGER>" or what?
    
    (4)  What about <LIST>(SIMPLE) - I'd like DOCUMENT to leave a space
    between each entry.

    re: 1
    As I understand the KEEP keyword, you should use this when the figure
    does not exceed image area size for the doctype and you want the
    figure to start after the preceding text.
    
    If it's a long figure that extends beyond a page, then use MULTIPAGE.
    I think multipage and informal figures float by default.
 
    I posted an earlier note mentioning that the examples seem to indicate that
    keywords to <FIGURE_ATTRIBUTES> arguments are specified
    interchangeably. 
        
    re: 2
    
    Descriptions of keywords to DCL command qualifiers are described
    in the qualifier definition <QUALDEF>. For example,
    
    <QUAL_LIST>
    .
    .
    .
    <QPAIR>(/[NO]REPLACE\See text.)
    .
    .
    .
    <ENDQUAL_LIST>
    
    <QUALDEFLIST>
    .
    .
    .
    <QUALITEM>(/REPLACE[=(list-of-optional-keywords)]\/NOREPLACE (default))

    <QUALDEF>
    Describe the qualifier here. Include a list or table, if necessary,
    summarizing the behavior of the keywords. 
    
    In the preceding example, if you use /REPLACE without keyword(s), a 
    default keyword is used. The default action of the DCL, however, is 
    /NOREPLACE.
      .
      .
      .
   <ENDQUALDEFLIST>

    
    Mason

    
    (1) <FIGURE_ATTRIBUTES>(KEEP) does not mean "keep all of this figure
        on one page". It means "keep this figure with the preceding
        text; do not float it." You need to use <line_art>(Keep) to
        force the monospaced example to stay on one page.
    
    (2) Thank you, Mason for answering that. As  VMS writer, you are
        in a better position than I to answer (3) as well. I believe,
        however, that there is no tag (<integer>) used.
    
    (4) This is already on the wishlist for the next functional release.
    
    patti