Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Development/Documentation/2.4"
m |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | < | + | <div class=WordSection1> |
− | < | + | <p class=MsoTitle>Documentation Plan for EclipseLink 2.4</p> |
− | < | + | <h1>Change Record</h1> |
− | <table border=1 cellspacing= | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p><strong>Date</strong></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Date | ||
+ | </span></strong></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p><strong>Author</strong></p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Author</span></strong></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p><strong>Change Record</strong></p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Change | ||
+ | Record</span></strong></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td > | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p>7/28/11</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>7/28/11</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>Ben Gelernter</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>First draft</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>First draft</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td > | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p>8/11/11</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>8/11/11</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>Ben Gelernter</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>Incorporated changes from doc manager review.</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Incorporated changes from doc manager review.</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; |
− | <p>8/17/11</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>8/17/11</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>Ben Gelernter</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: |
− | <p>Incorporated changes from doc team review</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Incorporated changes from doc team review</p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; | ||
+ | border-top:none;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>9/15/11</p> | ||
+ | </td> | ||
+ | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: | ||
+ | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
+ | </td> | ||
+ | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: | ||
+ | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Incorporated changes from Dev/QA/PM review</p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt; | ||
+ | border-top:none;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>9/15/11</p> | ||
+ | </td> | ||
+ | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: | ||
+ | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>James Sutherland</p> | ||
+ | </td> | ||
+ | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left: | ||
+ | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>[[Talk:EclipseLink/Development/Documentation/2.4|Added discussion page]]</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
− | <p>This documentation plan describes how the documentation team will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.</p> | + | <p class=MsoNormal>This documentation plan describes how the documentation team |
+ | will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.</p> | ||
<h1>Schedule</h1> | <h1>Schedule</h1> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p><b>Milestone</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Milestone</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p><b>Date</b></p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Date</b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Doc plan first draft</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Doc plan first draft</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>8/10/11</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>8/10/11</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Doc plan posted</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Doc plan posted</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>8/17/11 </p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>8/17/11 </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Doc plan comments due</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Doc plan comments due</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>8/24/11</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>8/24/11</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Final doc plan </p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Final doc plan </p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>8/29/11</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>8/29/11</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>EclipseLink release 2.4</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>EclipseLink release 2.4</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>< | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
− | + | padding:0in 5.4pt 0in 5.4pt'> | |
+ | <p class=MsoNormal><span class=ornotepadcommenttext>2.4.1 Juno: 2012-06-27 </span><br> | ||
+ | <span class=ornotepadcommenttext>2.4.0: 2012-03-28</span></p> | ||
+ | <p class=MsoNormal><span class=ornotepadcommenttext>(See: <a | ||
+ | href="http://www.eclipse.org/projects/project_summary.php?projectid=rt.eclipselink" | ||
+ | target="_blank">http://www.eclipse.org/projects/project_summary.php?projectid=rt.eclipselink</a> | ||
+ | for any changes to these dates.)</span></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
<h1>Audience</h1> | <h1>Audience</h1> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt; |
− | <p><b>User</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>User</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=451 valign=top style='width:4.7in;border:solid windowtext 1.0pt; |
− | <p><b>Description</b></p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Description</b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt; |
− | <p>Application Developers</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Application Developers</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none; |
− | <p>Developers who want to develop applications using any of | + | border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Developers who want to develop applications using any of | ||
the following technologies for persistence services:</p> | the following technologies for persistence services:</p> | ||
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>Java Persistence Architecture (JPA) 2.x plus the | + | <li class=MsoNormal>Java Persistence Architecture (JPA) 2.x plus the |
EclipseLink JPA extensions</li> | EclipseLink JPA extensions</li> | ||
− | <li>Java Architecture for XML Binding 2.x (JAXB) plus the | + | <li class=MsoNormal>Java Architecture for XML Binding 2.x (JAXB) plus the |
EclipseLink MOXy extensions.</li> | EclipseLink MOXy extensions.</li> | ||
− | <li>Java API for XML Web Services 2.x (JAX-WS) plus EclipseLink | + | <li class=MsoNormal>Java API for XML Web Services 2.x (JAX-WS) plus EclipseLink |
Database Web Services (DBWS) features. </li> | Database Web Services (DBWS) features. </li> | ||
</ul> | </ul> | ||
− | <p>Developers should be familiar with the concepts and | + | <p class=MsoNormal>Developers should be familiar with the concepts and |
− | programming practices of | + | programming practices of the version of Java SE and Java EE supported by |
− | + | their deployment platform.</p> | |
− | + | <p class=MsoNormal><b>Assumed knowledge:</b></p> | |
− | + | <ul style='margin-top:0in' type=disc> | |
− | + | <li class=MsoNormal>Developers using EclipseLink JPA should be familiar with | |
− | + | ||
− | + | ||
− | <p><b>Assumed knowledge:</b></p> | + | |
− | <ul> | + | |
− | <li>Developers using EclipseLink JPA should be familiar with | + | |
the concepts and programming practices of JPA 2.x.</li> | the concepts and programming practices of JPA 2.x.</li> | ||
− | <li>Developers using EclipseLink MOXy should be familiar | + | <li class=MsoNormal>Developers using EclipseLink MOXy should be familiar |
with the concepts and programming practices of JAXB 2.x.</li> | with the concepts and programming practices of JAXB 2.x.</li> | ||
− | <li>Developers using EclipseLink DBWS should be familiar | + | <li class=MsoNormal>Developers using EclipseLink DBWS should be familiar |
with the concepts and programming practices of JAX-WS 2.x.</li> | with the concepts and programming practices of JAX-WS 2.x.</li> | ||
</ul> | </ul> | ||
Line 158: | Line 235: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt; |
− | <p>Administrator/Deployer</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Administrator/Deployer</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none; |
− | <p>Users who want to deploy and manage applications using the | + | border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Users who want to deploy and manage applications using the | ||
EclipseLink persistence technologies.<b><i> </i></b></p> | EclipseLink persistence technologies.<b><i> </i></b></p> | ||
− | <p><b>Assumed knowledge:</b></p> | + | <p class=MsoNormal><b>Assumed knowledge:</b></p> |
− | <p>These users should be familiar with basic operations of | + | <p class=MsoNormal>These users should be familiar with basic operations of |
− | the chosen | + | the chosen application server.</p> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
<h1>Planned Documentation Deliverables</h1> | <h1>Planned Documentation Deliverables</h1> | ||
− | <p>The Documentation team will document EclipseLink-specific | + | <p class=MsoNormal>The Documentation team will document EclipseLink-specific |
features for:</p> | features for:</p> | ||
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>JPA | + | <li class=MsoNormal>JPA </li> |
− | <li>MOXy</li> | + | <li class=MsoNormal>MOXy</li> |
− | <li>DBWS</li> | + | <li class=MsoNormal>DBWS</li> |
</ul> | </ul> | ||
− | <p>The Documentation team will not document EIS, SDO, <span | + | <p class=MsoNormal><b>Note:</b> JPA is the most commonly used and the biggest, |
+ | therefore more resources will be devoted to JPA than the other services. </p> | ||
+ | |||
+ | <p class=MsoNormal>The Documentation team will not document EIS, SDO, <span | ||
class=ornotepadcommenttext>or any other "native" TopLink | class=ornotepadcommenttext>or any other "native" TopLink | ||
functionality (i.e., non-JPA such as ORM, OX, etc.)</span>..</p> | functionality (i.e., non-JPA such as ORM, OX, etc.)</span>..</p> | ||
Line 197: | Line 273: | ||
<h2>Documentation Design</h2> | <h2>Documentation Design</h2> | ||
− | <p>The wiki topics will be handled as follows:</p> | + | <p class=MsoNormal>The wiki topics will be handled as follows:</p> |
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>All EclipseLink documentation will be maintained under the | + | <li class=MsoNormal>All EclipseLink documentation will be maintained under the |
− | <i>Documentation Center</i> on the EclipseLink wiki at http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide. | + | <i>Documentation Center</i> on the EclipseLink wiki at <a |
+ | href="http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide</a>. | ||
</li> | </li> | ||
− | <li>Versioning will be handled as follows:</li> | + | <li class=MsoNormal>Versioning will be handled as follows:</li> |
− | <ul> | + | <ul style='margin-top:0in' type=circle> |
− | <li>A note "New in EL 2.<i>n</i>" will be placed | + | <li class=MsoNormal>A note "New in EL 2.<i>n</i>" will be placed |
next to new topics in the TOCs, where <i>n</i> refers to the release when | next to new topics in the TOCs, where <i>n</i> refers to the release when | ||
the feature was introduced. This is currently handled using template <span | the feature was introduced. This is currently handled using template <span | ||
style='font-family:"Courier New"'>{{EclipseLink/NewIn2<i>n</i>}}</span>.</li> | style='font-family:"Courier New"'>{{EclipseLink/NewIn2<i>n</i>}}</span>.</li> | ||
− | <li>A note " New in version 2.<i>n</i>." will be | + | <li class=MsoNormal>A note " New in version 2.<i>n</i>." will be |
added at the beginning of a topic documenting a new feature. This is | added at the beginning of a topic documenting a new feature. This is | ||
currently handled using <span style='font-family:"Courier New"'>{{EclipseLink_NewIn|version=2.n}}.</span></li> | currently handled using <span style='font-family:"Courier New"'>{{EclipseLink_NewIn|version=2.n}}.</span></li> | ||
− | <li>If a new feature is handled in an existing topic and the | + | <li class=MsoNormal>If a new feature is handled in an existing topic and the |
topic changes more than 50%, the note " New in version 2.<i>n</i>." | topic changes more than 50%, the note " New in version 2.<i>n</i>." | ||
will be placed at the beginning of the topic or at the beginning of the appropriate | will be placed at the beginning of the topic or at the beginning of the appropriate | ||
section. </li> | section. </li> | ||
− | <li>Header and footers on the wiki page will contain no | + | <li class=MsoNormal>Header and footers on the wiki page will contain no |
references to release numbers. </li> | references to release numbers. </li> | ||
− | <li>If a feature is deprecated, a note will placed next to | + | <li class=MsoNormal>If a feature is deprecated, a note will placed next to |
the documentation for the feature.</li> | the documentation for the feature.</li> | ||
</ul> | </ul> | ||
− | <li>Each topic will document one "feature." The term | + | <li class=MsoNormal>Each topic will document one "feature." The term |
"feature" here is somewhat loose. In some cases, it is a single | "feature" here is somewhat loose. In some cases, it is a single | ||
annotation. In some cases, the topic will document how to use multiple | annotation. In some cases, the topic will document how to use multiple | ||
annotations together for a specific purpose, e.g., single-table | annotations together for a specific purpose, e.g., single-table | ||
multi=tenancy.</li> | multi=tenancy.</li> | ||
− | <li>These topics are more-or-less "reference" | + | <li class=MsoNormal>These topics are more-or-less "reference" |
topics. That is, they document the primary APIs and XML used to implement | topics. That is, they document the primary APIs and XML used to implement | ||
the feature. There can be limited discussion about how to use the code to | the feature. There can be limited discussion about how to use the code to | ||
Line 232: | Line 309: | ||
feature in a larger context or to fully document all related features<span | feature in a larger context or to fully document all related features<span | ||
style='color:red'>. </span></li> | style='color:red'>. </span></li> | ||
− | <li>The JPA topics will primarily focus on using annotations, | + | <li class=MsoNormal>The JPA topics will primarily focus on using annotations, |
when they are available. For example, a topic may begin with something | when they are available. For example, a topic may begin with something | ||
like, "Use the @Xyz annotation to…" and most or all examples and | like, "Use the @Xyz annotation to…" and most or all examples and | ||
Line 239: | Line 316: | ||
schema), but the documentation for XML will not be as extensive as the | schema), but the documentation for XML will not be as extensive as the | ||
documentation for the annotation.</li> | documentation for the annotation.</li> | ||
− | <li>Every topic will cross-reference:</li> | + | <li class=MsoNormal>Every topic will cross-reference:</li> |
− | <ul> | + | <ul style='margin-top:0in' type=circle> |
− | <li> Any associated example provided by Development and | + | <li class=MsoNormal> Any associated example provided by Development and |
located in the Samples section of the wiki.</li> | located in the Samples section of the wiki.</li> | ||
− | <li>Any associated Javadoc. When an annotation is available, | + | <li class=MsoNormal>Any associated Javadoc. When an annotation is available, |
the reference will be to the annotation(s), not the "native | the reference will be to the annotation(s), not the "native | ||
API."</li> | API."</li> | ||
</ul> | </ul> | ||
− | <li>The Documentation team will not document features that are | + | <li class=MsoNormal>The Documentation team will not document features that are |
not EclipseLink-specific. In particular, features that are documented in | not EclipseLink-specific. In particular, features that are documented in | ||
the specification for the underlying technology. For example features | the specification for the underlying technology. For example features | ||
Line 255: | Line 332: | ||
provide advice on the organization of topics. Any non-Documentation person | provide advice on the organization of topics. Any non-Documentation person | ||
adding topics is responsible for adding and maintaining the following:</li> | adding topics is responsible for adding and maintaining the following:</li> | ||
− | <ul> | + | <ul style='margin-top:0in' type=circle> |
− | <li>Previous and Next browse sequence links at the bottom of | + | <li class=MsoNormal>Previous and Next browse sequence links at the bottom of |
the page </li> | the page </li> | ||
− | <li>Links from the Table of Contents</li> | + | <li class=MsoNormal>Links from the Table of Contents</li> |
− | <li>Links from the parent, or container, topic, if there is | + | <li class=MsoNormal>Links from the parent, or container, topic, if there is |
one. For example, the JPA documentation includes a "Weaving | one. For example, the JPA documentation includes a "Weaving | ||
Topic" which introduces several weaving-related topics under it. </li> | Topic" which introduces several weaving-related topics under it. </li> | ||
Line 265: | Line 342: | ||
</ul> | </ul> | ||
− | <p style='margin-left:1.0in'>Note: A container topic should not | + | <p class=MsoNormal style='margin-left:1.0in'>Note: A container topic should not |
contain only a list of links. Every topic must include at least an overview | contain only a list of links. Every topic must include at least an overview | ||
sentence. For example: "The EclipseLink cache is an in-memory repository | sentence. For example: "The EclipseLink cache is an in-memory repository | ||
Line 271: | Line 348: | ||
values. Caching is discussed in the following topics:"</p> | values. Caching is discussed in the following topics:"</p> | ||
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>Individual topics will not include cross references to the | + | <li class=MsoNormal>Individual topics will not include cross references to the |
standard specifications (JPA, JAXB). There will be one overview topic (or | standard specifications (JPA, JAXB). There will be one overview topic (or | ||
an overview topic for each service) that will contain the link to the | an overview topic for each service) that will contain the link to the | ||
appropriate specification.</li> | appropriate specification.</li> | ||
− | <li>If design documents (specs) are not available or do not | + | <li class=MsoNormal>If design documents (specs) are not available or do not |
contain enough source material (including examples), writers will file | contain enough source material (including examples), writers will file | ||
bugs against Development via BugZilla.</li> | bugs against Development via BugZilla.</li> | ||
Line 283: | Line 360: | ||
<h2>Tasks/Deliverables</h2> | <h2>Tasks/Deliverables</h2> | ||
− | <p>The following tasks are not specifically associated with the | + | <p class=MsoNormal>The following tasks are not specifically associated with the |
EclipseLink 2.4 release but will be handled by the Documentation team during | EclipseLink 2.4 release but will be handled by the Documentation team during | ||
this period:</p> | this period:</p> | ||
Line 289: | Line 366: | ||
<h3>General</h3> | <h3>General</h3> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p><b><i>Task/Deliverable</i></b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b><i>Task/Deliverable</i></b></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border:solid windowtext 1.0pt; |
− | <p><b><i>Writer</i></b></p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b><i>Writer</i></b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p>Identify topics in the JPA TOC that are documented in the | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Identify topics in the JPA TOC that are documented in the | ||
JPA specification to clarify which existing items are the responsibility of | JPA specification to clarify which existing items are the responsibility of | ||
Documentation and which are the responsibility of Development.</p> | Documentation and which are the responsibility of Development.</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left: |
− | <p>Ben Gelernter, Rick Sapir</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter, Rick Sapir</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p>Review JPA topics to make sure all 2.2 and 2.3 features | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Review JPA topics to make sure all 2.2 and 2.3 features | ||
are documented and reviewed. Update as needed.</p> | are documented and reviewed. Update as needed.</p> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left: |
− | <p>Ben Gelernter</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p>Create an Introduction/Overview section:</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
− | <ul> | + | <p class=MsoNormal>Create an Introduction/Overview section:</p> |
− | <li>If introductory information exists elsewhere (e.g., the | + | <ul style='margin-top:0in' type=disc> |
+ | <li class=MsoNormal>If introductory information exists elsewhere (e.g., the | ||
JPA intro section), move it to this section</li> | JPA intro section), move it to this section</li> | ||
− | <li>Write any introductory information that is missing, | + | <li class=MsoNormal>Write any introductory information that is missing, |
including cross-references to the specifications (JPA, JAXB)</li> | including cross-references to the specifications (JPA, JAXB)</li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left: |
− | <p>Ben Gelernter, Rick Sapir</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter, Rick Sapir</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p>Review existing topics for consistency, e.g.:</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
− | <ul> | + | <p class=MsoNormal>Review existing topics for consistency, e.g.:</p> |
− | <li>Navigation links</li> | + | <ul style='margin-top:0in' type=disc> |
− | <li>Lists of links in topics (TOCs for sections)</li> | + | <li class=MsoNormal>Navigation links</li> |
− | <li>Headers/footers</li> | + | <li class=MsoNormal>Lists of links in topics (TOCs for sections)</li> |
− | <li>Tables, examples</li> | + | <li class=MsoNormal>Headers/footers</li> |
− | <li>Key API links (qualified by path?) </li> | + | <li class=MsoNormal>Tables, examples</li> |
+ | <li class=MsoNormal>Key API links (qualified by path?) </li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left: |
− | <p>Ben Gelernter</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt; |
− | <p>Create documentation style guide specific to EclipseLink. </p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
− | <p>The main source for documentation style is the Eclipse | + | <p class=MsoNormal>Create documentation style guide specific to EclipseLink. </p> |
+ | <p class=MsoNormal>The main source for documentation style is the Eclipse | ||
documentation standards. However, as EclipseLink-specific style issues that not | documentation standards. However, as EclipseLink-specific style issues that not | ||
covered by the Eclipse standards arise, the writers will post them on this | covered by the Eclipse standards arise, the writers will post them on this | ||
wiki page. We will spend minimal time developing standards.</p> | wiki page. We will spend minimal time developing standards.</p> | ||
− | <p>Eclipse Doc Style Guide (for Eclipse Help): http://wiki.eclipse.org/Eclipse_Doc_Style_Guide">http://wiki.eclipse.org/Eclipse_Doc_Style_Guide</p> | + | <p class=MsoNormal>Eclipse Doc Style Guide (for Eclipse Help): <a |
− | <p>Writers may also find these pages useful: http://wiki.eclipse.org/DocumentationGuidelines">http://wiki.eclipse.org/DocumentationGuidelines | + | href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide">http://wiki.eclipse.org/Eclipse_Doc_Style_Guide</a></p> |
− | and "http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines">http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines</p> | + | <p class=MsoNormal>Writers may also find these pages useful: <a |
+ | href="http://wiki.eclipse.org/DocumentationGuidelines">http://wiki.eclipse.org/DocumentationGuidelines</a> | ||
+ | and <a href="http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines">http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines</a></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left: |
− | <p> Tom Pfaeffle (create the page)</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
− | <p>Entire team may contribute.</p> | + | padding:0in 5.4pt 0in 5.4pt'> |
− | <p><b><i> </i></b></p> | + | <p class=MsoNormal> Tom Pfaeffle (create the page)</p> |
+ | <p class=MsoNormal>Entire team may contribute.</p> | ||
+ | <p class=MsoNormal><b><i> </i></b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
− | <p>The following tables show the features that will be documented | + | <p class=MsoNormal>The following tables show the features that will be documented |
for EL 2.4.</p> | for EL 2.4.</p> | ||
<h3>JPA Features</h3> | <h3>JPA Features</h3> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p><b>Feature </b></p> | + | <p class=MsoNormal><b>Feature </b></p> |
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Design documents, examples, any other source material</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Subject Matter Expert</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Subject Matter Expert</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Writer</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Writer</b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b>Enhanced Schema Provisioning: </b>Schema upgrade to | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Enhanced Schema Provisioning: </b>Schema upgrade to | ||
handle application version upgrades. Upon request the Schmea will be extended | handle application version upgrades. Upon request the Schmea will be extended | ||
to add additional tables, columns, indexes.</p> | to add additional tables, columns, indexes.</p> | ||
</td> | </td> | ||
− | <td | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | border-right:solid windowtext 1.0pt;> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p>Not yet available?</p> | + | <p class=MsoNormal>Not yet available?</p> |
</td> | </td> | ||
− | <td | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | border-right:solid windowtext 1.0pt;> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p> | + | <p class=MsoNormal><span class=ornotepadcommenttext>Peter Krogh and/or |
+ | designee from his team</span></p> | ||
</td> | </td> | ||
− | <td | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | border-right:solid windowtext 1.0pt;> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p> </p> | + | <p class=MsoNormal> </p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b>MetadataSource support for PU Properties: </b>During | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>MetadataSource support for PU Properties: </b>During | ||
the bootstrap of a JPA persistence unit the Metadatasource will provide | the bootstrap of a JPA persistence unit the Metadatasource will provide | ||
additional PU properties that can come from an external source to customize | additional PU properties that can come from an external source to customize | ||
the PU properties used in the EntityManagerFactory creation.</p> | the PU properties used in the EntityManagerFactory creation.</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>Not yet available?</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Not yet available?</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>"</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> </p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b>JPA 2.1</b>: Provide early access to some of the JPA | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>JPA 2.1</b>: Provide early access to some of the JPA | ||
2.1 defined features. This will depend on the progress the expert group | 2.1 defined features. This will depend on the progress the expert group | ||
makes.</p> | makes.</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>Not yet available?</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Not yet available?</p> | ||
</td> | </td> | ||
− | <td | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | border-right:solid windowtext 1.0pt;> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p> | + | <p class=MsoNormal>"</p> |
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> </p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b>Gemini JPA</b>: With the Gemini JPA 1.0 release | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Gemini JPA</b>: With the Gemini JPA 1.0 release | ||
scheduled to come out this summer the current solution available (which we | scheduled to come out this summer the current solution available (which we | ||
have deprecated) need to be fully transitioned to leverage the Gemini | have deprecated) need to be fully transitioned to leverage the Gemini | ||
solutions. This will involve updates or migration of examples but may also | solutions. This will involve updates or migration of examples but may also | ||
involve a coordinated Gemini release if feature work is included</p> | involve a coordinated Gemini release if feature work is included</p> | ||
− | <p>From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/): | + | <p class=MsoNormal>From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/): |
"The Gemini JPA project is about modular implementations of Java | "The Gemini JPA project is about modular implementations of Java | ||
Persistence API technology. This project currently provides the integration | Persistence API technology. This project currently provides the integration | ||
Line 454: | Line 565: | ||
approach that clients can use to get JPA support in an OSGi framework."</p> | approach that clients can use to get JPA support in an OSGi framework."</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>Not yet available?</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Not yet available?</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>"</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> </p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal> </p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><b>Database Change Event Cache Invalidation: </b>This | ||
+ | project will provide an infrastructure for supporting database change events | ||
+ | to invalidate the changed objects in the EclipseLink shared cache.</p> | ||
+ | </td> | ||
+ | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; | ||
+ | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><a | ||
+ | href="http://wiki.eclipse.org/EclipseLink/DesignDocs/356812" | ||
+ | title="EclipseLink/DesignDocs/356812">Database Change Event Cache | ||
+ | Invalidation</a></p> | ||
+ | </td> | ||
+ | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; | ||
+ | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>"</p> | ||
+ | </td> | ||
+ | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; | ||
+ | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 468: | Line 605: | ||
<h3>MOXy Features</h3> | <h3>MOXy Features</h3> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
+ | <tr> | ||
+ | <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt; | ||
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><b>Feature </b></p> | ||
+ | </td> | ||
+ | <td width=283 valign=top style='width:212.2pt;border:solid windowtext 1.0pt; | ||
+ | border-left:none;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p> | ||
+ | </td> | ||
+ | <td width=124 valign=top style='width:92.85pt;border:solid windowtext 1.0pt; | ||
+ | border-left:none;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><b>Subject Matter Expert</b></p> | ||
+ | </td> | ||
+ | <td width=67 valign=top style='width:50.45pt;border:solid windowtext 1.0pt; | ||
+ | border-left:none;padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><b>Writer</b></p> | ||
+ | </td> | ||
+ | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt; |
− | <p><b> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Object-JSON</b> Mapping support</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=283 valign=top style='width:212.2pt;border-top:none;border-left: |
− | <p>< | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><span class=ornotepadcommenttext><a | ||
+ | href="http://wiki.eclipse.org/EclipseLink/DesignDocs/350483">Object-to-JSON | ||
+ | Binding Layer</a> </span></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=124 valign=top style='width:92.85pt;border-top:none;border-left: |
− | <p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Blaise Doughan, David Twelves</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=67 valign=top style='width:50.45pt;border-top:none;border-left: |
− | <p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Rick Sapir</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt; |
− | <p><b> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><span class=ornotepadcommenttext>Set of features to match <b>extensions | ||
+ | provided by JAXB RI</b></span></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=283 valign=top style='width:212.2pt;border-top:none;border-left: |
− | <p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><span class=ornotepadcommenttext>"We are currently | ||
+ | developing and tracking this list through Bugzilla enhancements." [David | ||
+ | Twelves]</span></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=124 valign=top style='width:92.85pt;border-top:none;border-left: |
− | <p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal><span class=ornotepadcommenttext>David Twelves</span></p> | ||
</td> | </td> | ||
− | <td> | + | <td width=67 valign=top style='width:50.45pt;border-top:none;border-left: |
− | <p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 501: | Line 676: | ||
<h3>DBWS Features</h3> | <h3>DBWS Features</h3> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
− | <p><b>Feature</b></p> | + | <p class=MsoNormal><b>Feature</b></p> |
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Design documents, examples, any other source material</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Subject Matter Expert</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Subject Matter Expert</b></p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-left:none; |
− | <p><b>Writer</b></p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Writer</b></p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>Parse DDL to extract database metadata</b>: Change the | ||
+ | way type metadata is accessed by DBWSBuilder, providing support for the | ||
+ | following enhancement requests:</p> | ||
+ | <ul style='margin-top:0in' type=disc> | ||
+ | <li class=MsoNormal><span class=ornotepadcommenttext>DBWSProvider does not | ||
+ | handle weakly-typed REF CURSORs (bug 325124)</span></li> | ||
+ | <li class=MsoNormal><span class=ornotepadcommenttext> DBWSProvider does not | ||
+ | handle strongly-typed REF CURSORs (bug 339721)</span></li> | ||
+ | <li class=MsoNormal><span class=ornotepadcommenttext>DBWSProvider does not | ||
+ | handle optional arguments for Stored Procedures (bug 234385)</span></li> | ||
+ | <li class=MsoNormal><span class=ornotepadcommenttext>DBWS does not handle | ||
+ | %ROWTYPE mix of PL/SQL types and JDBC Advanced types bug 329435</span></li> | ||
+ | </ul> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><a | ||
+ | href="http://wiki.eclipse.org/EclipseLink/Development/DBWS/ParseDDLforMetadata">Parsing | ||
+ | DDL for Metadata Design Spec</a> </p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>David Twelves</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Mike Norman, David Twelves</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Rick Sapir</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td valign=top style='border:solid windowtext 1.0pt;border-top:none; |
− | <p><b>RESTful JPA</b>: Provide a JAX-RS solution for easily | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal><b>RESTful JPA</b>: Provide a JAX-RS solution for easily | ||
making a JPA persistence unit available through REST calls.</p> | making a JPA persistence unit available through REST calls.</p> | ||
+ | <p class=MsoNormal>(<a | ||
+ | href="http://wiki.eclipse.org/EclipseLink/Development/2.4.0">EclipseLink | ||
+ | 2.4.0 Development Plans</a> page says "BWS Generation of JAX-RS Web | ||
+ | Services."</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>Not yet available | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Not yet available.</p> | ||
+ | <p class=MsoNormal>"Planned for later in 2.4 dev cycle." [David | ||
+ | Twelves]</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>David Twelves</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>David Twelves</p> | ||
</td> | </td> | ||
− | <td> | + | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt; |
− | <p>Rick Sapir</p> | + | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Rick Sapir</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
+ | |||
+ | <h3>Printable Versions</h3> | ||
+ | |||
+ | <p class=MsoNormal>We plan to provide a printable version of the EclipseLink | ||
+ | wiki topics. When a new version of EclipseLink is released (and all | ||
+ | documentation issues are wrapped up), we will generate a PDF version (and, if | ||
+ | possible an HTML version)<b><i> </i></b>of the wiki topics and post that as the | ||
+ | official documentation for a certain release. Updates may continue to be made | ||
+ | on the wiki, but the PDF/HTML will not be regenerated until the next release.</p> | ||
+ | |||
+ | <p class=MsoNormal>Details about how to accomplish this are not yet resolved.</p> | ||
<h1>Scheduling and Reviews</h1> | <h1>Scheduling and Reviews</h1> | ||
− | <p>Schedules must include time for:</p> | + | <p class=MsoNormal>Schedules must include time for:</p> |
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>Documentation reviews by Dev/QA. Reviews will be conducted | + | <li class=MsoNormal>Documentation reviews by Dev/QA. Reviews will be conducted |
on the wiki.</li> | on the wiki.</li> | ||
− | <li>A final production review of the wiki including, but not limited | + | <li class=MsoNormal>A final production review of the wiki including, but not limited |
to:</li> | to:</li> | ||
</ul> | </ul> | ||
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <ul> | + | <ul style='margin-top:0in' type=circle> |
− | <li>Links to samples</li> | + | <li class=MsoNormal>Links to samples</li> |
− | <li>Links to Javadoc</li> | + | <li class=MsoNormal>Links to Javadoc</li> |
− | <li>Cross-references</li> | + | <li class=MsoNormal>Cross-references</li> |
− | <li>Style consistency</li> | + | <li class=MsoNormal>Style consistency</li> |
</ul> | </ul> | ||
</ul> | </ul> | ||
− | <p style='text-indent:.5in'>All writers will contribute to the | + | <p class=MsoNormal style='text-indent:.5in'>All writers will contribute to the |
production review.</p> | production review.</p> | ||
<h1>Bugs</h1> | <h1>Bugs</h1> | ||
− | <p>All writers must have BugZilla accounts and review and | + | <p class=MsoNormal>All writers must have BugZilla accounts and review and |
handle documentation bugs against their EclipseLink topics.</p> | handle documentation bugs against their EclipseLink topics.</p> | ||
− | <p>If a writer is responsible for a feature that has no | + | <p class=MsoNormal>If a writer is responsible for a feature that has no |
corresponding design documentation or if the design documentation does not | corresponding design documentation or if the design documentation does not | ||
contain enough information (missing details, code snippets, release, etc.), the | contain enough information (missing details, code snippets, release, etc.), the | ||
Line 585: | Line 803: | ||
<h1>Assignments</h1> | <h1>Assignments</h1> | ||
− | <table border=1> | + | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 |
+ | style='border-collapse:collapse;border:none'> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Joe Garcia</p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Joe Garcia</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Manager </p> | + | border-left:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Manager </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Donna Micozzi</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Donna Micozzi</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>Manager </p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
− | <p> </p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Manager </p> | ||
+ | <p class=MsoNormal> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Ben Gelernter</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Ben Gelernter</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>Lead, JPA topics</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>Lead, JPA topics</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Ed Spear</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Ed Spear</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>JPA topics (TBD)</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>JPA topics (TBD)</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Rick Sapir</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Rick Sapir</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>MOXy</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
− | <p>DBWS</p> | + | padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>MOXy</p> | ||
+ | <p class=MsoNormal>DBWS</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt; |
− | <p>Tom Pfaeffle</p> | + | border-top:none;padding:0in 5.4pt 0in 5.4pt'> |
+ | <p class=MsoNormal>Tom Pfaeffle</p> | ||
</td> | </td> | ||
− | <td> | + | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left: |
− | <p>JPA topics (TBD)</p> | + | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; |
+ | padding:0in 5.4pt 0in 5.4pt'> | ||
+ | <p class=MsoNormal>JPA topics (TBD)</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | <p> </p> | + | <p class=MsoNormal> </p> |
<h1>Issues</h1> | <h1>Issues</h1> | ||
− | <ul> | + | <ul style='margin-top:0in' type=disc> |
− | <li>Printable Version</li> | + | <li class=MsoNormal>Printable Version: Details about how to accomplish this |
+ | are not yet resolved.</li> | ||
+ | <li class=MsoNormal>Metadata to improve searching</li> | ||
</ul> | </ul> | ||
− | + | </div> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 09:45, 12 January 2012
Documentation Plan for EclipseLink 2.4
Contents
Change Record
Date |
Author |
Change Record |
7/28/11 |
Ben Gelernter |
First draft |
8/11/11 |
Ben Gelernter |
Incorporated changes from doc manager review. |
8/17/11 |
Ben Gelernter |
Incorporated changes from doc team review |
9/15/11 |
Ben Gelernter |
Incorporated changes from Dev/QA/PM review |
9/15/11 |
James Sutherland |
This documentation plan describes how the documentation team will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.
Schedule
Milestone |
Date |
Doc plan first draft |
8/10/11 |
Doc plan posted |
8/17/11 |
Doc plan comments due |
8/24/11 |
Final doc plan |
8/29/11 |
EclipseLink release 2.4 |
2.4.1 Juno: 2012-06-27 (See: <a href="http://www.eclipse.org/projects/project_summary.php?projectid=rt.eclipselink" target="_blank">http://www.eclipse.org/projects/project_summary.php?projectid=rt.eclipselink</a> for any changes to these dates.) |
Audience
User |
Description |
Application Developers |
Developers who want to develop applications using any of the following technologies for persistence services:
Developers should be familiar with the concepts and programming practices of the version of Java SE and Java EE supported by their deployment platform. Assumed knowledge:
|
Administrator/Deployer |
Users who want to deploy and manage applications using the EclipseLink persistence technologies. Assumed knowledge: These users should be familiar with basic operations of the chosen application server. |
Planned Documentation Deliverables
The Documentation team will document EclipseLink-specific features for:
- JPA
- MOXy
- DBWS
Note: JPA is the most commonly used and the biggest, therefore more resources will be devoted to JPA than the other services.
The Documentation team will not document EIS, SDO, or any other "native" TopLink functionality (i.e., non-JPA such as ORM, OX, etc.)..
Documentation Design
The wiki topics will be handled as follows:
- All EclipseLink documentation will be maintained under the Documentation Center on the EclipseLink wiki at <a href="http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide</a>.
- Versioning will be handled as follows:
- A note "New in EL 2.n" will be placed next to new topics in the TOCs, where n refers to the release when the feature was introduced. This is currently handled using template {{EclipseLink/NewIn2n}}.
- A note " New in version 2.n." will be added at the beginning of a topic documenting a new feature. This is currently handled using .
- If a new feature is handled in an existing topic and the topic changes more than 50%, the note " New in version 2.n." will be placed at the beginning of the topic or at the beginning of the appropriate section.
- Header and footers on the wiki page will contain no references to release numbers.
- If a feature is deprecated, a note will placed next to the documentation for the feature.
- Each topic will document one "feature." The term "feature" here is somewhat loose. In some cases, it is a single annotation. In some cases, the topic will document how to use multiple annotations together for a specific purpose, e.g., single-table multi=tenancy.
- These topics are more-or-less "reference" topics. That is, they document the primary APIs and XML used to implement the feature. There can be limited discussion about how to use the code to achieve the purpose of the feature, but we will not attempt to put the feature in a larger context or to fully document all related features.
- The JPA topics will primarily focus on using annotations, when they are available. For example, a topic may begin with something like, "Use the @Xyz annotation to…" and most or all examples and code snippets will show annotations. When the feature can also be coded using XML, the topic can discuss the XML (including a reference to the schema), but the documentation for XML will not be as extensive as the documentation for the annotation.
- Every topic will cross-reference:
- Any associated example provided by Development and located in the Samples section of the wiki.
- Any associated Javadoc. When an annotation is available, the reference will be to the annotation(s), not the "native API."
- The Documentation team will not document features that are not EclipseLink-specific. In particular, features that are documented in the specification for the underlying technology. For example features documented in the JSR-000317 JavaTM Persistence 2.0 specification will not be documented. However, anyone with permission to edit the wiki may add topics to the wiki. As time permits, the Documentation team may provide advice on the organization of topics. Any non-Documentation person adding topics is responsible for adding and maintaining the following:
- Previous and Next browse sequence links at the bottom of the page
- Links from the Table of Contents
- Links from the parent, or container, topic, if there is one. For example, the JPA documentation includes a "Weaving Topic" which introduces several weaving-related topics under it.
Note: A container topic should not contain only a list of links. Every topic must include at least an overview sentence. For example: "The EclipseLink cache is an in-memory repository that stores recently read or written objects based on class and primary key values. Caching is discussed in the following topics:"
- Individual topics will not include cross references to the standard specifications (JPA, JAXB). There will be one overview topic (or an overview topic for each service) that will contain the link to the appropriate specification.
- If design documents (specs) are not available or do not contain enough source material (including examples), writers will file bugs against Development via BugZilla.
Tasks/Deliverables
The following tasks are not specifically associated with the EclipseLink 2.4 release but will be handled by the Documentation team during this period:
General
Task/Deliverable |
Writer |
Identify topics in the JPA TOC that are documented in the JPA specification to clarify which existing items are the responsibility of Documentation and which are the responsibility of Development. |
Ben Gelernter, Rick Sapir |
Review JPA topics to make sure all 2.2 and 2.3 features are documented and reviewed. Update as needed.
|
Ben Gelernter |
Create an Introduction/Overview section:
|
Ben Gelernter, Rick Sapir |
Review existing topics for consistency, e.g.:
|
Ben Gelernter |
Create documentation style guide specific to EclipseLink. The main source for documentation style is the Eclipse documentation standards. However, as EclipseLink-specific style issues that not covered by the Eclipse standards arise, the writers will post them on this wiki page. We will spend minimal time developing standards. Eclipse Doc Style Guide (for Eclipse Help): <a href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide">http://wiki.eclipse.org/Eclipse_Doc_Style_Guide</a> Writers may also find these pages useful: <a href="http://wiki.eclipse.org/DocumentationGuidelines">http://wiki.eclipse.org/DocumentationGuidelines</a> and <a href="http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines">http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines</a> |
Tom Pfaeffle (create the page) Entire team may contribute.
|
The following tables show the features that will be documented for EL 2.4.
JPA Features
Feature |
Design documents, examples, any other source material |
Subject Matter Expert |
Writer |
Enhanced Schema Provisioning: Schema upgrade to handle application version upgrades. Upon request the Schmea will be extended to add additional tables, columns, indexes. |
Not yet available? |
Peter Krogh and/or designee from his team |
|
MetadataSource support for PU Properties: During the bootstrap of a JPA persistence unit the Metadatasource will provide additional PU properties that can come from an external source to customize the PU properties used in the EntityManagerFactory creation. |
Not yet available? |
" |
|
JPA 2.1: Provide early access to some of the JPA 2.1 defined features. This will depend on the progress the expert group makes. |
Not yet available? |
" |
|
Gemini JPA: With the Gemini JPA 1.0 release scheduled to come out this summer the current solution available (which we have deprecated) need to be fully transitioned to leverage the Gemini solutions. This will involve updates or migration of examples but may also involve a coordinated Gemini release if feature work is included From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/): "The Gemini JPA project is about modular implementations of Java Persistence API technology. This project currently provides the integration with the EclipseLink JPA provider to support the OSGi JPA specification approach that clients can use to get JPA support in an OSGi framework." |
Not yet available? |
" |
|
Database Change Event Cache Invalidation: This project will provide an infrastructure for supporting database change events to invalidate the changed objects in the EclipseLink shared cache. |
<a href="http://wiki.eclipse.org/EclipseLink/DesignDocs/356812" title="EclipseLink/DesignDocs/356812">Database Change Event Cache Invalidation</a> |
" |
|
MOXy Features
Feature |
Design documents, examples, any other source material |
Subject Matter Expert |
Writer |
Object-JSON Mapping support |
<a href="http://wiki.eclipse.org/EclipseLink/DesignDocs/350483">Object-to-JSON Binding Layer</a> |
Blaise Doughan, David Twelves |
Rick Sapir |
Set of features to match extensions provided by JAXB RI |
"We are currently developing and tracking this list through Bugzilla enhancements." [David Twelves] |
David Twelves |
|
DBWS Features
Feature |
Design documents, examples, any other source material |
Subject Matter Expert |
Writer |
Parse DDL to extract database metadata: Change the way type metadata is accessed by DBWSBuilder, providing support for the following enhancement requests:
|
<a href="http://wiki.eclipse.org/EclipseLink/Development/DBWS/ParseDDLforMetadata">Parsing DDL for Metadata Design Spec</a> |
Mike Norman, David Twelves |
Rick Sapir |
RESTful JPA: Provide a JAX-RS solution for easily making a JPA persistence unit available through REST calls. (<a href="http://wiki.eclipse.org/EclipseLink/Development/2.4.0">EclipseLink 2.4.0 Development Plans</a> page says "BWS Generation of JAX-RS Web Services." |
Not yet available. "Planned for later in 2.4 dev cycle." [David Twelves] |
David Twelves |
Rick Sapir |
Printable Versions
We plan to provide a printable version of the EclipseLink wiki topics. When a new version of EclipseLink is released (and all documentation issues are wrapped up), we will generate a PDF version (and, if possible an HTML version) of the wiki topics and post that as the official documentation for a certain release. Updates may continue to be made on the wiki, but the PDF/HTML will not be regenerated until the next release.
Details about how to accomplish this are not yet resolved.
Scheduling and Reviews
Schedules must include time for:
- Documentation reviews by Dev/QA. Reviews will be conducted on the wiki.
- A final production review of the wiki including, but not limited to:
- Links to samples
- Links to Javadoc
- Cross-references
- Style consistency
All writers will contribute to the production review.
Bugs
All writers must have BugZilla accounts and review and handle documentation bugs against their EclipseLink topics.
If a writer is responsible for a feature that has no corresponding design documentation or if the design documentation does not contain enough information (missing details, code snippets, release, etc.), the writer should file a BugZilla bug against Development. (Use your judgment: often a phone call or e-mail can clear up a problem.)
Assignments
Joe Garcia |
Manager |
Donna Micozzi |
Manager
|
Ben Gelernter |
Lead, JPA topics |
Ed Spear |
JPA topics (TBD) |
Rick Sapir |
MOXy DBWS |
Tom Pfaeffle |
JPA topics (TBD) |
Issues
- Printable Version: Details about how to accomplish this are not yet resolved.
- Metadata to improve searching