Update documentation

Author: joniles

docs/404.html

@@ -1060,6 +1060,27 @@
 
 
 
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="/howto-read-openplan/" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Deltek Open Plan BK3 files
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
 

docs/CHANGELOG/index.html

@@ -291,9 +291,18 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#1271-unreleased" class="md-nav__link">
+  <a href="#1281-unreleased" class="md-nav__link">
     <span class="md-ellipsis">
-      12.7.1 (unreleased)
+      12.8.1 (unreleased)
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#1280-2024-03-04" class="md-nav__link">
+    <span class="md-ellipsis">
+      12.8.0 (2024-03-04)
     </span>
   </a>
 
@@ -3217,6 +3226,27 @@
 
 
 
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../howto-read-openplan/" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Deltek Open Plan BK3 files
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
 
@@ -3674,9 +3704,18 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#1271-unreleased" class="md-nav__link">
+  <a href="#1281-unreleased" class="md-nav__link">
     <span class="md-ellipsis">
-      12.7.1 (unreleased)
+      12.8.1 (unreleased)
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#1280-2024-03-04" class="md-nav__link">
+    <span class="md-ellipsis">
+      12.8.0 (2024-03-04)
     </span>
   </a>
 
@@ -5795,7 +5834,23 @@
 
 
 <h1 id="changelog">Changelog</h1>
-<h2 id="1271-unreleased">12.7.1 (unreleased)</h2>
+<h2 id="1281-unreleased">12.8.1 (unreleased)</h2>
+<h2 id="1280-2024-03-04">12.8.0 (2024-03-04)</h2>
+<ul>
+<li>Add experimental support for reading Deltek Open Plan BK3 files.</li>
+<li>Implemented the <code>Relation.Builder</code> class.</li>
+<li>Marked the <code>Relation(Task,Task,RelationType,Duration)</code> constructor as deprecated, use the <code>Relation.Builder</code> class instead.</li>
+<li>Marked the <code>RelationContainer.addPredecessor(Task,Task,RelationType,Duration)</code> method as deprecated, use the <code>RelationContainer.addPredecessor(Relation.Builder)</code> method instead.</li>
+<li>Marked the <code>Task.addPredecessor(Task,RelationType,Duration)</code> method as deprecated, use the <code>Task.addPredecessor(Relation.Builder)</code> method instead.</li>
+<li>Add a notes attribute to the <code>Relation</code> class and ensure that it is read from and written to P6 schedules.</li>
+<li>Read the Relationship Lag Calendar setting from Phoenix 5 files. (Contributed by Rohit Sinha)</li>
+<li>Don't write a material label to an MSPDI file for a resource which isn't a material.</li>
+<li>Update representation of Work Variance when writing MSPDI files to more closely match output from Microsoft Project.</li>
+<li>Updated to ensure that when schedules are read from XER files or P6 databases, labor and nonlabor work amounts are combined for the Actual, Remaining and Planned work attributes. This is now consistent with the existing behavior when reading PMXML files.</li>
+<li>Added support for new Task attributes Actual Work Labor, Actual Work Nonlabor, Remaining Work Labor, Remaining Work Nonlabor, Planned Work Labor, Planned Work Nonlabor, when reading and writing P6 schedules.</li>
+<li>Update default <code>readAll</code> method on reader classes to ensure that if the reader is unable to read any schedule data, an empty list is returned rather than a list containing <code>null</code>.</li>
+<li>Ensure that Task Start and Finish dates are both the same when reading milestones from PMXML files, and that the correct date is used depending on whether we have a Start Milestone or a Finish Milestone.</li>
+</ul>
 <h2 id="1270-2024-02-07">12.7.0 (2024-02-07)</h2>
 <ul>
 <li>Added support for reading and writing the project property Baseline Calendar Name to and from MPP and MSPDI files.</li>

docs/apidocs/allclasses-frame.html

@@ -4,7 +4,7 @@
 <head>
 <!-- Generated by javadoc -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>All Classes (MPXJ 12.7.0 API)</title>
+<title>All Classes (MPXJ 12.8.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -178,6 +178,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/common/CloseIgnoringInputStream.html" title="class in net.sf.mpxj.common" target="classFrame">CloseIgnoringInputStream</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/CodeAssignmentType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">CodeAssignmentType</a></li>
 <li><a href="net/sf/mpxj/CodePage.html" title="enum in net.sf.mpxj" target="classFrame">CodePage</a></li>
+<li><a href="net/sf/mpxj/openplan/CodeValue.html" title="class in net.sf.mpxj.openplan" target="classFrame">CodeValue</a></li>
 <li><a href="net/sf/mpxj/common/ColorHelper.html" title="class in net.sf.mpxj.common" target="classFrame">ColorHelper</a></li>
 <li><a href="net/sf/mpxj/mpp/ColorType.html" title="enum in net.sf.mpxj.mpp" target="classFrame">ColorType</a></li>
 <li><a href="net/sf/mpxj/Column.html" title="class in net.sf.mpxj" target="classFrame">Column</a></li>
@@ -241,6 +242,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/ganttproject/schema/DefaultWeek.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">DefaultWeek</a></li>
 <li><a href="net/sf/mpxj/planner/schema/DefaultWeek.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">DefaultWeek</a></li>
 <li><a href="net/sf/mpxj/ganttproject/schema/Depend.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">Depend</a></li>
+<li><a href="net/sf/mpxj/openplan/DependenciesReader.html" title="class in net.sf.mpxj.openplan" target="classFrame">DependenciesReader</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/DisplayCurrencyType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">DisplayCurrencyType</a></li>
 <li><a href="net/sf/mpxj/conceptdraw/schema/Document.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">Document</a></li>
 <li><a href="net/sf/mpxj/conceptdraw/schema/Document.Calendars.html" title="class in net.sf.mpxj.conceptdraw.schema" target="classFrame">Document.Calendars</a></li>
@@ -516,6 +518,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/common/ObjectSequence.html" title="class in net.sf.mpxj.common" target="classFrame">ObjectSequence</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/OBSType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">OBSType</a></li>
 <li><a href="net/sf/mpxj/ganttproject/schema/OnlyShowWeekends.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">OnlyShowWeekends</a></li>
+<li><a href="net/sf/mpxj/openplan/OpenPlanReader.html" title="class in net.sf.mpxj.openplan" target="classFrame">OpenPlanReader</a></li>
 <li><a href="net/sf/mpxj/ikvm/OperatingSystem.html" title="class in net.sf.mpxj.ikvm" target="classFrame">OperatingSystem</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/OverheadCodeType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">OverheadCodeType</a></li>
 <li><a href="net/sf/mpxj/planner/schema/OverriddenDayType.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">OverriddenDayType</a></li>
@@ -675,6 +678,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/RecurringData.html" title="class in net.sf.mpxj" target="classFrame">RecurringData</a></li>
 <li><a href="net/sf/mpxj/RecurringTask.html" title="class in net.sf.mpxj" target="classFrame">RecurringTask</a></li>
 <li><a href="net/sf/mpxj/Relation.html" title="class in net.sf.mpxj" target="classFrame">Relation</a></li>
+<li><a href="net/sf/mpxj/Relation.Builder.html" title="class in net.sf.mpxj" target="classFrame">Relation.Builder</a></li>
 <li><a href="net/sf/mpxj/RelationContainer.html" title="class in net.sf.mpxj" target="classFrame">RelationContainer</a></li>
 <li><a href="net/sf/mpxj/RelationshipLagCalendar.html" title="enum in net.sf.mpxj" target="classFrame">RelationshipLagCalendar</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/RelationshipType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">RelationshipType</a></li>

docs/apidocs/allclasses-noframe.html

@@ -4,7 +4,7 @@
 <head>
 <!-- Generated by javadoc -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>All Classes (MPXJ 12.7.0 API)</title>
+<title>All Classes (MPXJ 12.8.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -178,6 +178,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/common/CloseIgnoringInputStream.html" title="class in net.sf.mpxj.common">CloseIgnoringInputStream</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/CodeAssignmentType.html" title="class in net.sf.mpxj.primavera.schema">CodeAssignmentType</a></li>
 <li><a href="net/sf/mpxj/CodePage.html" title="enum in net.sf.mpxj">CodePage</a></li>
+<li><a href="net/sf/mpxj/openplan/CodeValue.html" title="class in net.sf.mpxj.openplan">CodeValue</a></li>
 <li><a href="net/sf/mpxj/common/ColorHelper.html" title="class in net.sf.mpxj.common">ColorHelper</a></li>
 <li><a href="net/sf/mpxj/mpp/ColorType.html" title="enum in net.sf.mpxj.mpp">ColorType</a></li>
 <li><a href="net/sf/mpxj/Column.html" title="class in net.sf.mpxj">Column</a></li>
@@ -241,6 +242,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/ganttproject/schema/DefaultWeek.html" title="class in net.sf.mpxj.ganttproject.schema">DefaultWeek</a></li>
 <li><a href="net/sf/mpxj/planner/schema/DefaultWeek.html" title="class in net.sf.mpxj.planner.schema">DefaultWeek</a></li>
 <li><a href="net/sf/mpxj/ganttproject/schema/Depend.html" title="class in net.sf.mpxj.ganttproject.schema">Depend</a></li>
+<li><a href="net/sf/mpxj/openplan/DependenciesReader.html" title="class in net.sf.mpxj.openplan">DependenciesReader</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/DisplayCurrencyType.html" title="class in net.sf.mpxj.primavera.schema">DisplayCurrencyType</a></li>
 <li><a href="net/sf/mpxj/conceptdraw/schema/Document.html" title="class in net.sf.mpxj.conceptdraw.schema">Document</a></li>
 <li><a href="net/sf/mpxj/conceptdraw/schema/Document.Calendars.html" title="class in net.sf.mpxj.conceptdraw.schema">Document.Calendars</a></li>
@@ -516,6 +518,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/common/ObjectSequence.html" title="class in net.sf.mpxj.common">ObjectSequence</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/OBSType.html" title="class in net.sf.mpxj.primavera.schema">OBSType</a></li>
 <li><a href="net/sf/mpxj/ganttproject/schema/OnlyShowWeekends.html" title="class in net.sf.mpxj.ganttproject.schema">OnlyShowWeekends</a></li>
+<li><a href="net/sf/mpxj/openplan/OpenPlanReader.html" title="class in net.sf.mpxj.openplan">OpenPlanReader</a></li>
 <li><a href="net/sf/mpxj/ikvm/OperatingSystem.html" title="class in net.sf.mpxj.ikvm">OperatingSystem</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/OverheadCodeType.html" title="class in net.sf.mpxj.primavera.schema">OverheadCodeType</a></li>
 <li><a href="net/sf/mpxj/planner/schema/OverriddenDayType.html" title="class in net.sf.mpxj.planner.schema">OverriddenDayType</a></li>
@@ -675,6 +678,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="net/sf/mpxj/RecurringData.html" title="class in net.sf.mpxj">RecurringData</a></li>
 <li><a href="net/sf/mpxj/RecurringTask.html" title="class in net.sf.mpxj">RecurringTask</a></li>
 <li><a href="net/sf/mpxj/Relation.html" title="class in net.sf.mpxj">Relation</a></li>
+<li><a href="net/sf/mpxj/Relation.Builder.html" title="class in net.sf.mpxj">Relation.Builder</a></li>
 <li><a href="net/sf/mpxj/RelationContainer.html" title="class in net.sf.mpxj">RelationContainer</a></li>
 <li><a href="net/sf/mpxj/RelationshipLagCalendar.html" title="enum in net.sf.mpxj">RelationshipLagCalendar</a></li>
 <li><a href="net/sf/mpxj/primavera/schema/RelationshipType.html" title="class in net.sf.mpxj.primavera.schema">RelationshipType</a></li>

docs/apidocs/constant-values.html

@@ -4,7 +4,7 @@
 <head>
 <!-- Generated by javadoc -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Constant Field Values (MPXJ 12.7.0 API)</title>
+<title>Constant Field Values (MPXJ 12.8.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -19,7 +19,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (MPXJ 12.7.0 API)";
+            parent.document.title="Constant Field Values (MPXJ 12.8.0 API)";
         }
     }
     catch(err) {
@@ -220,7 +220,7 @@ <h2 title="net.sf">net.sf.*</h2>
 <!--   -->
 </a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td><code><a href="net/sf/mpxj/MPXJ.html#VERSION">VERSION</a></code></td>
-<td class="colLast"><code>"12.7.0"</code></td>
+<td class="colLast"><code>"12.8.0"</code></td>
 </tr>
 </tbody>
 </table>