Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed Apr 11, 2024
1 parent 566b49e commit b5277a3
Show file tree
Hide file tree
Showing 2,193 changed files with 10,739 additions and 8,392 deletions.
21 changes: 21 additions & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1358,6 +1358,27 @@









<li class="md-nav__item">
<a href="/howto-use-universal/" class="md-nav__link">


<span class="md-ellipsis">
Universal Project Reader
</span>


</a>
</li>




</ul>
</nav>

Expand Down
61 changes: 56 additions & 5 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1282-unreleased" class="md-nav__link">
<a href="#1291-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.8.2 (unreleased)
12.9.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1290-2024-04-11" class="md-nav__link">
<span class="md-ellipsis">
12.9.0 (2024-04-11)
</span>
</a>

Expand Down Expand Up @@ -3533,6 +3542,27 @@









<li class="md-nav__item">
<a href="../howto-use-universal/" class="md-nav__link">


<span class="md-ellipsis">
Universal Project Reader
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -3713,9 +3743,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1282-unreleased" class="md-nav__link">
<a href="#1291-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.8.2 (unreleased)
12.9.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1290-2024-04-11" class="md-nav__link">
<span class="md-ellipsis">
12.9.0 (2024-04-11)
</span>
</a>

Expand Down Expand Up @@ -5852,7 +5891,19 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1282-unreleased">12.8.2 (unreleased)</h2>
<h2 id="1291-unreleased">12.9.1 (unreleased)</h2>
<h2 id="1290-2024-04-11">12.9.0 (2024-04-11)</h2>
<ul>
<li>Updated <code>UniversalProjectReader</code> to add <code>getProjectReaderProxy</code> methods to allow access to the instance of the reader class which will be used to read a schedule, prior to the schedule being read. This will allow the reader to be configured, or schedule to be ignored without reading its content.</li>
<li>Deprecated the <code>ProjectReader.setProperties</code> method. This method was originally implemented to allow settings to be passed to reader classes when using <code>UniversalProjectReader</code>. You can now use <code>UniversalProjectReader.getProjectReaderProxy</code> to achieve this.</li>
<li>Add <code>from</code> method to all <code>Builder</code> classes to allow initialisation from existing objects.</li>
<li>The <code>CostAccount.Builder</code> class now provides two <code>notes</code> methods to allow formatted or unformatted notes to be added to cost accounts.</li>
<li>The <code>CostAccount</code> method <code>getDescription()</code> has been marked as deprecated. Use the <code>getNotes()</code> or <code>getNotesObject()</code> method instead.</li>
<li>The <code>CustomFieldValueItem</code> methods <code>getParent</code> and <code>setParent</code> have been marked as deprecated. Use the <code>getParentUniqueID</code> and <code>setParentUniqueID</code> methods instead.</li>
<li>JSON output from MPXJ now includes more detail for custom field definitions read from MPP files.</li>
<li>When reading a PMXML file, populate the Early/Late Start/Finish date attributes from the Remaining Early/Late Start/Finish date attributes.</li>
<li>Fix an issue reading WBS ID for P3 and SureTrak schedules.</li>
</ul>
<h2 id="1281-2024-03-11">12.8.1 (2024-03-11)</h2>
<ul>
<li>Improve reading resource assignments from certain FastTrack FTS files.</li>
Expand Down
6 changes: 2 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 12.8.1 API)</title>
<title>All Classes (MPXJ 12.9.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 @@ -206,9 +206,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/CustomFieldValueDataType.html" title="enum in net.sf.mpxj" target="classFrame">CustomFieldValueDataType</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueItem.html" title="class in net.sf.mpxj.mpp" target="classFrame">CustomFieldValueItem</a></li>
<li><a href="net/sf/mpxj/CustomFieldValueMask.html" title="class in net.sf.mpxj" target="classFrame">CustomFieldValueMask</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader.html" title="class in net.sf.mpxj.mpp" target="classFrame">CustomFieldValueReader</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader12.html" title="class in net.sf.mpxj.mpp" target="classFrame">CustomFieldValueReader12</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader14.html" title="class in net.sf.mpxj.mpp" target="classFrame">CustomFieldValueReader14</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader9.html" title="class in net.sf.mpxj.mpp" target="classFrame">CustomFieldValueReader9</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/CustomPropertyDefinition.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">CustomPropertyDefinition</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/CustomResourceProperty.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">CustomResourceProperty</a></li>
Expand Down Expand Up @@ -836,6 +833,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/UnitOfMeasureContainer.html" title="class in net.sf.mpxj" target="classFrame">UnitOfMeasureContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UnitOfMeasureType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UnitOfMeasureType</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.html" title="class in net.sf.mpxj.reader" target="classFrame">UniversalProjectReader</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.ProjectReaderProxy.html" title="interface in net.sf.mpxj.reader" target="classFrame"><span class="interfaceName">UniversalProjectReader.ProjectReaderProxy</span></a></li>
<li><a href="net/sf/mpxj/common/UnmarshalHelper.html" title="class in net.sf.mpxj.common" target="classFrame">UnmarshalHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UpdateBaselineOptionType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UpdateBaselineOptionType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UserConsentType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">UserConsentType</a></li>
Expand Down
6 changes: 2 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 12.8.1 API)</title>
<title>All Classes (MPXJ 12.9.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 @@ -206,9 +206,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/CustomFieldValueDataType.html" title="enum in net.sf.mpxj">CustomFieldValueDataType</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueItem.html" title="class in net.sf.mpxj.mpp">CustomFieldValueItem</a></li>
<li><a href="net/sf/mpxj/CustomFieldValueMask.html" title="class in net.sf.mpxj">CustomFieldValueMask</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader.html" title="class in net.sf.mpxj.mpp">CustomFieldValueReader</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader12.html" title="class in net.sf.mpxj.mpp">CustomFieldValueReader12</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader14.html" title="class in net.sf.mpxj.mpp">CustomFieldValueReader14</a></li>
<li><a href="net/sf/mpxj/mpp/CustomFieldValueReader9.html" title="class in net.sf.mpxj.mpp">CustomFieldValueReader9</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/CustomPropertyDefinition.html" title="class in net.sf.mpxj.ganttproject.schema">CustomPropertyDefinition</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/CustomResourceProperty.html" title="class in net.sf.mpxj.ganttproject.schema">CustomResourceProperty</a></li>
Expand Down Expand Up @@ -836,6 +833,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/UnitOfMeasureContainer.html" title="class in net.sf.mpxj">UnitOfMeasureContainer</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UnitOfMeasureType.html" title="class in net.sf.mpxj.primavera.schema">UnitOfMeasureType</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.html" title="class in net.sf.mpxj.reader">UniversalProjectReader</a></li>
<li><a href="net/sf/mpxj/reader/UniversalProjectReader.ProjectReaderProxy.html" title="interface in net.sf.mpxj.reader"><span class="interfaceName">UniversalProjectReader.ProjectReaderProxy</span></a></li>
<li><a href="net/sf/mpxj/common/UnmarshalHelper.html" title="class in net.sf.mpxj.common">UnmarshalHelper</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UpdateBaselineOptionType.html" title="class in net.sf.mpxj.primavera.schema">UpdateBaselineOptionType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/UserConsentType.html" title="class in net.sf.mpxj.primavera.schema">UserConsentType</a></li>
Expand Down
6 changes: 3 additions & 3 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 12.8.1 API)</title>
<title>Constant Field Values (MPXJ 12.9.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 12.8.1 API)";
parent.document.title="Constant Field Values (MPXJ 12.9.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>"12.8.1"</code></td>
<td class="colLast"><code>"12.9.0"</code></td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit b5277a3

Please sign in to comment.