Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@joniles
joniles committed May 24, 2022
1 parent e46aa76 commit fcc68ab
Show file tree
Hide file tree
Showing 2,053 changed files with 12,401 additions and 7,106 deletions.
56 changes: 52 additions & 4 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@


<link rel="icon" href="/images/favicon.png">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.14">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.15">



<title>MPXJ</title>



<link rel="stylesheet" href="/assets/stylesheets/main.3de6f41f.min.css">
<link rel="stylesheet" href="/assets/stylesheets/main.c382b1dc.min.css">


<link rel="stylesheet" href="/assets/stylesheets/palette.cc9b2e1e.min.css">
Expand Down Expand Up @@ -780,12 +780,60 @@


<label class="md-nav__link" for="__nav_6">
How to Use...
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="How to Use..." data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
How to Use...
</label>
<ul class="md-nav__list" data-md-scrollfix>






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




</ul>
</nav>
</li>











<li class="md-nav__item md-nav__item--nested">


<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >




<label class="md-nav__link" for="__nav_7">
Field Guides...
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="Field Guides..." data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Field Guides...
</label>
Expand Down Expand Up @@ -930,7 +978,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/", "features": [], "search": "/assets/javascripts/workers/search.2a1c317c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "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.title": "Select version"}}</script>


<script src="/assets/javascripts/bundle.c2e1ee47.min.js"></script>
<script src="/assets/javascripts/bundle.a6c66575.min.js"></script>


</body>
Expand Down
95 changes: 86 additions & 9 deletions docs/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
<link rel="canonical" href="http://www.mpxj.org/CHANGELOG/">

<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.14">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.15">



<title>Changes - MPXJ</title>



<link rel="stylesheet" href="../assets/stylesheets/main.3de6f41f.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.c382b1dc.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.cc9b2e1e.min.css">
Expand Down Expand Up @@ -261,8 +261,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1050-unreleased" class="md-nav__link">
10.5.0 (unreleased)
<a href="#1060-unreleased" class="md-nav__link">
10.6.0 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1050-2022-05-24" class="md-nav__link">
10.5.0 (2022-05-24)
</a>

</li>
Expand Down Expand Up @@ -2158,12 +2165,60 @@


<label class="md-nav__link" for="__nav_6">
How to Use...
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="How to Use..." data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
How to Use...
</label>
<ul class="md-nav__list" data-md-scrollfix>






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




</ul>
</nav>
</li>











<li class="md-nav__item md-nav__item--nested">


<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >




<label class="md-nav__link" for="__nav_7">
Field Guides...
<span class="md-nav__icon md-icon"></span>
</label>

<nav class="md-nav" aria-label="Field Guides..." data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Field Guides...
</label>
Expand Down Expand Up @@ -2275,8 +2330,15 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1050-unreleased" class="md-nav__link">
10.5.0 (unreleased)
<a href="#1060-unreleased" class="md-nav__link">
10.6.0 (unreleased)
</a>

</li>

<li class="md-nav__item">
<a href="#1050-2022-05-24" class="md-nav__link">
10.5.0 (2022-05-24)
</a>

</li>
Expand Down Expand Up @@ -3630,13 +3692,28 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1050-unreleased">10.5.0 (unreleased)</h2>
<h2 id="1060-unreleased">10.6.0 (unreleased)</h2>
<h2 id="1050-2022-05-24">10.5.0 (2022-05-24)</h2>
<ul>
<li>The <code>ProjectCalendaWeek</code> methods <code>addCalendarHours()</code>, <code>attachHoursToDay</code>, <code>removeHoursFromDay</code> have been removed. Use <code>addCalendarHours(day)</code>, <code>removeCalendarHours(day)</code> instead. (Note: this will be a breaking change if you were using the original methods to create or modify a schedule)</li>
<li>The <code>ProjectCalendar</code> methods <code>attachHoursToDay</code> and <code>removeHoursFromDay</code> have been removed. Use the <code>addCalendarHours</code> and <code>removeCalendarHours</code> methods instead. (Note: this will be a breaking change if you were using the original methods to create or modify a schedule)</li>
<li>The class hierarchy for <code>ProjectCalendarHours</code> and <code>ProjectCalendarException</code> has been simplified, but there should be no impact for uses of these classes.</li>
<li>The <code>ProjectCalendarHours</code> class now implements the <code>List</code> interface. Methods in this class not part ofthe <code>List</code> interface have been deprecated in favour of the equivalent <code>List</code> methods.</li>
<li>Updated <code>MPXWriter</code> to ensure: calendar names are quoted if necessary, all calendars have names, all calendar names are unique.</li>
<li>Updated <code>MPXReader</code> to recognise <code>wk</code> as a valid time unit.</li>
<li>Updated <code>MPXWriter</code>, <code>PrimaveraPMFileWriter</code>, <code>SDEFWriter</code> and <code>PlannerWriter</code> to ensure any working weeks defined by a calendar are represented by exceptons.</li>
<li>Updated <code>MSPDIWriter</code> to ensure any working weeks defined by a calendar are represented in the "legacy" exception definition used by Microsoft Project prior to 2007.</li>
<li>Updated <code>SDEFWriter</code> to ensure: only relevant calendars are written, and derived calendars are flattened.</li>
<li>When reading Planner schedules MPXJ will no longer create an "artificial" resource calendar for each resource. Resources will be linked directly to the calendar used in the original schedule.</li>
<li>Add suppport for reading the P6 calendar type and personal calendar flag from P6 schedules.</li>
<li>Add suppport for writing the calendar type and personal calendar flag to PMXML files.</li>
<li>Updated the calendar class hierarchy: <code>ProjectCalendar</code> and <code>ProjectCalendarWeek</code> both now inherit from a new class <code>ProjectCalendarDays</code>. Note that <code>ProjectCalendar</code> is no longer a subclass of <code>ProjectCalendarWeek</code>.</li>
<li>The <code>getHours</code> and <code>isWorkingDay</code> methods have been moved up to <code>ProjectCalendar</code> from the <code>ProjectCalendarWeek</code> class.</li>
<li>The <code>ProjectCalendar</code> method <code>copy</code> has been deprecated, without replacement.</li>
<li>Added a <code>getWork</code> method to <code>ProjectCalendar</code> which calculates the amount of work given a <code>Day</code> instance.</li>
<li>Added <code>removeWorkWeek</code> and <code>removeCalendarException</code> methods to <code>ProjectCalendar</code>.</li>
<li>Recurring exceptions are now added to a <code>ProjectCalendar</code> using the <code>addCalendarException</code> method which takes a <code>recurringData</code> instance its argument.</li>
<li>The <code>ProjectCalendarException</code> method <code>setRecurringData</code> has been removed, recurring exceptions should be added using the <code>addCalendarExcepton</code> method described above. (Note: this will be a breaking change if you were creating recurring exceptions)</li>
</ul>
<h2 id="1040-2022-05-05">10.4.0 (2022-05-05)</h2>
<ul>
Expand Down Expand Up @@ -5482,7 +5559,7 @@ <h2 id="008-2003-03-27">0.0.8 (2003-03-27)</h2>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.2a1c317c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "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.title": "Select version"}}</script>


<script src="../assets/javascripts/bundle.c2e1ee47.min.js"></script>
<script src="../assets/javascripts/bundle.a6c66575.min.js"></script>


</body>
Expand Down
5 changes: 3 additions & 2 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.4.0 API)</title>
<title>All Classes (MPXJ 10.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 Expand Up @@ -146,6 +146,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/planner/schema/Calendar.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">Calendar</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/Calendars.html" title="class in net.sf.mpxj.ganttproject.schema" target="classFrame">Calendars</a></li>
<li><a href="net/sf/mpxj/planner/schema/Calendars.html" title="class in net.sf.mpxj.planner.schema" target="classFrame">Calendars</a></li>
<li><a href="net/sf/mpxj/CalendarType.html" title="enum in net.sf.mpxj" target="classFrame">CalendarType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">CalendarType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.HolidayOrExceptions.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">CalendarType.HolidayOrExceptions</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.HolidayOrExceptions.HolidayOrException.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">CalendarType.HolidayOrExceptions.HolidayOrException</a></li>
Expand Down Expand Up @@ -581,7 +582,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/ProjectBudgetChangeLogType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ProjectBudgetChangeLogType</a></li>
<li><a href="net/sf/mpxj/ProjectCalendar.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendar</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarContainer.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendarContainer</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarDateRanges.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendarDateRanges</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarDays.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendarDays</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarException.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendarException</a></li>
<li><a href="net/sf/mpxj/common/ProjectCalendarHelper.html" title="class in net.sf.mpxj.common" target="classFrame">ProjectCalendarHelper</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarHours.html" title="class in net.sf.mpxj" target="classFrame">ProjectCalendarHours</a></li>
Expand Down
5 changes: 3 additions & 2 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.4.0 API)</title>
<title>All Classes (MPXJ 10.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 Expand Up @@ -146,6 +146,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/planner/schema/Calendar.html" title="class in net.sf.mpxj.planner.schema">Calendar</a></li>
<li><a href="net/sf/mpxj/ganttproject/schema/Calendars.html" title="class in net.sf.mpxj.ganttproject.schema">Calendars</a></li>
<li><a href="net/sf/mpxj/planner/schema/Calendars.html" title="class in net.sf.mpxj.planner.schema">Calendars</a></li>
<li><a href="net/sf/mpxj/CalendarType.html" title="enum in net.sf.mpxj">CalendarType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.html" title="class in net.sf.mpxj.primavera.schema">CalendarType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.HolidayOrExceptions.html" title="class in net.sf.mpxj.primavera.schema">CalendarType.HolidayOrExceptions</a></li>
<li><a href="net/sf/mpxj/primavera/schema/CalendarType.HolidayOrExceptions.HolidayOrException.html" title="class in net.sf.mpxj.primavera.schema">CalendarType.HolidayOrExceptions.HolidayOrException</a></li>
Expand Down Expand Up @@ -581,7 +582,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/ProjectBudgetChangeLogType.html" title="class in net.sf.mpxj.primavera.schema">ProjectBudgetChangeLogType</a></li>
<li><a href="net/sf/mpxj/ProjectCalendar.html" title="class in net.sf.mpxj">ProjectCalendar</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarContainer.html" title="class in net.sf.mpxj">ProjectCalendarContainer</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarDateRanges.html" title="class in net.sf.mpxj">ProjectCalendarDateRanges</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarDays.html" title="class in net.sf.mpxj">ProjectCalendarDays</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarException.html" title="class in net.sf.mpxj">ProjectCalendarException</a></li>
<li><a href="net/sf/mpxj/common/ProjectCalendarHelper.html" title="class in net.sf.mpxj.common">ProjectCalendarHelper</a></li>
<li><a href="net/sf/mpxj/ProjectCalendarHours.html" title="class in net.sf.mpxj">ProjectCalendarHours</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.4.0 API)</title>
<title>Constant Field Values (MPXJ 10.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 10.4.0 API)";
parent.document.title="Constant Field Values (MPXJ 10.5.0 API)";
}
}
catch(err) {
Expand Down
Loading

0 comments on commit fcc68ab

Please sign in to comment.