Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed Jan 24, 2023
1 parent 5df2fdf commit be38f71
Show file tree
Hide file tree
Showing 2,044 changed files with 23,172 additions and 12,981 deletions.
33 changes: 28 additions & 5 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,8 +271,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#10151-unreleased" class="md-nav__link">
10.15.1 (unreleased)
<a href="#10161-unreleased" class="md-nav__link">
10.16.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#10160-2023-01-24" class="md-nav__link">
10.16.0 (2023-01-24)
</a>

</li>
Expand Down Expand Up @@ -2524,8 +2531,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#10151-unreleased" class="md-nav__link">
10.15.1 (unreleased)
<a href="#10161-unreleased" class="md-nav__link">
10.16.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#10160-2023-01-24" class="md-nav__link">
10.16.0 (2023-01-24)
</a>

</li>
Expand Down Expand Up @@ -3982,7 +3996,16 @@


<h1 id="changelog">Changelog</h1>
<h2 id="10151-unreleased">10.15.1 (unreleased)</h2>
<h2 id="10161-unreleased">10.16.1 (unreleased)</h2>
<h2 id="10160-2023-01-24">10.16.0 (2023-01-24)</h2>
<ul>
<li>Improve accuracy when normalising timephased data.</li>
<li>Add support for reading activity steps from XER files, PMXML files and Primavera databases.</li>
<li>Add support for writing activity steps to PMXML files.</li>
<li>Updated PMXML schema to version 22.12.</li>
<li>Updated methods in the <code>GanttBarCommonStyle</code> and <code>GanttBarStyle</code> classes to use a <code>FieldType</code> instance rather than a <code>TaskField</code> instance to allow more flexibility. (Note: this may be a breaking change if you are currently using these classes.)</li>
<li>Optionally include some Microsoft Project layout data in JSON output.</li>
</ul>
<h2 id="10150-2023-01-11">10.15.0 (2023-01-11)</h2>
<ul>
<li>Avoid wrtiting invalid characters to PMXML, MSPDI and Planner XML files.</li>
Expand Down
8 changes: 4 additions & 4 deletions docs/apidocs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (MPXJ 10.15.0 API)</title>
<title>All Classes (MPXJ 10.16.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down Expand Up @@ -139,6 +139,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/asta/AstaSqliteReader.html" title="class in net.sf.mpxj.asta" target="classFrame">AstaSqliteReader</a></li>
<li><a href="net/sf/mpxj/asta/AstaTextFileReader.html" title="class in net.sf.mpxj.asta" target="classFrame">AstaTextFileReader</a></li>
<li><a href="net/sf/mpxj/common/AutoCloseableHelper.html" title="class in net.sf.mpxj.common" target="classFrame">AutoCloseableHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/AutovueAttrType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">AutovueAttrType</a></li>
<li><a href="net/sf/mpxj/Availability.html" title="class in net.sf.mpxj" target="classFrame">Availability</a></li>
<li><a href="net/sf/mpxj/AvailabilityTable.html" title="class in net.sf.mpxj" target="classFrame">AvailabilityTable</a></li>
<li><a href="net/sf/mpxj/mpp/BackgroundPattern.html" title="enum in net.sf.mpxj.mpp" target="classFrame">BackgroundPattern</a></li>
Expand Down Expand Up @@ -445,7 +446,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mpd/MPDUtility.html" title="class in net.sf.mpxj.mpd" target="classFrame">MPDUtility</a></li>
<li><a href="net/sf/mpxj/mpp/MPPAbstractTimephasedWorkNormaliser.html" title="class in net.sf.mpxj.mpp" target="classFrame">MPPAbstractTimephasedWorkNormaliser</a></li>
<li><a href="net/sf/mpxj/common/MPPAssignmentField.html" title="class in net.sf.mpxj.common" target="classFrame">MPPAssignmentField</a></li>
<li><a href="net/sf/mpxj/common/MPPAssignmentField14.html" title="class in net.sf.mpxj.common" target="classFrame">MPPAssignmentField14</a></li>
<li><a href="net/sf/mpxj/mpp/MppBitFlag.html" title="class in net.sf.mpxj.mpp" target="classFrame">MppBitFlag</a></li>
<li><a href="net/sf/mpxj/common/MPPConstraintField.html" title="class in net.sf.mpxj.common" target="classFrame">MPPConstraintField</a></li>
<li><a href="net/sf/mpxj/sample/MppDump.html" title="class in net.sf.mpxj.sample" target="classFrame">MppDump</a></li>
Expand All @@ -454,9 +454,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/common/MPPProjectField.html" title="class in net.sf.mpxj.common" target="classFrame">MPPProjectField</a></li>
<li><a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp" target="classFrame">MPPReader</a></li>
<li><a href="net/sf/mpxj/common/MPPResourceField.html" title="class in net.sf.mpxj.common" target="classFrame">MPPResourceField</a></li>
<li><a href="net/sf/mpxj/common/MPPResourceField14.html" title="class in net.sf.mpxj.common" target="classFrame">MPPResourceField14</a></li>
<li><a href="net/sf/mpxj/common/MPPTaskField.html" title="class in net.sf.mpxj.common" target="classFrame">MPPTaskField</a></li>
<li><a href="net/sf/mpxj/common/MPPTaskField14.html" title="class in net.sf.mpxj.common" target="classFrame">MPPTaskField14</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedBaselineCostNormaliser.html" title="class in net.sf.mpxj.mpp" target="classFrame">MPPTimephasedBaselineCostNormaliser</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedBaselineWorkNormaliser.html" title="class in net.sf.mpxj.mpp" target="classFrame">MPPTimephasedBaselineWorkNormaliser</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedWorkNormaliser.html" title="class in net.sf.mpxj.mpp" target="classFrame">MPPTimephasedWorkNormaliser</a></li>
Expand Down Expand Up @@ -739,6 +737,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/common/SplitTaskFactory.html" title="class in net.sf.mpxj.common" target="classFrame">SplitTaskFactory</a></li>
<li><a href="net/sf/mpxj/mpp/SplitView9.html" title="class in net.sf.mpxj.mpp" target="classFrame">SplitView9</a></li>
<li><a href="net/sf/mpxj/common/SQLite.html" title="class in net.sf.mpxj.common" target="classFrame">SQLite</a></li>
<li><a href="net/sf/mpxj/Step.html" title="class in net.sf.mpxj" target="classFrame">Step</a></li>
<li><a href="net/sf/mpxj/primavera/schema/StepUserDefinedValueUpdateType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">StepUserDefinedValueUpdateType</a></li>
<li><a href="net/sf/mpxj/primavera/common/StringColumn.html" title="class in net.sf.mpxj.primavera.common" target="classFrame">StringColumn</a></li>
<li><a href="net/sf/mpxj/StructuredNotes.html" title="class in net.sf.mpxj" target="classFrame">StructuredNotes</a></li>
Expand Down Expand Up @@ -828,6 +827,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/ViewType.html" title="enum in net.sf.mpxj" target="classFrame">ViewType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSCategoryType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">WBSCategoryType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSMilestoneType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">WBSMilestoneType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WbsReviewersType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">WbsReviewersType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">WBSType</a></li>
<li><a href="net/sf/mpxj/WorkContour.html" title="class in net.sf.mpxj" target="classFrame">WorkContour</a></li>
<li><a href="net/sf/mpxj/WorkGroup.html" title="enum in net.sf.mpxj" target="classFrame">WorkGroup</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/apidocs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (MPXJ 10.15.0 API)</title>
<title>All Classes (MPXJ 10.16.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down Expand Up @@ -139,6 +139,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/asta/AstaSqliteReader.html" title="class in net.sf.mpxj.asta">AstaSqliteReader</a></li>
<li><a href="net/sf/mpxj/asta/AstaTextFileReader.html" title="class in net.sf.mpxj.asta">AstaTextFileReader</a></li>
<li><a href="net/sf/mpxj/common/AutoCloseableHelper.html" title="class in net.sf.mpxj.common">AutoCloseableHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/AutovueAttrType.html" title="class in net.sf.mpxj.primavera.schema">AutovueAttrType</a></li>
<li><a href="net/sf/mpxj/Availability.html" title="class in net.sf.mpxj">Availability</a></li>
<li><a href="net/sf/mpxj/AvailabilityTable.html" title="class in net.sf.mpxj">AvailabilityTable</a></li>
<li><a href="net/sf/mpxj/mpp/BackgroundPattern.html" title="enum in net.sf.mpxj.mpp">BackgroundPattern</a></li>
Expand Down Expand Up @@ -445,7 +446,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/mpd/MPDUtility.html" title="class in net.sf.mpxj.mpd">MPDUtility</a></li>
<li><a href="net/sf/mpxj/mpp/MPPAbstractTimephasedWorkNormaliser.html" title="class in net.sf.mpxj.mpp">MPPAbstractTimephasedWorkNormaliser</a></li>
<li><a href="net/sf/mpxj/common/MPPAssignmentField.html" title="class in net.sf.mpxj.common">MPPAssignmentField</a></li>
<li><a href="net/sf/mpxj/common/MPPAssignmentField14.html" title="class in net.sf.mpxj.common">MPPAssignmentField14</a></li>
<li><a href="net/sf/mpxj/mpp/MppBitFlag.html" title="class in net.sf.mpxj.mpp">MppBitFlag</a></li>
<li><a href="net/sf/mpxj/common/MPPConstraintField.html" title="class in net.sf.mpxj.common">MPPConstraintField</a></li>
<li><a href="net/sf/mpxj/sample/MppDump.html" title="class in net.sf.mpxj.sample">MppDump</a></li>
Expand All @@ -454,9 +454,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/common/MPPProjectField.html" title="class in net.sf.mpxj.common">MPPProjectField</a></li>
<li><a href="net/sf/mpxj/mpp/MPPReader.html" title="class in net.sf.mpxj.mpp">MPPReader</a></li>
<li><a href="net/sf/mpxj/common/MPPResourceField.html" title="class in net.sf.mpxj.common">MPPResourceField</a></li>
<li><a href="net/sf/mpxj/common/MPPResourceField14.html" title="class in net.sf.mpxj.common">MPPResourceField14</a></li>
<li><a href="net/sf/mpxj/common/MPPTaskField.html" title="class in net.sf.mpxj.common">MPPTaskField</a></li>
<li><a href="net/sf/mpxj/common/MPPTaskField14.html" title="class in net.sf.mpxj.common">MPPTaskField14</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedBaselineCostNormaliser.html" title="class in net.sf.mpxj.mpp">MPPTimephasedBaselineCostNormaliser</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedBaselineWorkNormaliser.html" title="class in net.sf.mpxj.mpp">MPPTimephasedBaselineWorkNormaliser</a></li>
<li><a href="net/sf/mpxj/mpp/MPPTimephasedWorkNormaliser.html" title="class in net.sf.mpxj.mpp">MPPTimephasedWorkNormaliser</a></li>
Expand Down Expand Up @@ -739,6 +737,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/common/SplitTaskFactory.html" title="class in net.sf.mpxj.common">SplitTaskFactory</a></li>
<li><a href="net/sf/mpxj/mpp/SplitView9.html" title="class in net.sf.mpxj.mpp">SplitView9</a></li>
<li><a href="net/sf/mpxj/common/SQLite.html" title="class in net.sf.mpxj.common">SQLite</a></li>
<li><a href="net/sf/mpxj/Step.html" title="class in net.sf.mpxj">Step</a></li>
<li><a href="net/sf/mpxj/primavera/schema/StepUserDefinedValueUpdateType.html" title="class in net.sf.mpxj.primavera.schema">StepUserDefinedValueUpdateType</a></li>
<li><a href="net/sf/mpxj/primavera/common/StringColumn.html" title="class in net.sf.mpxj.primavera.common">StringColumn</a></li>
<li><a href="net/sf/mpxj/StructuredNotes.html" title="class in net.sf.mpxj">StructuredNotes</a></li>
Expand Down Expand Up @@ -828,6 +827,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/ViewType.html" title="enum in net.sf.mpxj">ViewType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSCategoryType.html" title="class in net.sf.mpxj.primavera.schema">WBSCategoryType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSMilestoneType.html" title="class in net.sf.mpxj.primavera.schema">WBSMilestoneType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WbsReviewersType.html" title="class in net.sf.mpxj.primavera.schema">WbsReviewersType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/WBSType.html" title="class in net.sf.mpxj.primavera.schema">WBSType</a></li>
<li><a href="net/sf/mpxj/WorkContour.html" title="class in net.sf.mpxj">WorkContour</a></li>
<li><a href="net/sf/mpxj/WorkGroup.html" title="enum in net.sf.mpxj">WorkGroup</a></li>
Expand Down
34 changes: 4 additions & 30 deletions docs/apidocs/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Constant Field Values (MPXJ 10.15.0 API)</title>
<title>Constant Field Values (MPXJ 10.16.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (MPXJ 10.15.0 API)";
parent.document.title="Constant Field Values (MPXJ 10.16.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -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>"10.15.0"</code></td>
<td class="colLast"><code>"10.16.0"</code></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -497,32 +497,6 @@ <h2 title="net.sf">net.sf.*</h2>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>net.sf.mpxj.common.<a href="net/sf/mpxj/common/MPPAssignmentField14.html" title="class in net.sf.mpxj.common">MPPAssignmentField14</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="net.sf.mpxj.common.MPPAssignmentField14.ASSIGNMENT_FIELD_BASE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="net/sf/mpxj/common/MPPAssignmentField14.html#ASSIGNMENT_FIELD_BASE">ASSIGNMENT_FIELD_BASE</a></code></td>
<td class="colLast"><code>255852544</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="net.sf.mpxj.common.MPPAssignmentField14.MAX_VALUE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="net/sf/mpxj/common/MPPAssignmentField14.html#MAX_VALUE">MAX_VALUE</a></code></td>
<td class="colLast"><code>715</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>net.sf.mpxj.common.<a href="net/sf/mpxj/common/MPPConstraintField.html" title="class in net.sf.mpxj.common">MPPConstraintField</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
Expand Down Expand Up @@ -573,7 +547,7 @@ <h2 title="net.sf">net.sf.*</h2>
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="net/sf/mpxj/common/MPPResourceField.html#MAX_VALUE">MAX_VALUE</a></code></td>
<td class="colLast"><code>809</code></td>
<td class="colLast"><code>863</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="net.sf.mpxj.common.MPPResourceField.RESOURCE_FIELD_BASE">
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Deprecated List (MPXJ 10.15.0 API)</title>
<title>Deprecated List (MPXJ 10.16.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (MPXJ 10.15.0 API)";
parent.document.title="Deprecated List (MPXJ 10.16.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/help-doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>API Help (MPXJ 10.15.0 API)</title>
<title>API Help (MPXJ 10.16.0 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -19,7 +19,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="API Help (MPXJ 10.15.0 API)";
parent.document.title="API Help (MPXJ 10.16.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit be38f71

Please sign in to comment.