[Jmri-commits] help/en/package/jmri/jmrit/beantable BlockTable.shtml, 1.4, 1.5

[Dave D. <djd...@us...>]

Update of /cvsroot/jmri/help/en/package/jmri/jmrit/beantable
In directory fdv4jf1.ch3.sourceforge.com:/tmp/cvs-serv6896

Modified Files:
	BlockTable.shtml 
Log Message:
Add help documentation for Block Table

Index: BlockTable.shtml
===================================================================
RCS file: /cvsroot/jmri/help/en/package/jmri/jmrit/beantable/BlockTable.shtml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** BlockTable.shtml	1 Nov 2008 16:40:03 -0000	1.4
--- BlockTable.shtml	26 Feb 2009 20:16:19 -0000	1.5
***************
*** 25,47 ****
  
  <H1>The Block Table</H1>
!  
! Columns in the Block Table:
  <ul>
! <li>System Name
! <li>User Name
! <li>Value: This is the string value of whatever object the
  block is carrying.  Usually, this will either be a message
  or a Throttle object. If you modify this, it's stored in the Block
  as a string. There is currently no way to manually add a Throttle
! object to a block from the table.
! <li>Delete
! <li>Direction: The current direction stored in the block.
  </ul>
  
  <p>
! <a href="../../../../html/tools/tracker/index.shtml">More information on Blocks</a>
! <p>   
! This is the package/jmri/jmrit/beantable/BlockTable help page
! 
  <br>
  
--- 25,97 ----
  
  <H1>The Block Table</H1>
! 
! <H2>Blocks:</H2>
! <p>Blocks are sections of track whose occupancy may be individually monitored. Dividing 
! track into Blocks is optional. Blocks set up in a track diagram normally correspond 
! to physical blocks on a layout. Block occupancy is indicated by the state of an 
! occupancy sensor. When a layout's track is divided into Blocks, all of the track need 
! not belong to a Block. For example, yard track may not be in a Block, whereas mainline 
! track almost always would be divided into Blocks. The main use of Blocks is to facilitate 
! signaling, but Blocks may be used for other layout control and animation functions.</p>
! <p>Blocks may be set up using a script, or automatically in a Layout Editor panel. When a 
! Block is defined in a Layout Editor panel, a new Block is created if one does not already
! exist.  In Layout Editor, Blocks are identified by their User Name, so if a Block shown 
! in this table is used in a Layout Editor panel, its User Name should not be changed. If 
! you want to change the User Name of a Block used in a Layout Editor panel, make the 
! change in the Layout Editor, not here.</p>
! <p>To complete the definition of a Block, Paths and Bean Settings must be attached to 
! each Block. Paths describe entry points to the Block. Each Block has one or more Paths
! associated with it. Sometimes a turnout must be set a certain way to use a Path; Bean 
! Settings carry that information. Paths and Bean Settings are set up automatically for 
! Blocks defined in a Layout Editor panel. They can also be set up in a script. There is 
! currently no way to manually enter Paths or Bean Settings. Paths and Bean Settings are 
! not shown in the Block Table, and are described here only for completeness.</p>
! <p>For use in automatically running trains, a length attribute and a curvature attribute 
! may optionally be assigned to a Block. These optional attributes are entered manually 
! in this table. If trains will not be run automatically through 
! a Block, there is no need to add these attributes.</p>
! <H2>Columns in the Block Table:</H2>
  <ul>
! <li><p><b>System Name</b> - The system name of the Block. There is no functional 
! requirement for a type letter in the System Name of a Block, but by convention we use 
! 'B' for 'Block'. The default implementation is not system-specific, so a system letter 
! of 'I' is appropriate. This leads to system names like "IB201".</p></li> 
! <li><p><b>User Name</b> - The user name of the Block. The user name of a Block created
! here may be set to any text.  The user name for a Block created by Layout Editor is 
! set by Layout Editor and should not be changed.</p></li>
! <li><p><b>Value</b> - This is the string value of whatever object the
  block is carrying.  Usually, this will either be a message
  or a Throttle object. If you modify this, it's stored in the Block
  as a string. There is currently no way to manually add a Throttle
! object to a block from the table.</p></li>
! <li><p><b>Comment</b> - You may enter any text in this field that will help you 
! distinguish this Block from other Blocks, or provide useful notes about its use.</p></li>
! <li><p><b>Delete</b> - Click the <b>Delete</b> button in any row to delete the Block in 
! that row from the list of Blocks in the computer. You must save your configuration (and 
! any Panels present) to disk to make the deletion permanent. Deletion may not be undone.
! <b>Caution: Make sure you remove all references to a Block before deleting it.</b>  
! Blocks are referenced in the Paths of other Blocks, in some scripts, and in Layout 
! Editor panels.<p></li> 
! <li><p><b>Direction</b> - The current direction stored in the block.</p></li>
! <li><p><b>Length</b> (optional) - Displays the length of the Block.  Optionally, you may 
! enter the length of the Block here.  The length is used for automatic running of trains. 
! If '0.0' is displayed, the length has not been entered. The entered length should be the 
! actual length of the Block on the model railroad layout. Length is entered and displayed 
! in either inches or centimeters, depending on which unit is requested at the bottom of 
! the Block Table.</p></li>
! <li><p><b>Curvature</b> (optional) - Displays the curvature selected for the track in 
! the Block. Curvature is used for automatic running of trains, and need not be entered 
! if trains will not be run automatically. Curvature, if present, indicates to the computer 
! that it should slow the train as it runs through the Block. If <b>None</b> or 
! <b>Gradual</b> are selected, an automatic train will proceed at normal speed. <b>Tight</b> 
! should be selected if the train should slow down some; <b>Severe </b>should be selected 
! if the train should slow by a maximum amount. If the Block has variable curvature, your 
! selection should be made according to the most limiting part of the Block.</p></li>
  </ul>
  
  <p>
! <a href="../../../../html/tools/tracker/index.shtml">More information on Blocks</a></p>
! <p>
! <a href="../display/LayoutEditor.shtml">More information on using Blocks with Layout Editor</a>
  <br>