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 22, 2024
1 parent dc6762b commit a9304bc
Show file tree
Hide file tree
Showing 2,174 changed files with 11,658 additions and 10,261 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
@@ -1,6 +1,8 @@
# Changelog

## 12.6.0 (unreleased)
## 12.6.1 (unreleased)

## 12.6.0 (2024-01-22)
* Updated PMXML schema to version 23.12.
* Ensure that baselines in PMXML files written by Oracle Primavera Cloud are read.
* Fix an issue reading certain XER files and P6 databases where activities lost the relationship with their parent WBS entry.
Expand Down
4 changes: 3 additions & 1 deletion docs/404.html
View file
Expand Up @@ -1524,6 +1524,8 @@ <h1>404 - Not found</h1>
</div>


<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

</div>

</main>
Expand Down Expand Up @@ -1552,7 +1554,7 @@ <h1>404 - Not found</h1>
</div>


<script id="__config" type="application/json">{"base": "/", "features": [], "search": "/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "/", "features": ["content.tabs.link"], "search": "/assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.cd18aaf1.min.js"></script>
Expand Down
50 changes: 42 additions & 8 deletions docs/CHANGELOG/index.html
View file
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="#1251-unreleased" class="md-nav__link">
<a href="#1261-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.5.1 (unreleased)
12.6.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1260-2024-01-22" class="md-nav__link">
<span class="md-ellipsis">
12.6.0 (2024-01-22)
</span>
</a>

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

<li class="md-nav__item">
<a href="#1251-unreleased" class="md-nav__link">
<a href="#1261-unreleased" class="md-nav__link">
<span class="md-ellipsis">
12.6.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1260-2024-01-22" class="md-nav__link">
<span class="md-ellipsis">
12.5.1 (unreleased)
12.6.0 (2024-01-22)
</span>
</a>

Expand Down Expand Up @@ -5759,7 +5777,21 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1251-unreleased">12.5.1 (unreleased)</h2>
<h2 id="1261-unreleased">12.6.1 (unreleased)</h2>
<h2 id="1260-2024-01-22">12.6.0 (2024-01-22)</h2>
<ul>
<li>Updated PMXML schema to version 23.12.</li>
<li>Ensure that baselines in PMXML files written by Oracle Primavera Cloud are read.</li>
<li>Fix an issue reading certain XER files and P6 databases where activities lost the relationship with their parent WBS entry.</li>
<li>Added <code>ResourceAssignment.getEffectiveCalendar</code> method.</li>
<li>Deprecated <code>ResourceAssignment.getCalendar</code> method, use <code>getEffectiveCalendar</code> method instead.</li>
<li>Improved reading timephased baseline work from MPP files.</li>
<li>Added new versions of the <code>TimephasedUtility.segmentBaselineWork</code> and <code>segmentBaselineCost</code> methods which take a <code>ProjectCalendar</code> instance as the first argument rather than a <code>ProjectFile</code> instance.</li>
<li>Deprecated the <code>TimephasedUtility.segmentBaselineWork</code> and <code>segmentBaselineCost</code> methods which take a <code>ProjectFile</code> instance as the first argument.</li>
<li>Added a new version of the <code>ProjectCalendar.getDate()</code> method which just takes a date and a duration as its arguments. This method handles both positive and negative durations.</li>
<li>Marked the original version of the <code>ProjectCalendar.getDate()</code> method as deprecated. Use the new version instead.</li>
<li>Improve recognition of task splits when reading MPP and MSPDI files.</li>
</ul>
<h2 id="1250-2023-12-18">12.5.0 (2023-12-18)</h2>
<ul>
<li>Add support for the following Resource Assignment attributes: Remaining Early Start, Remaining Early Finish, Remaining Late Start, and Remaining Late Finish.</li>
Expand Down Expand Up @@ -6512,7 +6544,7 @@ <h2 id="834-2020-12-10">8.3.4 (2020-12-10)</h2>
<li>Updated PMXML schema to version 19.12.</li>
<li>Ensure that we always set the activity planned start and planned finish dates when writing a PMXML file.</li>
<li>Updated the getPopulatedFields methods to ignore fields with default values.</li>
<li>Made the Resource ID attribute available as a resource's TEXT1 custom field, with the alias "Resource ID" when reading PMXML and XER files, or from a P^ database. (Note that presently for XER files and P6 databases, the Resource ID value is also read into the initials attribute. This behaviour is deprecated and will be removed in the next major MPXJ release).</li>
<li>Made the Resource ID attribute available as a resource's TEXT1 custom field, with the alias "Resource ID" when reading PMXML and XER files, or from a P6 database. (Note that presently for XER files and P6 databases, the Resource ID value is also read into the initials attribute. This behaviour is deprecated and will be removed in the next major MPXJ release).</li>
<li>Populate the Resource ID with the value read from a P6 schedule when writing a PMXML file.</li>
<li>Ensure that the hours per day, week, month and year attributes are read from and written to PMXML files.</li>
<li>Fix an issue causing the hours per day calendar attribute to be read inaccurately from XER files and P6 databases.</li>
Expand All @@ -6523,7 +6555,7 @@ <h2 id="833-2020-11-24">8.3.3 (2020-11-24)</h2>
<ul>
<li>Added cost rate table support when reading from and writing to PMXML files.</li>
<li>Added a getPopulatedFields method to the TaskContainer, ResourceContainer and ResourceAssignmentContainer classes. This will retrieve the set of fields which are populated with a non-null value across the whole project for Tasks, Resources, and ResourceAssignments respectively. </li>
<li>Add START_ON, FINISH_ON constraint types. Deprecate MANDATORY_START, MANDATORY_FINISH constraint types. MANDATORY_START/FINISH are now represented as MUST_START/FINISH_ON. This change allows users to distinguish between START/FINISH_ON and the MANDATORY_* constraints when reading P6 schedules.</li>
<li>Add START_ON, FINISH_ON constraint types. § MANDATORY_START, MANDATORY_FINISH constraint types. MANDATORY_START/FINISH are now represented as MUST_START/FINISH_ON. This change allows users to distinguish between START/FINISH_ON and the MANDATORY_* constraints when reading P6 schedules.</li>
<li>Improve handling of cost rate tables and availability tables when writing to an MSPDI file.</li>
<li>Handle P6 databases and XER files with user defined fields of type FT_FLOAT.</li>
<li>Align invalid XER record behaviour with P6.</li>
Expand Down Expand Up @@ -8017,6 +8049,8 @@ <h2 id="008-2003-03-27">0.0.8 (2003-03-27)</h2>
</div>


<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

</div>

</main>
Expand Down Expand Up @@ -8045,7 +8079,7 @@ <h2 id="008-2003-03-27">0.0.8 (2003-03-27)</h2>
</div>


<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["content.tabs.link"], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.cd18aaf1.min.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/allclasses-frame.html
View file
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.5.0 API)</title>
<title>All Classes (MPXJ 12.6.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
2 changes: 1 addition & 1 deletion docs/apidocs/allclasses-noframe.html
View file
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.5.0 API)</title>
<title>All Classes (MPXJ 12.6.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
8 changes: 4 additions & 4 deletions docs/apidocs/constant-values.html
View file
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.5.0 API)</title>
<title>Constant Field Values (MPXJ 12.6.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.5.0 API)";
parent.document.title="Constant Field Values (MPXJ 12.6.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.5.0"</code></td>
<td class="colLast"><code>"12.6.0"</code></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -961,6 +961,6 @@ <h2 title="net.sf">net.sf.*</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2023 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>
26 changes: 23 additions & 3 deletions docs/apidocs/deprecated-list.html
View file
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 12.5.0 API)</title>
<title>Deprecated List (MPXJ 12.6.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 12.5.0 API)";
parent.document.title="Deprecated List (MPXJ 12.6.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -126,6 +126,16 @@ <h2 title="Contents">Contents</h2>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/ResourceAssignment.html#getCalendar--">net.sf.mpxj.ResourceAssignment.getCalendar()</a>
<div class="block"><span class="deprecationComment">use getEffectveCalendar instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectCalendar.html#getDate-java.time.LocalDateTime-net.sf.mpxj.Duration-boolean-">net.sf.mpxj.ProjectCalendar.getDate(LocalDateTime, Duration, boolean)</a>
<div class="block"><span class="deprecationComment">use getDate method without the "returnNextWorkStart" boolean argument</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/ProjectConfig.html#getNextCalendarUniqueID--">net.sf.mpxj.ProjectConfig.getNextCalendarUniqueID()</a>
<div class="block"><span class="deprecationComment">use ProjectFile.getCalendars().getNextUniqueID()</span></div>
</td>
Expand Down Expand Up @@ -171,6 +181,16 @@ <h2 title="Contents">Contents</h2>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/utility/TimephasedUtility.html#segmentBaselineCost-net.sf.mpxj.ProjectFile-java.util.List-net.sf.mpxj.mpp.TimescaleUnits-java.util.ArrayList-">net.sf.mpxj.utility.TimephasedUtility.segmentBaselineCost(ProjectFile, List&lt;TimephasedCost&gt;, TimescaleUnits, ArrayList&lt;LocalDateTimeRange&gt;)</a>
<div class="block"><span class="deprecationComment">use version of this method which takes a ProjectCalendar rather than a ProjectFile as its first argument</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="net/sf/mpxj/utility/TimephasedUtility.html#segmentBaselineWork-net.sf.mpxj.ProjectFile-java.util.List-net.sf.mpxj.mpp.TimescaleUnits-java.util.ArrayList-">net.sf.mpxj.utility.TimephasedUtility.segmentBaselineWork(ProjectFile, List&lt;TimephasedWork&gt;, TimescaleUnits, ArrayList&lt;LocalDateTimeRange&gt;)</a>
<div class="block"><span class="deprecationComment">use version of this method which takes a ProjectCalendar rather than a ProjectFile as its first argument</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="net/sf/mpxj/ExpenseItem.html#setAccount-net.sf.mpxj.CostAccount-">net.sf.mpxj.ExpenseItem.setAccount(CostAccount)</a>
<div class="block"><span class="deprecationComment">use builder class</span></div>
</td>
Expand Down Expand Up @@ -483,6 +503,6 @@ <h2 title="Contents">Contents</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2023 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/apidocs/help-doc.html
View file
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 12.5.0 API)</title>
<title>API Help (MPXJ 12.6.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 12.5.0 API)";
parent.document.title="API Help (MPXJ 12.6.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -232,6 +232,6 @@ <h2>Constant Field Values</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2023 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2000&#x2013;2024 <a href="http://mpxj.org">Packwood Software</a>. All rights reserved.</small></p>
</body>
</html>

0 comments on commit a9304bc

Please sign in to comment.