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 29, 2022
1 parent 532f4c3 commit acf1314
Show file tree
Hide file tree
Showing 1,992 changed files with 7,571 additions and 5,987 deletions.
51 changes: 38 additions & 13 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1021-unreleased" class="md-nav__link">
10.2.1 (unreleased)
<a href="#1031-unreleased" class="md-nav__link">
10.3.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1030-2022-04-29" class="md-nav__link">
10.3.0 (2022-04-29)
</a>

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

<li class="md-nav__item">
<a href="#1021-unreleased" class="md-nav__link">
10.2.1 (unreleased)
<a href="#1031-unreleased" class="md-nav__link">
10.3.1 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1030-2022-04-29" class="md-nav__link">
10.3.0 (2022-04-29)
</a>

</li>
Expand Down Expand Up @@ -3600,7 +3614,18 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1021-unreleased">10.2.1 (unreleased)</h2>
<h2 id="1031-unreleased">10.3.1 (unreleased)</h2>
<h2 id="1030-2022-04-29">10.3.0 (2022-04-29)</h2>
<ul>
<li>General improvements to make calendar data read from different file formats more consistent.</li>
<li>When reading P6 and Powerproject schedules MPXJ will no longer create an "artificial" resource calendar for each resource. Resources will be linked directly to the calendars they use in the original schedule.</li>
<li>Update <code>MPXWriter</code> amd <code>MSPDIWriter</code> to ensure that, when writen, calendars are correctly structured in the form required by Microsoft Project.</li>
<li><code>JsonWriter</code> now includes calendar data as part of its output.</li>
<li>The <code>ProjectCalendar</code> methods <code>setMinutesPerDay</code>, <code>setMinutesPerWeek</code>, <code>setMinutesPerMonth</code> and <code>setMinutesPerYear</code> have been deprecated, use <code>setCalendarMinutesPerDay</code>, <code>setCalendarMinutesPerWeek</code>, <code>setCalendarMinutesPerMonth</code> and <code>setCalendarMinutesPerYear</code> instead.</li>
<li>The ProjectCalendar method <code>setResource</code> has been deprecated and will not be replaced. Use the Resource method <code>setCalendar</code> or <code>setCalendarUniqueID</code> to link a calendar with a resource.</li>
<li>The ProjectCalendar method <code>getResource</code> has been deprecated. Use the <code>getResources</code> method instead to retrieve all resources linked with a calendar.</li>
<li>The <code>Resource</code> methods <code>addResourceCalendar</code>, <code>setResourceCalendar</code>, <code>getResourceCalendar</code>, <code>setResourceCalendarUniqueID</code> and <code>getResourceCalendarUniqueID</code> have been deprecated and replaced by <code>addCalendar</code>, <code>setCalendar</code>, <code>getCalendar</code>, <code>setCalendarUniqueID</code> and <code>getCalendarUniqueID</code> respectively.</li>
</ul>
<h2 id="1020-2022-03-06">10.2.0 (2022-03-06)</h2>
<ul>
<li>Improvements to writing currency, rate and units amounts to MSPDI files.</li>
Expand Down Expand Up @@ -3672,7 +3697,7 @@ <h2 id="970-2021-09-28">9.7.0 (2021-09-28)</h2>
<ul>
<li>Add Sprint ID and Board Status ID attributes to task.</li>
<li>Introduce the TimeUnitDefaultsContainer to allow constants for time unit conversions to be obtained from both project properties and calendars.</li>
<li>Duration attributes are no longer returned as Duration instances by the ruby gem, they are now returned as floating point numbers. By default durations are expressed in seconds. A new optional argument to MPXJ::Reader.read allows you to change the units used to express durations. (Note: this is a breaking change for users of the ruby gem)</li>
<li>Duration attributes are no longer returned as Duration instances by the ruby gem, they are now returned as floating point numbers. By default, durations are expressed in seconds. A new optional argument to MPXJ::Reader.read allows you to change the units used to express durations. (Note: this is a breaking change for users of the ruby gem)</li>
<li>Update JsonWriter to use a relevant calendar when converting durations.</li>
<li>Ensure default calendar is set correctly when reading XER and PMXML files, and P6 databases.</li>
<li>Use default hours per day/week/month/year when reading P6 XER files or databases if these values are not present.</li>
Expand All @@ -3697,7 +3722,7 @@ <h2 id="960-2021-09-13">9.6.0 (2021-09-13)</h2>
<h2 id="952-2021-08-22">9.5.2 (2021-08-22)</h2>
<ul>
<li>Add Must Finish By date to project properties.</li>
<li>Add support for task attributes Longest Path, External Early Start and External Early Finish, and ensure they can be read from P6 schedules.</li>
<li>Add support for the task attributes Longest Path, External Early Start and External Early Finish, and ensure they can be read from P6 schedules.</li>
<li>Rename ProjectFile.getStartDate() and ProjectFile.getFinishDate() methods for clarity. Original method names are marked as deprecated</li>
<li>Ensure that all activities in a PMXML file have a CalendarID attribute to ensure compatibility with older versions of P6.</li>
<li>Ensure that the user's selected progress period is used to set the project's status date attribute when reading Asta PP files.</li>
Expand Down Expand Up @@ -3795,7 +3820,7 @@ <h2 id="920-2021-03-30">9.2.0 (2021-03-30)</h2>
<li>Add Remaining Late Start and Remaining Late Finish attributes to Task.</li>
<li>Add Critical Activity Type attribute to Project Properties</li>
<li>Read Remaining Early Start, Remaining Late Start, Remaining Early Finish and Remaining Late finish from and write to PMXML files.</li>
<li>Read Remaining Remaining Late Start and Remaining Late finish from P6 database and XER files.</li>
<li>Read Remaining Late Start and Remaining Late finish from P6 database and XER files.</li>
<li>Ensure that WBS entries without child activities are not marked as critical.</li>
<li>Don't attempt to set the critical flag when reading XER and PMXML files where the schedule is using "longest path" to determine critical activities. (MPXJ currently doesn't have enough information to be able to determine the correct value for the critical flag in this situation).</li>
<li>Ensure cost, duration, date and work attributes are rolled up to WBS entries for P6 schedules read from PMXML files, XER files and P6 databases.</li>
Expand Down Expand Up @@ -3923,9 +3948,9 @@ <h2 id="814-2020-08-31">8.1.4 (2020-08-31)</h2>
<li>Fix CVE-2020-25020: XXE vulnerability (with thanks to Sangeetha Rajesh S, ZOHO Corporation)</li>
<li>Import milestone constraints from Asta schedules (Contributed by Dave McKay)</li>
<li>Handle elapsed durations in Asta schedules (Based on a contribution by Dave McKay)</li>
<li>Correctly determine the constraint type for tasks with ALAP placement with or without predecessors when reading from from Asta schedules (Contributed by Dave McKay)</li>
<li>Correctly determine the constraint type for tasks with ALAP placement with or without predecessors when reading from Asta schedules (Contributed by Dave McKay)</li>
<li>Gracefully handle a missing table name when reading an XER file.</li>
<li>Gracefully handle a unexpected calendar data when reading an XER file.</li>
<li>Gracefully handle an unexpected calendar data when reading an XER file.</li>
<li>Correctly handle XER files with multi-byte character encoding.</li>
<li>Import all schedule and leveling options from XER files.</li>
<li>Ensure project calendars are read from PMXML files.</li>
Expand Down Expand Up @@ -5142,7 +5167,7 @@ <h2 id="0025-2005-08-11">0.0.25 (2005-08-11)</h2>
<li>Implemented French MPX file format translation (contributed by Benoit Baranne).</li>
<li>Fixed a bug reading assignment work contour attribute.</li>
<li>Updated to make failure more graceful when a Microsoft Project 4.0 MPP file is encountered.</li>
<li>Fixed a bug where deleted constraints in an MPP9 file were were not being ignored.</li>
<li>Fixed a bug where deleted constraints in an MPP9 file were not being ignored.</li>
<li>Updated to make replace the int relation type in the Relation class with instances of the RelationType class.</li>
<li>Updated to derive RelationList from AbstractList.</li>
<li>Added sample code to MpxjQuery to illustrate retrieval of information from Relation instances.</li>
Expand All @@ -5153,7 +5178,7 @@ <h2 id="0025-2005-08-11">0.0.25 (2005-08-11)</h2>
<li>Fixed a bug where occasionally a task in MPP9 files were not being read.</li>
<li>Fixed a NegativeArrayIndexException thrown when reading certain MPP8 files.</li>
<li>Reduced the memory used by MPXJ by anything up to 60%, particularly when reading large MPP files.</li>
<li>Fixed a bug when reading MPX files where the field delimiter was not comma, and task relation lists contained more then one entry.</li>
<li>Fixed a bug when reading MPX files where the field delimiter was not comma, and task relation lists contained more than one entry.</li>
<li>Updated to fix unreliable retrieval of project start and end dates from certain MPP files.</li>
<li>Fixed schedule from value in MSPDI files (contributed by Frank Illenberger).</li>
<li>Fixed a bug when reading durations in elapsed days from an MPP file.</li>
Expand Down Expand Up @@ -5241,7 +5266,7 @@ <h2 id="0020-2004-03-15">0.0.20 (2004-03-15)</h2>
<h2 id="0019-2003-12-02">0.0.19 (2003-12-02)</h2>
<ul>
<li>Fixed a bug reading table data from certain MPP8 files</li>
<li>Updated MSPDI support to use latest version of JAXB (from JWSDP-1.3)</li>
<li>Updated MSPDI support to use the latest version of JAXB (from JWSDP-1.3)</li>
<li>Re-implemented base and resource calendars as a single MPXCalendar class</li>
<li>Updated support for base calendars and resource calendars for all file formats</li>
<li>Improved MPXException to print details of any nested exception when a stack trace is printed.</li>
Expand Down
3 changes: 2 additions & 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 10.2.0 API)</title>
<title>All Classes (MPXJ 10.3.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 @@ -156,6 +156,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/utility/clean/CleanByRedactStrategy.html" title="class in net.sf.mpxj.utility.clean" target="classFrame">CleanByRedactStrategy</a></li>
<li><a href="net/sf/mpxj/utility/clean/CleanByReplacementStrategy.html" title="class in net.sf.mpxj.utility.clean" target="classFrame">CleanByReplacementStrategy</a></li>
<li><a href="net/sf/mpxj/utility/clean/CleanStrategy.html" title="interface in net.sf.mpxj.utility.clean" target="classFrame"><span class="interfaceName">CleanStrategy</span></a></li>
<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/mpp/ColorType.html" title="enum in net.sf.mpxj.mpp" target="classFrame">ColorType</a></li>
Expand Down
3 changes: 2 additions & 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 10.2.0 API)</title>
<title>All Classes (MPXJ 10.3.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 @@ -156,6 +156,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/utility/clean/CleanByRedactStrategy.html" title="class in net.sf.mpxj.utility.clean">CleanByRedactStrategy</a></li>
<li><a href="net/sf/mpxj/utility/clean/CleanByReplacementStrategy.html" title="class in net.sf.mpxj.utility.clean">CleanByReplacementStrategy</a></li>
<li><a href="net/sf/mpxj/utility/clean/CleanStrategy.html" title="interface in net.sf.mpxj.utility.clean"><span class="interfaceName">CleanStrategy</span></a></li>
<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/mpp/ColorType.html" title="enum in net.sf.mpxj.mpp">ColorType</a></li>
Expand Down
4 changes: 2 additions & 2 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.2.0 API)</title>
<title>Constant Field Values (MPXJ 10.3.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.2.0 API)";
parent.document.title="Constant Field Values (MPXJ 10.3.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit acf1314

Please sign in to comment.