Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "DSDP/MTJ/UserDocs"

< DSDP‎ | MTJ
(Updating status)
(Updates in Status)
Line 39: Line 39:
 
*Advanced Topics - <font color="GREEN">OK</font>
 
*Advanced Topics - <font color="GREEN">OK</font>
 
**Device Management - <font color="RED">Screenshots outdated, preference page name is wrong</font>
 
**Device Management - <font color="RED">Screenshots outdated, 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
 
**Mobile Tools for Java Preferences
 
**Mobile Tools for Java Preferences
Line 49: Line 49:
 
**About MIDlet Suite Signing
 
**About MIDlet Suite Signing
  
*Frequently Asked Questions
+
*Frequently Asked Questions - <font color="RED">Remove sections: "Unable to restore workbench state" a</font>
  
*Troubleshooting
+
*Troubleshooting - <font color="RED">Screenshots outdated. Remove section "Collectiong Preverification Information" and "Preprocessor Errors. Verify if the questions about unispecified platform and build path imcomplete are still valid</font>
  
*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]]

Revision as of 17:18, 25 July 2008

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 - Screenshots outdated
  • Creating a new MIDlet Project - Screenshots outdated
    • Java Application Descriptor Editor - Screenshots outdated
  • Create A New Midlet - Screenshots outdated
  • Running/Debugging a MIDlet - Screenshots outdated, running/debugging through right-click on project is not working
  • Packaging - Screenshots outdated, Menu name is wrong
  • Advanced Topics - OK
    • Device Management - Screenshots outdated, 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
    • Mobile Tools for Java Preferences
    • Project Properties
    • Antenna Support
    • About MIDlet Suite Signing
  • Frequently Asked Questions - Remove sections: "Unable to restore workbench state" a
  • Troubleshooting - Screenshots outdated. Remove section "Collectiong Preverification Information" and "Preprocessor Errors. 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

Back to the top