[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

477.0. "Example and table defaults" by CUPOLA::HAKKARAINEN (with hasty reverence) Fri Jun 05 1987 17:53

    Got burned by this as I tried to advise a user. An example without
    a caption produces a caption; a table without a caption does not.
    
<example>
<code_example>
<include>(bar.dat)
<endcode_example>
<endexample>

<table>
<table_setup>(2\20)
<table_row>(col1\col2)
<endtable>
    

                   Example 0:

                   this is bar.dat.

                   col1                  col2
    
    
T.RTitleUserPersonal
Name
DateLines
477.1Example vs ExampleCUPOLA::LMELEWSKIMon Jun 08 1987 09:3813
    Karl,
    
    I believe the confusion here is that <example> without an argument
    outputs a heading "Example", but is still considered to be an informal
    example. A formal example takes an argument and numberes the example
    according to the caption numbering parameters, ie Example 1-1  Caption.
    
    The <table> tag without an argument outputs no heading and is
    an informal table.
    
    Hope this explanation helps.
    
    
477.2caption vs. uncaptionedCLOSET::ANKLAMMon Jun 08 1987 16:0026
    
    Karl is correct that there is an inconsistency in the use of
    the formality of examples. I modified, for V1.0 (also in BL8, I
    believe) the definition for <example> so that it requires at least
    one argument. This will avoid the examples numbered 0 problem, but
    it will cause files that use:
    
    <example>
    <code_example>
      ...
    <endcode_example>
    <endexample>
    
    to break. (Donna Rosenthal's file with the creeping page numbers
    has a number of these; I am not a bit worried that failing to signal
    this earlier will cause files to break under V1.0... help? comments?)
    
    The section on Figures in the SDMLUG has been revised a good bit
    since the BL8 version; I particularly made sure that it explains
    the difference between formality and non-formality in figures, and
    then discusses <example> as an alternate identification method for
    technical manuals in which there is a distinction between a <figure>
    and an <example>. 
                      
    
    -pa