taskjuggler 0.0.3 → 0.0.4

data/doc/classes/TaskJuggler/Journal.html

@@ -87,6 +87,16 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+A <a href="Journal.html">Journal</a> is a list of <a
+href="JournalEntry.html">JournalEntry</a> objects. It provides methods to
+add <a href="JournalEntry.html">JournalEntry</a> objects and retrieve
+specific entries or other processed information.
+</p>
+
+    </div>
+
    </div>
 
 
@@ -95,9 +105,17 @@
 
       <div class="name-list">
 
-        <a href="#M000757">addEntry</a>&nbsp;&nbsp;
+        <a href="#M000507">addEntry</a>&nbsp;&nbsp;
+
+        <a href="#M000509">alertLevel</a>&nbsp;&nbsp;
+
+        <a href="#M000510">currentEntries</a>&nbsp;&nbsp;
+
+        <a href="#M000511">currentEntriesR</a>&nbsp;&nbsp;
 
-        <a href="#M000756">new</a>&nbsp;&nbsp;
+        <a href="#M000508">entries</a>&nbsp;&nbsp;
+
+        <a href="#M000506">new</a>&nbsp;&nbsp;
 
       </div>
     </div>
@@ -118,12 +136,12 @@
       <h3 class="section-bar">Public Class methods</h3>
 
 
-      <div id="method-M000756" class="method-detail">
-        <a name="M000756"></a>
+      <div id="method-M000506" class="method-detail">
+        <a name="M000506"></a>
 
         <div class="method-heading">
 
-          <a href="#M000756" class="method-signature">
+          <a href="#M000506" class="method-signature">
 
           <span class="method-name">new</span><span class="method-args">()</span>
 
@@ -133,14 +151,21 @@
 
         <div class="method-description">
 
+          <p>
+Create a new <a href="Journal.html">Journal</a> object.
+</p>
+
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000756-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000756-source">
+            onclick="toggleCode('M000506-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000506-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/Journal.rb, line 34</span>
-34:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
-35:       <span class="ruby-ivar">@entries</span> = []
-36:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 152</span>
+152:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+153:       <span class="ruby-comment cmt"># This list holds all entries.</span>
+154:       <span class="ruby-ivar">@entries</span> = <span class="ruby-constant">JournalEntryList</span>.<span class="ruby-identifier">new</span>
+155:       <span class="ruby-comment cmt"># This hash holds a list of entries for each property.</span>
+156:       <span class="ruby-ivar">@propertyToEntries</span> = {}
+157:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -151,12 +176,12 @@
       <h3 class="section-bar">Public Instance methods</h3>
 
 
-      <div id="method-M000757" class="method-detail">
-        <a name="M000757"></a>
+      <div id="method-M000507" class="method-detail">
+        <a name="M000507"></a>
 
         <div class="method-heading">
 
-          <a href="#M000757" class="method-signature">
+          <a href="#M000507" class="method-signature">
 
           <span class="method-name">addEntry</span><span class="method-args">(entry)</span>
 
@@ -164,16 +189,237 @@
 
         </div>
 
+        <div class="method-description">
+
+          <p>
+Add a new <a href="JournalEntry.html">JournalEntry</a> to the <a
+href="Journal.html">Journal</a>.
+</p>
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000507-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000507-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 160</span>
+160:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addEntry</span>(<span class="ruby-identifier">entry</span>)
+161:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">entry</span>)
+162:       <span class="ruby-ivar">@entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
+163: 
+164:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span>.<span class="ruby-identifier">nil?</span>
+165: 
+166:       <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@propertyToEntries</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span>)
+167:         <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span>] = <span class="ruby-constant">JournalEntryList</span>.<span class="ruby-identifier">new</span>
+168:       <span class="ruby-keyword kw">end</span>
+169:       <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
+170:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+      <div id="method-M000509" class="method-detail">
+        <a name="M000509"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000509" class="method-signature">
+
+          <span class="method-name">alertLevel</span><span class="method-args">(date, property)</span>
+
+          </a>
+
+        </div>
+
+        <div class="method-description">
+
+          <p>
+Determine the alert level for the given <em>property</em> at the given
+<em>date</em>. If the property does not have any <a
+href="JournalEntry.html">JournalEntry</a> objects or they are out of date
+compared to the child properties, the level is computed based on the
+highest level of the children.
+</p>
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000509-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000509-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 191</span>
+191:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">alertLevel</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">property</span>)
+192:       <span class="ruby-identifier">maxLevel</span> = <span class="ruby-value">0</span>
+193:       <span class="ruby-comment cmt"># Gather all the current (as of the specified _date_) JournalEntry</span>
+194:       <span class="ruby-comment cmt"># objects for the property and than find the highest level.</span>
+195:       <span class="ruby-identifier">currentEntriesR</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">property</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
+196:         <span class="ruby-identifier">maxLevel</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">alertLevel</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">maxLevel</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">alertLevel</span>
+197:       <span class="ruby-keyword kw">end</span>
+198:       <span class="ruby-identifier">maxLevel</span>
+199:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+      <div id="method-M000510" class="method-detail">
+        <a name="M000510"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000510" class="method-signature">
+
+          <span class="method-name">currentEntries</span><span class="method-args">(date, property, minLevel, minDate)</span>
+
+          </a>
+
+        </div>
+
+        <div class="method-description">
+
+          <p>
+This function returns a list of entries that have all the exact same date
+and are the last entries before the deadline <em>date</em>. Only messages
+with at least the required alert level <em>minLevel</em> are returned.
+Messages with alert level <em>minLevel</em> must not be older than
+<em>minDate</em>.
+</p>
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000510-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000510-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 205</span>
+205:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">currentEntries</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">property</span>, <span class="ruby-identifier">minLevel</span>, <span class="ruby-identifier">minDate</span>)
+206:       <span class="ruby-identifier">pEntries</span> = <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">property</span>] <span class="ruby-operator">?</span>
+207:                  <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">property</span>].<span class="ruby-identifier">last</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">:</span> []
+208:       <span class="ruby-comment cmt"># Remove entries below the minium alert level or before the timeout</span>
+209:       <span class="ruby-comment cmt"># date.</span>
+210:       <span class="ruby-identifier">pEntries</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">alertLevel</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">minLevel</span>  <span class="ruby-operator">||</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">headline</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">||</span>
+211:                                (<span class="ruby-identifier">e</span>.<span class="ruby-identifier">alertLevel</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">minLevel</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">minDate</span>) }
+212: 
+213:       <span class="ruby-keyword kw">return</span> [] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pEntries</span>.<span class="ruby-identifier">empty?</span>
+214: 
+215:       <span class="ruby-comment cmt"># Check parents for a more important or more up-to-date message.</span>
+216:       <span class="ruby-identifier">p</span> = <span class="ruby-identifier">property</span>.<span class="ruby-identifier">parent</span>
+217:       <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">p</span> <span class="ruby-keyword kw">do</span>
+218:         <span class="ruby-identifier">ppEntries</span> = <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">p</span>] <span class="ruby-operator">?</span>
+219:                     <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">p</span>].<span class="ruby-identifier">last</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">:</span> []
+220: 
+221:         <span class="ruby-comment cmt"># A parent has a more up-to-date message.</span>
+222:         <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ppEntries</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">ppEntries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">pEntries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span>
+223:           <span class="ruby-keyword kw">return</span> []
+224:         <span class="ruby-keyword kw">end</span>
+225: 
+226:         <span class="ruby-identifier">p</span> = <span class="ruby-identifier">p</span>.<span class="ruby-identifier">parent</span>
+227:       <span class="ruby-keyword kw">end</span>
+228: 
+229:       <span class="ruby-identifier">pEntries</span>
+230:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+      <div id="method-M000511" class="method-detail">
+        <a name="M000511"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000511" class="method-signature">
+
+          <span class="method-name">currentEntriesR</span><span class="method-args">(date, property)</span>
+
+          </a>
+
+        </div>
+
+        <div class="method-description">
+
+          <p>
+This function recursively traverses a tree of <a
+href="PropertyTreeNode.html">PropertyTreeNode</a> objects from bottom to
+top. It returns the last entries before <em>date</em> for each property
+unless there is a property in the sub-tree specified by the root
+<em>property</em> with more up-to-date entries. The result is a <a
+href="JournalEntryList.html">JournalEntryList</a>.
+</p>
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000511-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000511-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 237</span>
+237:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">currentEntriesR</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">property</span>)
+238:       <span class="ruby-comment cmt"># See if this property has any current JournalEntry objects.</span>
+239:       <span class="ruby-identifier">pEntries</span> = <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">property</span>] <span class="ruby-operator">?</span>
+240:                  <span class="ruby-ivar">@propertyToEntries</span>[<span class="ruby-identifier">property</span>].<span class="ruby-identifier">last</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">:</span> []
+241: 
+242:       <span class="ruby-identifier">entries</span> = <span class="ruby-constant">JournalEntryList</span>.<span class="ruby-identifier">new</span>
+243:       <span class="ruby-identifier">latestDate</span> = <span class="ruby-keyword kw">nil</span>
+244:       <span class="ruby-comment cmt"># Now gather all current entries of the child properties and find the</span>
+245:       <span class="ruby-comment cmt"># date that is closest to and right before the given _date_.</span>
+246:       <span class="ruby-identifier">property</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
+247:         <span class="ruby-identifier">currentEntriesR</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">p</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
+248:           <span class="ruby-identifier">latestDate</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">latestDate</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">latestDate</span>
+249:           <span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">e</span>
+250:         <span class="ruby-keyword kw">end</span>
+251:       <span class="ruby-keyword kw">end</span>
+252:       <span class="ruby-comment cmt"># If no child property has a more current JournalEntry than this</span>
+253:       <span class="ruby-comment cmt"># property and this property has JournalEntry objects, than those are</span>
+254:       <span class="ruby-comment cmt"># taken.</span>
+255:       <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">pEntries</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">latestDate</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span>
+256:                               <span class="ruby-identifier">pEntries</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">date</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">latestDate</span>)
+257:         <span class="ruby-identifier">entries</span> = <span class="ruby-constant">JournalEntryList</span>.<span class="ruby-identifier">new</span>
+258:         <span class="ruby-identifier">entries</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">pEntries</span>
+259:       <span class="ruby-keyword kw">end</span>
+260:       <span class="ruby-comment cmt"># Otherwise return the list provided by the childen.</span>
+261:       <span class="ruby-identifier">entries</span>
+262:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+      <div id="method-M000508" class="method-detail">
+        <a name="M000508"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000508" class="method-signature">
+
+          <span class="method-name">entries</span><span class="method-args">(startDate = nil, endDate = nil, property = nil, alertLevel = nil)</span>
+
+          </a>
+
+        </div>
+
         <div class="method-description">
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000757-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000757-source">
+            onclick="toggleCode('M000508-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000508-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/Journal.rb, line 38</span>
-38:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addEntry</span>(<span class="ruby-identifier">entry</span>)
-39:       <span class="ruby-ivar">@entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
-40:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/Journal.rb, line 172</span>
+172:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">entries</span>(<span class="ruby-identifier">startDate</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">endDate</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>,
+173:                 <span class="ruby-identifier">alertLevel</span> = <span class="ruby-keyword kw">nil</span>)
+174:       <span class="ruby-identifier">list</span> = []
+175:       <span class="ruby-ivar">@entries</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
+176:         <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">startDate</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">startDate</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>) <span class="ruby-operator">&amp;&amp;</span>
+177:            (<span class="ruby-identifier">endDate</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">endDate</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">date</span>) <span class="ruby-operator">&amp;&amp;</span>
+178:            (<span class="ruby-identifier">property</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">property</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span> <span class="ruby-operator">||</span>
+179:                              <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">property</span>.<span class="ruby-identifier">isChildOf?</span>(<span class="ruby-identifier">property</span>)) <span class="ruby-operator">||</span>
+180:            (<span class="ruby-identifier">alertLevel</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">alertLevel</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">alertLevel</span>)
+181:           <span class="ruby-identifier">list</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">entry</span>
+182:         <span class="ruby-keyword kw">end</span>
+183:       <span class="ruby-keyword kw">end</span>
+184:       <span class="ruby-identifier">list</span>
+185:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 

data/doc/classes/TaskJuggler/JournalEntry.html

@@ -87,6 +87,19 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+A <a href="JournalEntry.html">JournalEntry</a> stores some <a
+href="RichText.html">RichText</a> strings to describe a status or a
+property of the project at a certain point in time. Additionally, the entry
+can contain a reference to a <a href="Resource.html">Resource</a> as author
+and an alert level. The text is structured in 3 different elements, a
+headline, a short summary and a longer text segment. The headline is
+mandatory, the summary and details sections are optional.
+</p>
+
+    </div>
+
    </div>
 
 
@@ -95,7 +108,7 @@
 
       <div class="name-list">
 
-        <a href="#M000755">new</a>&nbsp;&nbsp;
+        <a href="#M000497">new</a>&nbsp;&nbsp;
 
       </div>
     </div>
@@ -115,15 +128,23 @@
         <table>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">date</td>
+          <td class="context-item-name">alertLevel</td>
 
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 
           <td class="context-item-desc"></td>
         </tr>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">headline</td>
+          <td class="context-item-name">author</td>
+
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+
+          <td class="context-item-desc"></td>
+        </tr>
+
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">date</td>
 
           <td class="context-item-value">&nbsp;[R]&nbsp;</td>
 
@@ -131,7 +152,7 @@
         </tr>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">intro</td>
+          <td class="context-item-name">details</td>
 
           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 
@@ -139,9 +160,9 @@
         </tr>
 
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">more</td>
+          <td class="context-item-name">headline</td>
 
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
 
           <td class="context-item-desc"></td>
         </tr>
@@ -154,6 +175,22 @@
           <td class="context-item-desc"></td>
         </tr>
 
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">sourceFileInfo</td>
+
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+
+          <td class="context-item-desc"></td>
+        </tr>
+
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">summary</td>
+
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+
+          <td class="context-item-desc"></td>
+        </tr>
+
         </table>
       </div>
     </div>
@@ -166,14 +203,14 @@
       <h3 class="section-bar">Public Class methods</h3>
 
 
-      <div id="method-M000755" class="method-detail">
-        <a name="M000755"></a>
+      <div id="method-M000497" class="method-detail">
+        <a name="M000497"></a>
 
         <div class="method-heading">
 
-          <a href="#M000755" class="method-signature">
+          <a href="#M000497" class="method-signature">
 
-          <span class="method-name">new</span><span class="method-args">(journal, date, headline, property)</span>
+          <span class="method-name">new</span><span class="method-args">(journal, date, headline, property, sourceFileInfo = nil)</span>
 
           </a>
 
@@ -181,20 +218,39 @@
 
         <div class="method-description">
 
+          <p>
+Create a new <a href="JournalEntry.html">JournalEntry</a> object.
+</p>
+
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000755-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000755-source">
+            onclick="toggleCode('M000497-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000497-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/Journal.rb, line 20</span>
-20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">journal</span>, <span class="ruby-identifier">date</span>, <span class="ruby-identifier">headline</span>, <span class="ruby-identifier">property</span>)
-21:       <span class="ruby-ivar">@journal</span> = <span class="ruby-identifier">journal</span>
-22:       <span class="ruby-ivar">@journal</span>.<span class="ruby-identifier">addEntry</span>(<span class="ruby-keyword kw">self</span>)
-23:       <span class="ruby-ivar">@date</span> = <span class="ruby-identifier">date</span>
-24:       <span class="ruby-ivar">@headline</span> = <span class="ruby-identifier">headline</span>
-25:       <span class="ruby-ivar">@property</span> = <span class="ruby-identifier">property</span>
-26:       <span class="ruby-ivar">@intro</span> = <span class="ruby-keyword kw">nil</span>
-27:       <span class="ruby-ivar">@more</span> = <span class="ruby-keyword kw">nil</span>
-28:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/Journal.rb, line 27</span>
+27:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">journal</span>, <span class="ruby-identifier">date</span>, <span class="ruby-identifier">headline</span>, <span class="ruby-identifier">property</span>, <span class="ruby-identifier">sourceFileInfo</span> = <span class="ruby-keyword kw">nil</span>)
+28:       <span class="ruby-comment cmt"># A reference to the Journal object this entry belongs to.</span>
+29:       <span class="ruby-ivar">@journal</span> = <span class="ruby-identifier">journal</span>
+30:       <span class="ruby-comment cmt"># The date of the entry.</span>
+31:       <span class="ruby-ivar">@date</span> = <span class="ruby-identifier">date</span>
+32:       <span class="ruby-comment cmt"># A very short description. Should not be longer than about 40</span>
+33:       <span class="ruby-comment cmt"># characters.</span>
+34:       <span class="ruby-ivar">@headline</span> = <span class="ruby-identifier">headline</span>
+35:       <span class="ruby-comment cmt"># A reference to a PropertyTreeNode object.</span>
+36:       <span class="ruby-ivar">@property</span> = <span class="ruby-identifier">property</span>
+37:       <span class="ruby-comment cmt"># Source file location of this entry of type SourceFileInfo</span>
+38:       <span class="ruby-ivar">@sourceFileInfo</span> = <span class="ruby-identifier">sourceFileInfo</span>
+39:       <span class="ruby-comment cmt"># A reference to a Resource.</span>
+40:       <span class="ruby-ivar">@author</span> = <span class="ruby-keyword kw">nil</span>
+41:       <span class="ruby-comment cmt"># An introductory or summarizing RichText paragraph.</span>
+42:       <span class="ruby-ivar">@summary</span> = <span class="ruby-keyword kw">nil</span>
+43:       <span class="ruby-comment cmt"># A RichText of arbitrary length.</span>
+44:       <span class="ruby-ivar">@details</span> = <span class="ruby-keyword kw">nil</span>
+45:       <span class="ruby-comment cmt"># The alert level.</span>
+46:       <span class="ruby-ivar">@alertLevel</span> = <span class="ruby-value">0</span>
+47: 
+48:       <span class="ruby-comment cmt"># Add the new entry to the journal.</span>
+49:       <span class="ruby-ivar">@journal</span>.<span class="ruby-identifier">addEntry</span>(<span class="ruby-keyword kw">self</span>)
+50:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>