Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed Oct 17, 2024
1 parent 6c54148 commit d18d6d1
Show file tree
Hide file tree
Showing 2,162 changed files with 6,856 additions and 6,648 deletions.
31 changes: 26 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="#1350-unreleased" class="md-nav__link">
<a href="#1351-unreleased" class="md-nav__link">
<span class="md-ellipsis">
13.5.0 (unreleased)
13.5.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1350-2024-10-17" class="md-nav__link">
<span class="md-ellipsis">
13.5.0 (2024-10-17)
</span>
</a>

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

<li class="md-nav__item">
<a href="#1350-unreleased" class="md-nav__link">
<a href="#1351-unreleased" class="md-nav__link">
<span class="md-ellipsis">
13.5.1 (unreleased)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#1350-2024-10-17" class="md-nav__link">
<span class="md-ellipsis">
13.5.0 (unreleased)
13.5.0 (2024-10-17)
</span>
</a>

Expand Down Expand Up @@ -6285,10 +6303,13 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1350-unreleased">13.5.0 (unreleased)</h2>
<h2 id="1351-unreleased">13.5.1 (unreleased)</h2>
<h2 id="1350-2024-10-17">13.5.0 (2024-10-17)</h2>
<ul>
<li>Added support for reading and writing Resource Role Assignments for Primavera schedules. The <code>Resource.getRoleAssignments()</code> method retrieves a map representing the roles a resource is assigned to, along with the skill level for each assignment. The <code>Resource.addRoleAssignment()</code> and <code>Resource.removeRoleAssignment()</code> methods allow role assignments to be added and removed.</li>
<li>Added support for the Resource Primary Role attribute, which is read from and written to Primavera schedules.</li>
<li>Improve handling Boolean attributes with default values when reading XER files.</li>
<li>Added the <code>getShowStartText</code>, <code>getShowFinishText</code> and <code>getShowDurationText</code> methods to the <code>Task</code> class. When working with manually scheduled tasks in Microsoft Project, users can potentially supply arbitrary text for the Start, Finish and Duration attributes. Microsoft Project still stores appropriate values for these attributes, which can be accessed in MPXJ as Start, Finish and Duration, but where the user has supplied text, these attributes are available as Start Text, Finish Text, and Duration Text. The methods added by this change allow the caller to determine which version of each attribute should be shown to the user in order to replicate what they see in Microsoft Project.</li>
</ul>
<h2 id="1342-2024-10-08">13.4.2 (2024-10-08)</h2>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion 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 13.4.2 API)</title>
<title>All Classes (MPXJ 13.5.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
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 13.4.2 API)</title>
<title>All Classes (MPXJ 13.5.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
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 13.4.2 API)</title>
<title>Constant Field Values (MPXJ 13.5.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 13.4.2 API)";
parent.document.title="Constant Field Values (MPXJ 13.5.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>"13.4.2"</code></td>
<td class="colLast"><code>"13.5.0"</code></td>
</tr>
</tbody>
</table>
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 13.4.2 API)</title>
<title>Deprecated List (MPXJ 13.5.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 13.4.2 API)";
parent.document.title="Deprecated List (MPXJ 13.5.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 13.4.2 API)</title>
<title>API Help (MPXJ 13.5.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 13.4.2 API)";
parent.document.title="API Help (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
21 changes: 17 additions & 4 deletions docs/apidocs/index-all.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>Index (MPXJ 13.4.2 API)</title>
<title>Index (MPXJ 13.5.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="Index (MPXJ 13.4.2 API)";
parent.document.title="Index (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -29765,8 +29765,6 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Gets the value of the rolesetName property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/PrimaveraXERFileWriter.html#getRoleShortName-net.sf.mpxj.Resource-">getRoleShortName(Resource)</a></span> - Static method in class net.sf.mpxj.primavera.<a href="net/sf/mpxj/primavera/PrimaveraXERFileWriter.html" title="class in net.sf.mpxj.primavera">PrimaveraXERFileWriter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/ResourceAssignmentType.html#getRoleShortName--">getRoleShortName()</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/ResourceAssignmentType.html" title="class in net.sf.mpxj.primavera.schema">ResourceAssignmentType</a></dt>
<dd>
<div class="block">Gets the value of the roleShortName property.</div>
Expand Down Expand Up @@ -30466,6 +30464,16 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieve the show drawings flag.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Task.html#getShowDurationText--">getShowDurationText()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Task.html" title="class in net.sf.mpxj">Task</a></dt>
<dd>
<div class="block">Returns true for manually scheduled tasks if the Duration Text attribute should be
displayed to the user rather than the Duration attribute.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Task.html#getShowFinishText--">getShowFinishText()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Task.html" title="class in net.sf.mpxj">Task</a></dt>
<dd>
<div class="block">Returns true for manually scheduled tasks if the Finish Text attribute should be
displayed to the user rather than the Finish attribute.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/mpp/GanttBarStyle.html#getShowForTasks--">getShowForTasks()</a></span> - Method in class net.sf.mpxj.mpp.<a href="net/sf/mpxj/mpp/GanttBarStyle.html" title="class in net.sf.mpxj.mpp">GanttBarStyle</a></dt>
<dd>
<div class="block">Retrieve set of Show For criteria for this style.</div>
Expand All @@ -30490,6 +30498,11 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieves the "show related summary rows" flag.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Task.html#getShowStartText--">getShowStartText()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Task.html" title="class in net.sf.mpxj">Task</a></dt>
<dd>
<div class="block">Returns true for manually scheduled tasks if the Start Text attribute should be
displayed to the user rather than the Start attribute.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Group.html#getShowSummaryTasks--">getShowSummaryTasks()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Group.html" title="class in net.sf.mpxj">Group</a></dt>
<dd>
<div class="block">Retrieve the show summary tasks flag.</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/index.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>MPXJ 13.4.2 API</title>
<title>MPXJ 13.5.0 API</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/AbstractFieldContainer.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>AbstractFieldContainer (MPXJ 13.4.2 API)</title>
<title>AbstractFieldContainer (MPXJ 13.5.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="AbstractFieldContainer (MPXJ 13.4.2 API)";
parent.document.title="AbstractFieldContainer (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/AccrueType.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>AccrueType (MPXJ 13.4.2 API)</title>
<title>AccrueType (MPXJ 13.5.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="AccrueType (MPXJ 13.4.2 API)";
parent.document.title="AccrueType (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCode.Builder.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>ActivityCode.Builder (MPXJ 13.4.2 API)</title>
<title>ActivityCode.Builder (MPXJ 13.5.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="ActivityCode.Builder (MPXJ 13.4.2 API)";
parent.document.title="ActivityCode.Builder (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCode.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>ActivityCode (MPXJ 13.4.2 API)</title>
<title>ActivityCode (MPXJ 13.5.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="ActivityCode (MPXJ 13.4.2 API)";
parent.document.title="ActivityCode (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCodeContainer.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>ActivityCodeContainer (MPXJ 13.4.2 API)</title>
<title>ActivityCodeContainer (MPXJ 13.5.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="ActivityCodeContainer (MPXJ 13.4.2 API)";
parent.document.title="ActivityCodeContainer (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCodeScope.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>ActivityCodeScope (MPXJ 13.4.2 API)</title>
<title>ActivityCodeScope (MPXJ 13.5.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="ActivityCodeScope (MPXJ 13.4.2 API)";
parent.document.title="ActivityCodeScope (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCodeValue.Builder.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>ActivityCodeValue.Builder (MPXJ 13.4.2 API)</title>
<title>ActivityCodeValue.Builder (MPXJ 13.5.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="ActivityCodeValue.Builder (MPXJ 13.4.2 API)";
parent.document.title="ActivityCodeValue.Builder (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityCodeValue.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>ActivityCodeValue (MPXJ 13.4.2 API)</title>
<title>ActivityCodeValue (MPXJ 13.5.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="ActivityCodeValue (MPXJ 13.4.2 API)";
parent.document.title="ActivityCodeValue (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityStatus.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>ActivityStatus (MPXJ 13.4.2 API)</title>
<title>ActivityStatus (MPXJ 13.5.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="ActivityStatus (MPXJ 13.4.2 API)";
parent.document.title="ActivityStatus (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
4 changes: 2 additions & 2 deletions docs/apidocs/net/sf/mpxj/ActivityType.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>ActivityType (MPXJ 13.4.2 API)</title>
<title>ActivityType (MPXJ 13.5.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="ActivityType (MPXJ 13.4.2 API)";
parent.document.title="ActivityType (MPXJ 13.5.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit d18d6d1

Please sign in to comment.