Jump to: navigation, search

Difference between revisions of "DSDP/MTJ/UserDocs"

< DSDP‎ | MTJ
(updating status)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<div style="border: 5px solid #ddd; background-color: #cc0000; padding: 10px; color: #fff; text-align: center">
 +
OUTDATED - Need revising!
 +
</div>
 +
 +
----
 +
 
This is the main page for documentation effort in MTJ project.
 
This is the main page for documentation effort in MTJ project.
  
 
If you're looking for User documentation itself, download and install our [http://download1.eclipse.org/dsdp/mtj/downloads/index.php latest nightly build] and look for "Mobile Tools for Java" inside Eclipse help contents.
 
If you're looking for User documentation itself, download and install our [http://download1.eclipse.org/dsdp/mtj/downloads/index.php latest nightly build] and look for "Mobile Tools for Java" inside Eclipse help contents.
  
Nowadays, MTJ user's documentation is shipped within MTJ and is accessible through Eclipse Help Menu. This documentation is missing some updates (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=238138 bug 238138]), and this page is intended to track the status of this updates. After that we will work to publish this documentation online.
 
  
== Documentation tracking ==
 
  
The current MTJ user's documentation was copied from EclipseME user's documentation during the code porting from Eclipse to MTJ. During this process some sections of the documentation became unnecessary, some became outdated and some new sessions are now required. Besides that, the current documentation must be refactored to match eclipse documentation standards.
+
==== Where we are now? ====
 +
Nowadays, MTJ user's documentation is shipped within MTJ and is accessible through Eclipse Help Menu.
 +
The current contents were copied from EclipseME user's documentation together with EclipseME source code. During this process some sections of the documentation became unnecessary, some became outdated and some new sessions are now required.
 +
 
 +
==== What’s Next? ====
 +
'''Phase 1:'''
 +
* Update existing documentation to reflect current MTJ status (see [https://bugs.eclipse.org/bugs/show_bug.cgi?id=238138 bug 238138]).
 +
* Publish documentation on MTJ website for online access.
 +
 
 +
'''Phase 2:'''
 +
* Refactor "table of contents" to have sections more aligned with the ones existent on other Eclipse Projects (such as JDT).
  
Here is the list of user's documentation section and their actual status:
+
==== Get Involved ====
 +
Your participation can help MTJ having a better User documentation. Point out problems encountered in current docs, suggest enhancements, send patches to fix the bugs listed below or write new doc, articles or tutorials. Take a look at the [http://www.eclipse.org/dsdp/mtj/contributing.php contributing page] to see how to start.
  
*Installing MTJ (<font color="RED">page missing</font>)
+
== Tracking ==
 +
==== Phase 1 ====
 +
Here is the list of user's documentation sections and their actual status:
  
*Configuring MTJ and Eclipse (<font color="GREEN">OK</font>)
+
*Configuring MTJ and Eclipse - <font color="GREEN">OK</font>
  
*Best Practices (<font color="RED">Screenshots outdated</font>)
+
*Best Practices - <font color="RED">Update screenshots</font>
  
*Creating a new MIDlet Project (<font color="RED">Screenshots outdated</font>)
+
*Creating a new MIDlet Project - <font color="RED">Update screenshots</font>
**Java Application Descriptor Editor (<font color="RED">Screenshots outdated</font>)
+
**Java Application Descriptor Editor - <font color="RED">Update screenshots</font>
  
*Create A New Midlet (<font color="RED">Screenshots outdated</font>)
+
*Create A New Midlet - <font color="RED">Update screenshots</font>
  
*Running/Debugging a MIDlet (<font color="RED">Screenshots outdated, running/debugging through right-click on project is not working</font>)
+
*Running/Debugging a MIDlet - <font color="RED">Update screenshots, running/debugging through right-click on project is not working</font>
  
*Packaging
+
*Packaging - <font color="RED">Update screenshots, Menu name is wrong</font>
  
*Advanced Topics
+
*Advanced Topics - <font color="GREEN">OK</font>
**Device Management
+
**Device Management - <font color="RED">Update screenshots, preference page name is wrong</font>
**Advanced - Adding JAR Files to a MIDlet Suite
+
**Advanced - Adding JAR Files to a MIDlet Suite - <font color="GREEN">OK</font>
**Adding Javadoc or Source links to WTK libraries
+
**Adding Javadoc or Source links to WTK libraries - <font color="RED">Add information about automatic finging javadoc for UEI SDKs</font>
  
*Reference
+
*Reference - <font color="GREEN">OK</font>
**Launch Configuration Settings
+
**Launch Configuration Settings - <font color="RED">Common tab screenshot out-of-date</font>
**Mobile Tools for Java Preferences
+
**Mobile Tools for Java Preferences - <font color="RED">Screenshots outdated, preference page name is wrong. Basic Preferences misses information about Debug time-outs</font>
**Project Properties
+
**Project Properties - <font color="RED">correct: The MTJ portion of the of the project properties has four pages. Update screenshots</font>
**Antenna Support
+
**Antenna Support - <font color="GREEN">OK, fix name in toc.xml</font>
**About MIDlet Suite Signing
+
**About MIDlet Suite Signing - <font color="RED">Section "Password Management": Verify if .keyring location is valid. Maintain reference for Nokia document?</font>
  
*Frequently Asked Questions
+
*Frequently Asked Questions - <font color="RED">Remove sections: "Unable to restore workbench state" and Preprocessor Errors. Verify if the questions about unispecified platform and build path imcomplete are still valid (test in different workspaces)</font>
  
*Troubleshooting
+
*Troubleshooting - <font color="RED">Update screenshots. Remove section "Collectiong Preverification Information"</font>Verify if the questions about unispecified platform and build path imcomplete are still valid
  
*Developer Documentation
+
*Developer Documentation - <font color="RED">Remove</font>
  
*Acknowledgments
+
*Acknowledgments - <font color="RED">Remove</font>
  
*Legal
+
*Legal - <font color="GREEN">OK</font>
  
 +
*Import project from EclipseME - <font color="RED">Add add a "How to" somewhere in the documentation</font>
  
 
[[Category:DSDP]] [[Category:MTJ]]
 
[[Category:DSDP]] [[Category:MTJ]]

Latest revision as of 18:57, 30 November 2008

OUTDATED - Need revising!


This is the main page for documentation effort in MTJ project.

If you're looking for User documentation itself, download and install our latest nightly build and look for "Mobile Tools for Java" inside Eclipse help contents.


Where we are now?

Nowadays, MTJ user's documentation is shipped within MTJ and is accessible through Eclipse Help Menu. The current contents were copied from EclipseME user's documentation together with EclipseME source code. During this process some sections of the documentation became unnecessary, some became outdated and some new sessions are now required.

What’s Next?

Phase 1:

  • Update existing documentation to reflect current MTJ status (see bug 238138).
  • Publish documentation on MTJ website for online access.

Phase 2:

  • Refactor "table of contents" to have sections more aligned with the ones existent on other Eclipse Projects (such as JDT).

Get Involved

Your participation can help MTJ having a better User documentation. Point out problems encountered in current docs, suggest enhancements, send patches to fix the bugs listed below or write new doc, articles or tutorials. Take a look at the contributing page to see how to start.

Tracking

Phase 1

Here is the list of user's documentation sections and their actual status:

  • Configuring MTJ and Eclipse - OK
  • Best Practices - Update screenshots
  • Creating a new MIDlet Project - Update screenshots
    • Java Application Descriptor Editor - Update screenshots
  • Create A New Midlet - Update screenshots
  • Running/Debugging a MIDlet - Update screenshots, running/debugging through right-click on project is not working
  • Packaging - Update screenshots, Menu name is wrong
  • Advanced Topics - OK
    • Device Management - Update screenshots, preference page name is wrong
    • Advanced - Adding JAR Files to a MIDlet Suite - OK
    • Adding Javadoc or Source links to WTK libraries - Add information about automatic finging javadoc for UEI SDKs
  • Reference - OK
    • Launch Configuration Settings - Common tab screenshot out-of-date
    • Mobile Tools for Java Preferences - Screenshots outdated, preference page name is wrong. Basic Preferences misses information about Debug time-outs
    • Project Properties - correct: The MTJ portion of the of the project properties has four pages. Update screenshots
    • Antenna Support - OK, fix name in toc.xml
    • About MIDlet Suite Signing - Section "Password Management": Verify if .keyring location is valid. Maintain reference for Nokia document?
  • Frequently Asked Questions - Remove sections: "Unable to restore workbench state" and Preprocessor Errors. Verify if the questions about unispecified platform and build path imcomplete are still valid (test in different workspaces)
  • Troubleshooting - Update screenshots. Remove section "Collectiong Preverification Information"Verify if the questions about unispecified platform and build path imcomplete are still valid
  • Developer Documentation - Remove
  • Acknowledgments - Remove
  • Legal - OK
  • Import project from EclipseME - Add add a "How to" somewhere in the documentation