blob: 7768eb7237c55158d9c7ac0da3adb2440e3bb16e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>2.1 Doc Plan</title></head><body><h1>2.1 Doc Plan</h1>
<p>The overall check list for 2.1 is available at:</p>
<p><a href="http://dev.eclipse.org/mhonarc/lists/eclipse-dev/msg02439.html">[eclipse-dev] 2.1 Documentation Effort</a></p>
<h2>Doc Freeze</h2>
<ul>
<li>March 26th</li>
</ul>
<h2>Testing/Fixing</h2>
<ul>
<li>March 27-28</li>
</ul>
<h2>User Documentation</h2>
<ul>
<li><img height="10" src="ok.gif" width="10"> Review and spell check the messages
in the .properties files (Dani)</li>
<li><img height="10" src="ok.gif" width="10"> Check the Welcome page for accuracy
(Dani)</li>
<li><img height="10" src="ok.gif" width="10"> Update the existing getting started
document (Dirk)
<ul>
<li>update</li>
<li>add a section on the Java Browsing Perspective</li>
</ul>
</li>
<li>Augment Getting Started docs
<ul>
<li><img height="10" src="ok.gif" width="10"> add Setting up your projects (JDT/Core)
<ul>
<li>importing a project</li>
<li>using source folders</li>
<li>mapping a project to an existing directory structure
<ul>
<li>filters</li>
</ul>
</li>
<li>linked output folders</li>
</ul>
</li>
<li> <img height="10" src="ok.gif" width="10"> add Getting started with
JUnit (Erich)</li>
</ul>
</li>
<li><img height="10" src="ok.gif" width="10"> Redo all screenshots. (OTT, Tod).</li>
<li><img height="10" src="ok.gif" width="10"> It is still unclear if we have to have width and height attributes for images.
OTT will provide a tool if we have to. (Dirk)</li>
<li><img height="10" src="ok.gif" width="10"> Screen shots may not be larger than 540 pixels in width. If we have to include
width attributes that is easy to check. Otherwise we have to check manually
or write a tool. </li>
<li><b><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">New</b>:
What's New in 2.1 section. (Adam)</li>
<li><b><img height="10" src="ok.gif" width="10">New</b>: Add a Tips&amp;Tricks section (Martin 1st pass).</li>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt=""> <b>New</b>:
Add a Platform Tips&amp;Tricks section
<ul>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">
Editor
<ul>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">
incremental search (Dani)<br>
</li>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">
goto last edit location (Dani)<br>
</li>
</ul>
</li>
<li><img height="10" src="ok.gif" width="10"> Compare (Andre)
<ul>
<li>Comparing zip archives with each other or with a folder</li>
</ul>
</li>
<li><img height="10" src="ok.gif" width="10"> Search (Dani)
<ul>
<li>global replace</li>
</ul>
</li>
</ul>
</li>
<li><img height="10" src="ok.gif" width="10"> JDT Readme for 2.1 (Dirk); </li>
<li>Link the new help context ids with the user documentation
<ul>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">JDT
UI (Adam)</li>
<li><img height="10" src="ok.gif" width="10"> Search (Dani)</li>
<li><img height="10" src="ok.gif" width="10"> Compare (Andre)</li>
<li><img height="10" src="ok.gif" width="10"> JDT JUnit (Erich)</li>
</ul>
</li>
<li>Tasks, Concepts and Reference section
<ul>
<li>correctness pass</li>
<li>Andre does 1st pass, will assign work based on the findings.<br>
Findings for Tasks:
<ul>
<li> <img height="10" src="ok.gif" width="10">Classpath UI needs update. Affected files tasks-{111,112,114,115,116}.htm
(Martin). </li>
<li><img height="10" src="ok.gif" width="10"> New screenshots for "Adding a classpath variable to the build path".
Affected file tasks-114.htm (Dirk). </li>
<li> <img height="10" src="ok.gif" width="10">Source container UI needs update. Affected files tasks-{13,14}.htm
(Martin). </li>
<li><img height="10" src="ok.gif" width="10"> Action "Occurrences in
File" is missing. Affected files: concepts-8.htm, ref-menu-search.htm
(Dani).</li>
<li><img height="10" src="ok.gif" width="10"> Update Search preference
page doc - see bug 35681 (Dani)<br>
</li>
<li><img height="10" src="ok.gif" width="10"> New refactoring screenshots.
Affected file tasks-{88,91,93,95,97,158,160,163,166,168,170,205}.htm
(Adam). </li>
<li> <img height="10" src="ok.gif" width="10"> QuickFix enablement via
Editor pref page needs update. File tasks-175.htm (Martin). </li>
<li><img height="10" src="ok.gif" width="10"> New screenshots for Externalize
Strings. Affected files tasks-{189,190}.htm (Adam). </li>
<li><img height="10" src="ok.gif" width="10"> New screenshots for Javadoc wizard. Affected files tasks-{199,200,201}.htm
(Dirk). </li>
<li> <img height="10" src="ok.gif" width="10">Exclusion filters missing. Affected files tasks-{26}.htm (Martin).
</li>
<li> <img style="height: 10px; width: 10px;" src="ok.gif" title="" alt="">New
screenshots for Type Hierarchy View. Affected files tasks-{44}.htm
(Martin). </li>
<li> <img height="10" src="ok.gif" width="10">Refactoring dialogs are
no longer wizards. Affected files tasks-{82,83,84,86}.htm (Adam).
</li>
</ul>
Findings for References:
<ul>
<li><img height="10" src="ok.gif" width="10"> Refactoring dialogs are
no longer wizards. Affected files ref-{117}.htm (Dirk). </li>
<li> <img height="10" src="ok.gif" width="10"> Build class path UI. Affected files ref-{123}.htm (Martin). </li>
<li> <img height="10" src="ok.gif" width="10">Source attachemnts UI has changed. Affected files ref-{124}.htm
(Martin). </li>
<li> <img height="10" src="ok.gif" width="10">Exclusion filter missing. Affected files ref-{128}.htm (Martin).
<li> <img height="10" src="ok.gif" width="10"> Check Extract method
errors in ref-154.htm (Dirk). </li>
<li> Java Editor preference page in ref-21.htm (Kai,Dani?). </li>
<li>more to come...</li>
</ul>
</li>
<li>complete
<ul>
<li><img height="10" src="ok.gif" width="10">the refactoring table (Adam)</li>
</ul>
</li>
<li>add&nbsp;
<ul>
<li><img height="10" src="ok.gif" width="10"> a table with quick assists (Martin, time permitted)</li>
<li> <img height="10" src="ok.gif" width="10">a table with quick fixes (Martin, time permitted)</li>
</ul>
</li>
</ul>
</li>
<li><img height="10" src="ok.gif" width="10"> Copyright (Dani)</li>
</ul>
<h2>ISV Doc</h2>
<ul>
<li> javadoc (complete, @since 2.1 tag)
<ul>
<li><img style="height: 10px; width: 10px;" src="ok.gif" title="" alt=""> Text (Kai, Dani<span style="font-family: monospace;"></span>)</li>
<li><img height="10" src="ok.gif" width="10"> Compare (Andre)</li>
<li><img height="10" src="ok.gif" width="10"> Search (Dani)</li>
<li>JDT UI&nbsp;
<ul>
<li><img height="10" src="ok.gif" width="10"> Text packages (Dani/Kai)</li>
<li><img height="10" src="ok.gif" width="10"> other (Dirk)</li>
</ul>
</li>
</ul>
</li>
<li>Review and complete extension point descriptions
<ul>
<li><img height="10" src="ok.gif" width="10"> Compare (Andre)</li>
<li><img height="10" src="ok.gif" width="10"> Search (Dani)</li>
<li><img height="10" src="ok.gif" width="10"> JDT_UI (Martin)</li>
<li><img height="10" src="ok.gif" width="10"> Text (Kai, Dani)</li>
<li><img height="10" src="ok.gif" width="10"> Copyright (Dani)
<ul>
<li><img height="10" src="ok.gif" width="10"> Compare (Andre)</li>
</ul>
</li>
</ul>
</li>
<li>Review and update the Plug-in developer guides
<ul>
<li>JDT UI (time permitted)
<ul>
<li>add: contributing actions to JDT menus explain menu slots (Dirk)</li>
</ul>
</li>
<li>JDT Text (time permitted)
<ul>
<li>add: hovers (Dani)</li>
</ul>
</li>
</ul>
</li>
<li>Add descriptions of new API in the corresponding programmer's guide
<ul>
<li><img height="10" src="ok.gif" width="10"> add: code generation (Martin, Dirk)</li>
</ul>
</li>
<li> Reference information
<ul>
<li>update JDT Plug-ins Map (<img height="10" src="ok.gif" width="10"> Adam
- jdt ui part)</li>
<li><img height="10" src="ok.gif" width="10"> review Questions Index (Dirk, Adam)</li>
</ul>
</li>
<li>Example
<ul>
<li><img height="10" src="ok.gif" width="10"> New: Compare property file example (Andre) </li>
<li><img height="10" src="ok.gif" width="10"> Check Java Example (updated version 3.7; removed unnecessary imports) (Dirk)</li>
</ul>
</li>
</ul>
</body></html>