Jump to: navigation, search

Difference between revisions of "EclipseLink/Development/Documentation/2.4"

m (New page: <html> <head> <meta http-equiv=Content-Type content="text/html; charset=windows-1252"> <meta name=Generator content="Microsoft Word 12 (filtered)"> <style> <!-- Font Definitions: @...)
 
Line 1: Line 1:
<html>
+
<H1>Documentation Plan for EclipseLink 2.4</H1>
  
<head>
+
<h2>Change Record</h2>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
+
<meta name=Generator content="Microsoft Word 12 (filtered)">
+
<style>
+
<!--
+
/* Font Definitions */
+
@font-face
+
{font-family:Wingdings;
+
panose-1:5 0 0 0 0 0 0 0 0 0;}
+
@font-face
+
{font-family:"Cambria Math";
+
panose-1:2 4 5 3 5 4 6 3 2 4;}
+
@font-face
+
{font-family:Cambria;
+
panose-1:2 4 5 3 5 4 6 3 2 4;}
+
@font-face
+
{font-family:Calibri;
+
panose-1:2 15 5 2 2 2 4 3 2 4;}
+
/* Style Definitions */
+
p.MsoNormal, li.MsoNormal, div.MsoNormal
+
{margin-top:0in;
+
margin-right:0in;
+
margin-bottom:10.0pt;
+
margin-left:0in;
+
line-height:115%;
+
font-size:11.0pt;
+
font-family:"Calibri","sans-serif";}
+
h1
+
{mso-style-link:"Heading 1 Char";
+
margin-top:12.0pt;
+
margin-right:0in;
+
margin-bottom:3.0pt;
+
margin-left:0in;
+
line-height:115%;
+
page-break-after:avoid;
+
font-size:16.0pt;
+
font-family:"Cambria","serif";}
+
h2
+
{mso-style-link:"Heading 2 Char";
+
margin-top:12.0pt;
+
margin-right:0in;
+
margin-bottom:3.0pt;
+
margin-left:0in;
+
line-height:115%;
+
page-break-after:avoid;
+
font-size:14.0pt;
+
font-family:"Cambria","serif";
+
font-style:italic;}
+
h3
+
{mso-style-link:"Heading 3 Char";
+
margin-top:12.0pt;
+
margin-right:0in;
+
margin-bottom:3.0pt;
+
margin-left:0in;
+
line-height:115%;
+
page-break-after:avoid;
+
font-size:13.0pt;
+
font-family:"Cambria","serif";}
+
p.MsoTitle, li.MsoTitle, div.MsoTitle
+
{mso-style-link:"Title Char";
+
margin-top:12.0pt;
+
margin-right:0in;
+
margin-bottom:3.0pt;
+
margin-left:0in;
+
text-align:center;
+
line-height:115%;
+
font-size:16.0pt;
+
font-family:"Cambria","serif";
+
font-weight:bold;}
+
p.MsoSubtitle, li.MsoSubtitle, div.MsoSubtitle
+
{mso-style-link:"Subtitle Char";
+
margin-top:0in;
+
margin-right:0in;
+
margin-bottom:3.0pt;
+
margin-left:0in;
+
text-align:center;
+
line-height:115%;
+
font-size:12.0pt;
+
font-family:"Cambria","serif";}
+
a:link, span.MsoHyperlink
+
{color:blue;
+
text-decoration:underline;}
+
a:visited, span.MsoHyperlinkFollowed
+
{color:purple;
+
text-decoration:underline;}
+
p.MsoNoSpacing, li.MsoNoSpacing, div.MsoNoSpacing
+
{margin:0in;
+
margin-bottom:.0001pt;
+
font-size:11.0pt;
+
font-family:"Calibri","sans-serif";}
+
span.MsoSubtleEmphasis
+
{color:gray;
+
font-style:italic;}
+
span.MsoIntenseEmphasis
+
{color:#4F81BD;
+
font-weight:bold;
+
font-style:italic;}
+
span.MsoSubtleReference
+
{font-variant:small-caps;
+
color:#C0504D;
+
text-decoration:underline;}
+
span.MsoIntenseReference
+
{font-variant:small-caps;
+
color:#C0504D;
+
letter-spacing:.25pt;
+
font-weight:bold;
+
text-decoration:underline;}
+
span.Heading1Char
+
{mso-style-name:"Heading 1 Char";
+
mso-style-link:"Heading 1";
+
font-family:"Cambria","serif";
+
font-weight:bold;}
+
span.Heading2Char
+
{mso-style-name:"Heading 2 Char";
+
mso-style-link:"Heading 2";
+
font-family:"Cambria","serif";
+
font-weight:bold;
+
font-style:italic;}
+
span.TitleChar
+
{mso-style-name:"Title Char";
+
mso-style-link:Title;
+
font-family:"Cambria","serif";
+
font-weight:bold;}
+
span.Heading3Char
+
{mso-style-name:"Heading 3 Char";
+
mso-style-link:"Heading 3";
+
font-family:"Cambria","serif";
+
font-weight:bold;}
+
span.SubtitleChar
+
{mso-style-name:"Subtitle Char";
+
mso-style-link:Subtitle;
+
font-family:"Cambria","serif";}
+
span.ornotepadcommenttext
+
{mso-style-name:or_notepadcommenttext;}
+
@page WordSection1
+
{size:8.5in 11.0in;
+
margin:1.0in 1.0in 1.0in 1.0in;}
+
div.WordSection1
+
{page:WordSection1;}
+
/* List Definitions */
+
ol
+
{margin-bottom:0in;}
+
ul
+
{margin-bottom:0in;}
+
-->
+
</style>
+
  
</head>
+
<p>&nbsp;</p>
  
<body lang=EN-US link=blue vlink=purple>
+
<table border=1 cellspacing=1 cellpadding=1>
 
+
<div class=WordSection1>
+
 
+
<p class=MsoTitle>Documentation Plan for EclipseLink 2.4</p>
+
 
+
<h1>Change Record</h1>
+
 
+
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><strong>Date</strong></p>
   <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Date
+
  </span></strong></p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><strong>Author</strong></p>
   <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Author</span></strong></p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><strong>Change Record</strong></p>
   <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Change
+
  Record</span></strong></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td >
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>7/28/11</p>
   <p class=MsoNormal>7/28/11</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>First draft</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>First draft</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td >
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>8/11/11</p>
   <p class=MsoNormal>8/11/11</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Incorporated changes from doc manager  review.</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Incorporated changes from doc manager  review.</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>8/17/11</p>
   <p class=MsoNormal>8/17/11</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
   <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Incorporated changes from doc team review</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Incorporated changes from doc team review</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
<p class=MsoNormal>This documentation plan describes how the documentation team
+
<p>This documentation plan describes how the documentation team will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.</p>
will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.</p>
+
  
 
<h1>Schedule</h1>
 
<h1>Schedule</h1>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Milestone</b></p>
   <p class=MsoNormal><b>Milestone</b></p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Date</b></p>
   <p class=MsoNormal><b>Date</b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Doc plan first draft</p>
   <p class=MsoNormal>Doc plan first draft</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>8/10/11</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>8/10/11</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Doc plan posted</p>
   <p class=MsoNormal>Doc plan posted</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>8/17/11 </p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>8/17/11 </p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Doc plan comments due</p>
   <p class=MsoNormal>Doc plan comments due</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>8/24/11</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>8/24/11</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Final doc plan </p>
   <p class=MsoNormal>Final doc plan </p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>8/29/11</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>8/29/11</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>EclipseLink release 2.4</p>
   <p class=MsoNormal>EclipseLink release 2.4</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p><s>10/26/11</s> – probably postponed until &quot;into the
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal><s>10/26/11</s> – probably postponed until &quot;into the
+
 
   new year,&quot; per Doug C.</p>
 
   new year,&quot; per Doug C.</p>
 
   </td>
 
   </td>
Line 303: Line 110:
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
 
<h1>Audience</h1>
 
<h1>Audience</h1>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>User</b></p>
   <p class=MsoNormal><b>User</b></p>
+
 
   </td>
 
   </td>
   <td width=451 valign=top style='width:4.7in;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Description</b></p>
   <p class=MsoNormal><b>Description</b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Application Developers</p>
   <p class=MsoNormal>Application Developers</p>
+
 
   </td>
 
   </td>
   <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none;
+
   <td>
  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Developers who want to develop applications using any of
  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 style='margin-top:0in' type=disc>
+
   <ul>
   <li class=MsoNormal>Java Persistence Architecture (JPA) 2.x plus the
+
   <li>Java Persistence Architecture (JPA) 2.x plus the
 
       EclipseLink JPA extensions</li>
 
       EclipseLink JPA extensions</li>
   <li class=MsoNormal>Java Architecture for XML Binding 2.x (JAXB) plus the
+
   <li>Java Architecture for XML Binding 2.x (JAXB) plus the
 
       EclipseLink MOXy extensions.</li>
 
       EclipseLink MOXy extensions.</li>
   <li class=MsoNormal>Java API for XML Web Services 2.x (JAX-WS) plus EclipseLink
+
   <li>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 class=MsoNormal>Developers should be familiar with the concepts and
+
   <p>Developers should be familiar with the concepts and
 
   programming practices of:</p>
 
   programming practices of:</p>
   <ul style='margin-top:0in' type=disc>
+
   <ul>
   <li class=MsoNormal>Java SE</li>
+
   <li>Java SE</li>
   <li class=MsoNormal>Java EE</li>
+
   <li>Java EE</li>
 
   </ul>
 
   </ul>
   <p class=MsoNormal><b><i>//REVIEWERS: Should this specify a Java version?
+
   <p><b><i>//REVIEWERS: Should this specify a Java version?
 
   which?//</i></b></p>
 
   which?//</i></b></p>
   <p class=MsoNormal><b>Assumed knowledge:</b></p>
+
   <p><b>Assumed knowledge:</b></p>
   <ul style='margin-top:0in' type=disc>
+
   <ul>
   <li class=MsoNormal>Developers using EclipseLink JPA should be familiar with
+
   <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 class=MsoNormal>Developers using EclipseLink MOXy should be familiar
+
   <li>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 class=MsoNormal>Developers using EclipseLink DBWS should be familiar
+
   <li>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 357: Line 158:
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Administrator/Deployer</p>
   <p class=MsoNormal>Administrator/Deployer</p>
+
 
   </td>
 
   </td>
   <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none;
+
   <td>
  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Users who want to deploy and manage applications using the
  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 class=MsoNormal><b>Assumed knowledge:</b></p>
+
   <p><b>Assumed knowledge:</b></p>
   <p class=MsoNormal>These users should be familiar with basic operations of
+
   <p>These users should be familiar with basic operations of
 
   the chosen Java EE compliant application server.</p>
 
   the chosen Java EE compliant application server.</p>
   <p class=MsoNormal><b><i>//REVIEWERS: Is this correct simply to say
+
   <p><b><i>//REVIEWERS: Is this correct simply to say
 
   &quot;Java EE compliant app server&quot;? Should it  be something like
 
   &quot;Java EE compliant app server&quot;? Should it  be something like
 
   &quot;Java </i></b><b><i><span style='font-size:14.0pt;line-height:115%'>5</span>
 
   &quot;Java </i></b><b><i><span style='font-size:14.0pt;line-height:115%'>5</span>
Line 380: Line 178:
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
 
<h1>Planned Documentation Deliverables</h1>
 
<h1>Planned Documentation Deliverables</h1>
  
<p class=MsoNormal>The Documentation team will document EclipseLink-specific
+
<p>The Documentation team will document EclipseLink-specific
 
features for:</p>
 
features for:</p>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>JPA (this is the highest priority)</li>
+
  <li>JPA (this is the highest priority)</li>
  <li class=MsoNormal>MOXy</li>
+
  <li>MOXy</li>
  <li class=MsoNormal>DBWS</li>
+
  <li>DBWS</li>
 
</ul>
 
</ul>
  
<p class=MsoNormal>The Documentation team will not document EIS, SDO, <span
+
<p>The Documentation team will not document EIS, SDO, <span
 
class=ornotepadcommenttext>or any other &quot;native&quot; TopLink
 
class=ornotepadcommenttext>or any other &quot;native&quot; 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 399: Line 197:
 
<h2>Documentation Design</h2>
 
<h2>Documentation Design</h2>
  
<p class=MsoNormal>The wiki topics will be handled as follows:</p>
+
<p>The wiki topics will be handled as follows:</p>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>All EclipseLink documentation will be maintained under the
+
  <li>All EclipseLink documentation will be maintained under the
 
     <i>Documentation Center</i> on the EclipseLink wiki at <a
 
     <i>Documentation Center</i> on the EclipseLink wiki at <a
 
     href="http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide</a>.
 
     href="http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide</a>.
 
     </li>
 
     </li>
  <li class=MsoNormal>Versioning will be handled as follows:</li>
+
  <li>Versioning will be handled as follows:</li>
  <ul style='margin-top:0in' type=circle>
+
  <ul>
   <li class=MsoNormal>A note &quot;New in EL 2.<i>n</i>&quot; will be placed
+
   <li>A note &quot;New in EL 2.<i>n</i>&quot; 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 class=MsoNormal>A note  &quot; New in version 2.<i>n</i>.&quot; will be
+
   <li>A note  &quot; New in version 2.<i>n</i>.&quot; 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 class=MsoNormal>If a new feature is handled in an existing topic and the
+
   <li>If a new feature is handled in an existing topic and the
 
       topic changes more than 50%, the note &quot; New in version 2.<i>n</i>.&quot;
 
       topic changes more than 50%, the note &quot; New in version 2.<i>n</i>.&quot;
 
       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 class=MsoNormal>Header and footers on the wiki page will contain no
+
   <li>Header and footers on the wiki page will contain no
 
       references to release numbers. </li>
 
       references to release numbers. </li>
   <li class=MsoNormal>If a feature is deprecated, a note will placed next to
+
   <li>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 class=MsoNormal>Each topic will document one &quot;feature.&quot; The term
+
  <li>Each topic will document one &quot;feature.&quot; The term
 
     &quot;feature&quot; here is somewhat loose. In some cases, it is a single
 
     &quot;feature&quot; 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 class=MsoNormal>These topics are more-or-less &quot;reference&quot;
+
  <li>These topics are more-or-less &quot;reference&quot;
 
     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 435: Line 233:
 
     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 class=MsoNormal>The JPA topics will primarily focus on using annotations,
+
  <li>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, &quot;Use the @Xyz annotation to…&quot; and most or all examples and
 
     like, &quot;Use the @Xyz annotation to…&quot; and most or all examples and
Line 442: Line 240:
 
     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 class=MsoNormal>Every topic will cross-reference:</li>
+
  <li>Every topic will cross-reference:</li>
  <ul style='margin-top:0in' type=circle>
+
  <ul>
   <li class=MsoNormal> Any associated example provided by Development and
+
   <li> 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 class=MsoNormal>Any associated Javadoc. When an annotation is available,
+
   <li>Any associated Javadoc. When an annotation is available,
 
       the reference will be to the annotation(s), not the &quot;native
 
       the reference will be to the annotation(s), not the &quot;native
 
       API.&quot;</li>
 
       API.&quot;</li>
 
  </ul>
 
  </ul>
  <li class=MsoNormal>The Documentation team will not document features that are
+
  <li>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 458: Line 256:
 
     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 style='margin-top:0in' type=circle>
+
  <ul>
   <li class=MsoNormal>Previous and Next browse sequence links at the bottom of
+
   <li>Previous and Next browse sequence links at the bottom of
 
       the page </li>
 
       the page </li>
   <li class=MsoNormal>Links from the Table of Contents</li>
+
   <li>Links from the Table of Contents</li>
   <li class=MsoNormal>Links from the parent, or container, topic, if there is
+
   <li>Links from the parent, or container, topic, if there is
 
       one. For example, the JPA documentation includes a &quot;Weaving
 
       one. For example, the JPA documentation includes a &quot;Weaving
 
       Topic&quot; which introduces several weaving-related topics under it. </li>
 
       Topic&quot; which introduces several weaving-related topics under it. </li>
Line 468: Line 266:
 
</ul>
 
</ul>
  
<p class=MsoNormal style='margin-left:1.0in'>Note: A container topic should not
+
<p 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:  &quot;The EclipseLink cache is an in-memory repository
 
sentence. For example:  &quot;The EclipseLink cache is an in-memory repository
that stores recently read or written objects based on class and primary key values.
+
that stores recently read or written objects based on class and primary key
Caching is discussed in the following topics:&quot;</p>
+
values. Caching is discussed in the following topics:&quot;</p>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>Individual topics will not include cross references to the
+
  <li>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 class=MsoNormal>If design documents (specs) are not available or do not
+
  <li>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 486: Line 284:
 
<h2>Tasks/Deliverables</h2>
 
<h2>Tasks/Deliverables</h2>
  
<p class=MsoNormal>The following tasks are not specifically associated with the
+
<p>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 492: Line 290:
 
<h3>General</h3>
 
<h3>General</h3>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b><i>Task/Deliverable</i></b></p>
   <p class=MsoNormal><b><i>Task/Deliverable</i></b></p>
+
 
   </td>
 
   </td>
   <td width=233 valign=top style='width:174.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b><i>Writer</i></b></p>
   <p class=MsoNormal><b><i>Writer</i></b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Identify topics in the JPA TOC that are documented in the
   <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 width=233 valign=top style='width:174.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter, Rick Sapir</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter, Rick Sapir</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Review JPA topics to make sure all 2.2 and 2.3 features
   <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 class=MsoNormal>&nbsp;</p>
+
   <p>&nbsp;</p>
 
   </td>
 
   </td>
   <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Create an Introduction/Overview section:</p>
   <p class=MsoNormal>Create an Introduction/Overview section:</p>
+
   <ul>
   <ul style='margin-top:0in' type=disc>
+
   <li>If introductory information exists elsewhere (e.g., the
   <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 class=MsoNormal>Write any introductory information that is missing,
+
   <li>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 width=233 valign=top style='width:174.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter, Rick Sapir</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter, Rick Sapir</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Review existing topics for consistency, e.g.:</p>
   <p class=MsoNormal>Review existing topics for consistency, e.g.:</p>
+
   <ul>
   <ul style='margin-top:0in' type=disc>
+
   <li>Navigation links</li>
   <li class=MsoNormal>Navigation links</li>
+
   <li>Lists of links in topics (TOCs for sections)</li>
   <li class=MsoNormal>Lists of links in topics (TOCs for sections)</li>
+
   <li>Headers/footers</li>
   <li class=MsoNormal>Headers/footers</li>
+
   <li>Tables, examples</li>
   <li class=MsoNormal>Tables, examples</li>
+
   <li>Key API links (qualified by path?) </li>
   <li class=MsoNormal>Key API links (qualified by path?) </li>
+
 
   </ul>
 
   </ul>
 
   </td>
 
   </td>
   <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Ben Gelernter</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Create documentation style guide specific to EclipseLink. </p>
   <p class=MsoNormal>Create documentation style guide specific to EclipseLink. </p>
+
   <p>The main source for documentation style is the Eclipse
   <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 class=MsoNormal>Eclipse Doc Style Guide (for Eclipse Help): <a
+
   <p>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></p>
 
   href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide">http://wiki.eclipse.org/Eclipse_Doc_Style_Guide</a></p>
   <p class=MsoNormal>Writers may also find these pages useful: <a
+
   <p>Writers may also find these pages useful: <a
 
   href="http://wiki.eclipse.org/DocumentationGuidelines">http://wiki.eclipse.org/DocumentationGuidelines</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>
 
   and <a href="http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines">http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines</a></p>
 
   </td>
 
   </td>
   <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p> Tom Pfaeffle (create the page)</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Entire team may contribute.</p>
   <p class=MsoNormal> Tom Pfaeffle (create the page)</p>
+
   <p><b><i>&nbsp;</i></b></p>
   <p class=MsoNormal>Entire team may contribute.</p>
+
   <p class=MsoNormal><b><i>&nbsp;</i></b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
<p class=MsoNormal>The following tables show the features that will be
+
<p>The following tables show the features that will be documented
documented for EL 2.4.</p>
+
for EL 2.4.</p>
  
 
<h3>JPA Features</h3>
 
<h3>JPA Features</h3>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <td>
   <p class=MsoNormal><b>Feature          </b></p>
+
   <p><b>Feature          </b></p>
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Design documents, examples, any other source material</b></p>
   <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
+
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Subject Matter Expert</b></p>
   <p class=MsoNormal><b>Subject Matter Expert</b></p>
+
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Writer</b></p>
   <p class=MsoNormal><b>Writer</b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Enhanced Schema Provisioning: </b>Schema upgrade to
   <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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td
   border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   border-right:solid windowtext 1.0pt;>
   <p class=MsoNormal>Not yet available?</p>
+
   <p>Not yet available?</p>
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td
   border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   border-right:solid windowtext 1.0pt;>
   <p class=MsoNormal>?</p>
+
   <p>?</p>
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td
   border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   border-right:solid windowtext 1.0pt;>
   <p class=MsoNormal>&nbsp;</p>
+
   <p>&nbsp;</p>
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>MetadataSource support for PU Properties: </b>During
   <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
+
   additional PU properties that can come from an external source to customize
   PU properties that can come from an external source to customize the PU
+
   the PU properties used in the EntityManagerFactory creation.</p>
   properties used in the EntityManagerFactory creation.</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>?</p>
   <p class=MsoNormal>?</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>&nbsp;</p>
   <p class=MsoNormal>&nbsp;</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>JPA 2.1</b>: Provide early access to some of the JPA
   <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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td
   border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   border-right:solid windowtext 1.0pt;>
   <p class=MsoNormal>?</p>
+
   <p>?</p>
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>&nbsp;</p>
   <p class=MsoNormal>&nbsp;</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Gemini JPA</b>: With the Gemini JPA 1.0 release
   <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 class=MsoNormal>From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/):
+
   <p>From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/):
   &quot;The Gemini JPA project is about modular implementations of Java Persistence
+
   &quot;The Gemini JPA project is about modular implementations of Java
   API technology. This project currently provides the integration with the
+
   Persistence API technology. This project currently provides the integration
   EclipseLink JPA provider to support the OSGi JPA specification approach that
+
   with the EclipseLink JPA provider to support the OSGi JPA specification
   clients can use to get JPA support in an OSGi framework.&quot;</p>
+
   approach that clients can use to get JPA support in an OSGi framework.&quot;</p>
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>?</p>
   <p class=MsoNormal>?</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>&nbsp;</p>
   <p class=MsoNormal>&nbsp;</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
Line 707: Line 471:
 
<h3>MOXy Features</h3>
 
<h3>MOXy Features</h3>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Feature</b></p>
   <p class=MsoNormal><b>Feature         </b></p>
+
 
   </td>
 
   </td>
   <td width=283 valign=top style='width:212.2pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Design documents, examples, any other source material</b></p>
   <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
+
 
   </td>
 
   </td>
   <td width=124 valign=top style='width:92.85pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Subject Matter Expert</b></p>
   <p class=MsoNormal><b>Subject Matter Expert</b></p>
+
 
   </td>
 
   </td>
   <td width=67 valign=top style='width:50.45pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Writer</b></p>
   <p class=MsoNormal><b>Writer</b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Object-JSON</b> Mapping support</p>
   <p class=MsoNormal><b>Object-JSON</b> Mapping support</p>
+
 
   </td>
 
   </td>
   <td width=283 valign=top style='width:212.2pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Not yet available?</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Not yet available?</p>
+
 
   </td>
 
   </td>
   <td width=124 valign=top style='width:92.85pt;border-top:none;border-left:
+
   <td>
  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>?</p>
+
 
   </td>
 
   </td>
   <td width=67 valign=top style='width:50.45pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Rick Sapir</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Rick Sapir</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
Line 752: Line 504:
 
<h3>DBWS Features</h3>
 
<h3>DBWS Features</h3>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <td>
   <p class=MsoNormal><b>Feature</b></p>
+
   <p><b>Feature</b></p>
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Design documents, examples, any other source material</b></p>
   <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
+
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Subject Matter Expert</b></p>
   <p class=MsoNormal><b>Subject Matter Expert</b></p>
+
 
   </td>
 
   </td>
   <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>Writer</b></p>
   <p class=MsoNormal><b>Writer</b></p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>2.3 Features:</b></p>
   <p class=MsoNormal><b>2.3 Features:</b></p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Meetings in progress</p>
   <p class=MsoNormal>Meetings in progress</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>David Twelves</p>
   <p class=MsoNormal>David Twelves</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>&nbsp;</p>
   <p class=MsoNormal>&nbsp;</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p><b>RESTful JPA</b>: Provide a JAX-RS solution for easily
   <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>
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  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 valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>David Twelves</p>
   <p class=MsoNormal>David Twelves</p>
+
 
   </td>
 
   </td>
   <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
+
   <td>
  border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Rick Sapir</p>
   <p class=MsoNormal>Rick Sapir</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
 
<h1>Scheduling and Reviews</h1>
 
<h1>Scheduling and Reviews</h1>
  
<p class=MsoNormal>Schedules must include time for:</p>
+
<p>Schedules must include time for:</p>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>Documentation reviews by Dev/QA. Reviews will be conducted
+
  <li>Documentation reviews by Dev/QA. Reviews will be conducted
 
     on the wiki.</li>
 
     on the wiki.</li>
  <li class=MsoNormal>A final production review of the wiki including, but not limited
+
  <li>A final production review of the wiki including, but not limited
 
     to:</li>
 
     to:</li>
 
</ul>
 
</ul>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <ul style='margin-top:0in' type=circle>
+
  <ul>
   <li class=MsoNormal>Links to samples</li>
+
   <li>Links to samples</li>
   <li class=MsoNormal>Links to Javadoc</li>
+
   <li>Links to Javadoc</li>
   <li class=MsoNormal>Cross-references</li>
+
   <li>Cross-references</li>
   <li class=MsoNormal>Style consistency</li>
+
   <li>Style consistency</li>
 
  </ul>
 
  </ul>
 
</ul>
 
</ul>
  
<p class=MsoNormal style='text-indent:.5in'>All writers will contribute to the production
+
<p style='text-indent:.5in'>All writers will contribute to the
review.</p>
+
production review.</p>
  
 
<h1>Bugs</h1>
 
<h1>Bugs</h1>
  
<p class=MsoNormal>All writers must have BugZilla accounts and review and
+
<p>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 class=MsoNormal>If a writer is responsible for a feature that has no
+
<p>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 848: Line 588:
 
<h1>Assignments</h1>
 
<h1>Assignments</h1>
  
<table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
+
<table border=1>
style='border-collapse:collapse;border:none'>
+
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Joe Garcia</p>
   <p class=MsoNormal>Joe Garcia</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Manager </p>
   <p class=MsoNormal>Manager </p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Donna Micozzi</p>
   <p class=MsoNormal>Donna Micozzi</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Manager </p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p>&nbsp;</p>
   <p class=MsoNormal>Manager </p>
+
   <p class=MsoNormal>&nbsp;</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Ben Gelernter</p>
   <p class=MsoNormal>Ben Gelernter</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>Lead, JPA topics</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>Lead, JPA topics</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Ed Spear</p>
   <p class=MsoNormal>Ed Spear</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>JPA topics (TBD)</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>JPA topics (TBD)</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Rick Sapir</p>
   <p class=MsoNormal>Rick Sapir</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>MOXy</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p>DBWS</p>
   <p class=MsoNormal>MOXy</p>
+
   <p class=MsoNormal>DBWS</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
  <tr>
 
  <tr>
   <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
+
   <td>
  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
+
   <p>Tom Pfaeffle</p>
   <p class=MsoNormal>Tom Pfaeffle</p>
+
 
   </td>
 
   </td>
   <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
+
   <td>
  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
+
   <p>JPA topics (TBD)</p>
  padding:0in 5.4pt 0in 5.4pt'>
+
   <p class=MsoNormal>JPA topics (TBD)</p>
+
 
   </td>
 
   </td>
 
  </tr>
 
  </tr>
 
</table>
 
</table>
  
<p class=MsoNormal>&nbsp;</p>
+
<p>&nbsp;</p>
  
 
<h1>Issues</h1>
 
<h1>Issues</h1>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>Printable Version</li>
+
  <li>Printable Version</li>
 
</ul>
 
</ul>
  
<p class=MsoNormal style='margin-left:.5in'>We are considering providing a
+
<p style='margin-left:.5in'>We are considering providing a
 
printable version of the EclipseLink wiki topics. When a new version of
 
printable version of the EclipseLink wiki topics. When a new version of
 
EclipseLink is released (and all documentation issues are wrapped up), we want
 
EclipseLink is released (and all documentation issues are wrapped up), we want
Line 935: Line 657:
 
regenerated until the next release.</p>
 
regenerated until the next release.</p>
  
<p class=MsoNormal style='margin-left:.5in'>Details about how to accomplish
+
<p style='margin-left:.5in'>Details about how to accomplish
 
this are not yet resolved.</p>
 
this are not yet resolved.</p>
  
<ul style='margin-top:0in' type=disc>
+
<ul>
  <li class=MsoNormal>Metadata to improve searching</li>
+
  <li>Metadata to improve searching</li>
 
</ul>
 
</ul>
 
</div>
 
 
</body>
 
 
</html>
 

Revision as of 09:23, 18 August 2011

Documentation Plan for EclipseLink 2.4

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

 

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

10/26/11 – probably postponed until "into the new year," per Doug C.

 

Audience

User

Description

Application Developers

Developers who want to develop applications using any of the following technologies for persistence services:

  • Java Persistence Architecture (JPA) 2.x plus the EclipseLink JPA extensions
  • Java Architecture for XML Binding 2.x (JAXB) plus the EclipseLink MOXy extensions.
  • Java API for XML Web Services 2.x (JAX-WS) plus EclipseLink Database Web Services (DBWS) features.

Developers should be familiar with the concepts and programming practices of:

  • Java SE
  • Java EE

//REVIEWERS: Should this specify a Java version? which?//

Assumed knowledge:

  • Developers using EclipseLink JPA should be familiar with the concepts and programming practices of JPA 2.x.
  • Developers using EclipseLink MOXy should be familiar with the concepts and programming practices of JAXB 2.x.
  • Developers using EclipseLink DBWS should be familiar with the concepts and programming practices of JAX-WS 2.x.

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 Java EE compliant application server.

//REVIEWERS: Is this correct simply to say "Java EE compliant app server"? Should it  be something like "Java 5 EE compliant app server—some features are available only with Java 6 (or 7?) EE, and therefore users of those features should be familiar with those features in Java 6/7."? It may not even be important to specify. Please advise//

 

Planned Documentation Deliverables

The Documentation team will document EclipseLink-specific features for:

  • JPA (this is the highest priority)
  • MOXy
  • DBWS

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
      EL NewIn.png New in version 2.n.
      .
    • 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:

  • If introductory information exists elsewhere (e.g., the JPA intro section), move it to this section
  • Write any introductory information that is missing, including cross-references to the specifications (JPA, JAXB)

Ben Gelernter, Rick Sapir

Review existing topics for consistency, e.g.:

  • Navigation links
  • Lists of links in topics (TOCs for sections)
  • Headers/footers
  • Tables, examples
  • Key API links (qualified by path?)

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?

?

 

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?

?

 

MOXy Features

Feature

Design documents, examples, any other source material

Subject Matter Expert

Writer

Object-JSON Mapping support

Not yet available?

?

Rick Sapir

DBWS Features

Feature

Design documents, examples, any other source material

Subject Matter Expert

Writer

2.3 Features:

Meetings in progress

David Twelves

 

RESTful JPA: Provide a JAX-RS solution for easily making a JPA persistence unit available through REST calls.

Not yet available?

David Twelves

Rick Sapir

 

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

We are considering providing a printable version of the EclipseLink wiki topics. When a new version of EclipseLink is released (and all documentation issues are wrapped up), we want to 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.

  • Metadata to improve searching