[Jmri-commits] help/en/html/tools/signaling DefineNewAspects.shtml, 1.4, 1.5

[Kevin D. <kev...@us...>]

Update of /cvsroot/jmri/help/en/html/tools/signaling
In directory vz-cvs-3.sog:/tmp/cvs-serv14035

Modified Files:
	DefineNewAspects.shtml 
Log Message:
Updated to follow changes in signalmast specific aspects

Index: DefineNewAspects.shtml
===================================================================
RCS file: /cvsroot/jmri/help/en/html/tools/signaling/DefineNewAspects.shtml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** DefineNewAspects.shtml	8 Apr 2011 16:43:58 -0000	1.4
--- DefineNewAspects.shtml	18 May 2011 15:40:34 -0000	1.5
***************
*** 93,96 ****
--- 93,98 ----
        <comment></comment>
        <imagelink></imagelink>
+       <speed></speed>
+       <diverging></diverging>
      </aspect>
  </pre></code>
***************
*** 108,111 ****
--- 110,125 ----
  more work.
  <p>
+ The speed element, if present, should either be a numerical value or a string
+ value that has been defined int eh signalSpeeds.xml file.  The speed element 
+ relates to the maximum speed a train can pass the aspect at.  The signalmast logic 
+ uses this speed to help determine which aspect should be displayed where there
+ are multiple possible aspects.
+ <p>
+ The diverging element, if present, should simple be entered in as a 'yes'. 
+ The diverging element indicates that this specific aspect is used when a 
+ turnout has been thrown in the path ahead.  The signalmast logic uses this element
+ to help determine which aspect should be displayed where there are multiple 
+ possible aspects.
+ <p>
  Below the aspect blocks, there's a block that names all the valid
  appearance files, e.g.:
***************
*** 136,140 ****
  
  <code><pre>
!     &lt;appearance&gt;
        &lt;aspectname&gt;Clear&lt;/aspectname&gt;
        &lt;show&gt;green&lt;/show&gt;
--- 150,154 ----
  
  <code><pre>
!     &lt;appearance&gt;<br>
        &lt;aspectname&gt;Clear&lt;/aspectname&gt;
        &lt;show&gt;green&lt;/show&gt;
***************
*** 142,146 ****
        &lt;reference&gt;&lt;/reference&gt;
        &lt;imagelink&gt;&lt;/imagelink&gt;
!     &lt;/appearance&gt;
  </pre></code>
  
--- 156,160 ----
        &lt;reference&gt;&lt;/reference&gt;
        &lt;imagelink&gt;&lt;/imagelink&gt;
!     &lt;/appearance&gt;<br>
  </pre></code>
  
***************
*** 163,174 ****
  As the appearance names are all user defined and can be in any language, 
  it is necessary to identify some specifically used aspects that various 
! parts of JMRI will specifically ask for.  
  This information can be entered at after the appearance information in the following form.
  <code><pre>
    &lt;specificappearances&gt;
!     &lt;danger&gt;Danger&lt;/danger&gt;
!     &lt;permissive&gt;Off&lt;/permissive&gt;
!     &lt;held&gt;Danger&lt;/held&gt;
!     &lt;dark&gt;Not lit&lt;/dark&gt;
    &lt;/specificappearances&gt;
  </pre></code>
--- 177,200 ----
  As the appearance names are all user defined and can be in any language, 
  it is necessary to identify some specifically used aspects that various 
! parts of JMRI will specifically ask for.<br>
! Each specific aspect can be given an alternative image to use other than that given
! in the main appearance definition.<br>
  This information can be entered at after the appearance information in the following form.
  <code><pre>
    &lt;specificappearances&gt;
!     &lt;danger&gt;
!         &lt;aspect&gt;Danger&lt;/aspect&gt;
!     &lt;/danger&gt;
!     &lt;permissive&gt;
!         &lt;aspect&gt;Off&lt;/aspect&gt;
!     &lt;/permissive&gt;
!     &lt;held&gt;
!         &lt;aspect&gt;Danger&lt;/aspect&gt;
!         &lt;imagelink&gt;held.gif&lt;/imagelink&lt;
!     &lt;/held&gt;
!     &lt;dark&gt;
!         &lt;aspect&gt;Not Lit&lt;/aspect&gt;
!         &lt;imagelink&gt;notlit.gif&lt;/imagelink&lt;
!     &lt;/dark&gt;
    &lt;/specificappearances&gt;
  </pre></code>
***************
*** 181,191 ****
  The purpose of the map is to define which potential appearances are valid depending upon
   what appearance is being displayed on the signal mast that is ahead of us.  
!  This mapping can be a simple one-to-one, E.g. Advanced signal mast is showing Danger, we should show Caution.  
   Or a more complex one-to-many map where there could be multiple appearances that we could display, 
!  E.g. Advanced signal is showing Approach, but we could display either a 
!  Clear or Diverging Clear depending upon other conditions.
  <p>
  All of the mappings, are contained within the &lt;aspectMappings&gt; tags, within their own &lt;aspectMapping&gt; tag
! 
  
  <h3>Check Your Work</h3>
--- 207,234 ----
  The purpose of the map is to define which potential appearances are valid depending upon
   what appearance is being displayed on the signal mast that is ahead of us.  
!  This mapping can be a simple one-to-one, E.g. Advanced signal mast is showing Approach, we should show Clear.
   Or a more complex one-to-many map where there could be multiple appearances that we could display, 
!  E.g. Advanced signal is showing Stop, but we could display either a 
!  Approach or Diverging Approach depending upon other conditions.
!  <p>
!  The value of the Advanced Aspect can be any that is defined in the Aspect table
!  for that signalling system.<br>
!  The value of Our Aspect, must be one that is defined and supported by the 
!  defined in the appearance file.
  <p>
  All of the mappings, are contained within the &lt;aspectMappings&gt; tags, within their own &lt;aspectMapping&gt; tag
! <code><pre>
! &lt;aspectMappings&gt;
!     &lt;aspectMapping&gt;
!         &lt;advancedAspect&gt;Approach&lt;/advancedAspect&gt;
!         &lt;ourAspect&gt;Clear&lt;/ourAspect&gt;
!     &lt;/aspectMapping&gt;
!     &lt;aspectMapping&gt;
!         &lt;advancedAspect&gt;Stop&lt;/advancedAspect&gt;
!         &lt;ourAspect&gt;Approach&lt;/ourAspect&gt;
!         &lt;ourAspect&gt;Diverging Approach&lt;/ourAspect&gt;
!     &lt;/aspectMapping&gt;
! &lt;/aspectMappings&gt;
! </pre></code>
  
  <h3>Check Your Work</h3>