Jump to: navigation, search

Difference between revisions of "DSDP/MTJ/UserDocs"

< DSDP‎ | MTJ
(updating status)
(Reorganizing information)
Line 3: Line 3:
 
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.
  
Here is the list of user's documentation section and their actual status:
+
==== 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.
  
*Installing MTJ (<font color="RED">page missing</font>)
+
'''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 [http://www.eclipse.org/dsdp/mtj/contributing.php 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 (<font color="GREEN">OK</font>)
 
*Configuring MTJ and Eclipse (<font color="GREEN">OK</font>)
Line 24: Line 35:
 
*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">Screenshots outdated, running/debugging through right-click on project is not working</font>)
  
*Packaging
+
*Packaging (<font color="RED">Screenshots outdated, there are references to old EclipseME menus</font>)
  
 
*Advanced Topics
 
*Advanced Topics

Revision as of 16:14, 23 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, there are references to old EclipseME menus)
  • Advanced Topics
    • Device Management
    • Advanced - Adding JAR Files to a MIDlet Suite
    • Adding Javadoc or Source links to WTK libraries
  • Reference
    • Launch Configuration Settings
    • Mobile Tools for Java Preferences
    • Project Properties
    • Antenna Support
    • About MIDlet Suite Signing
  • Frequently Asked Questions
  • Troubleshooting
  • Developer Documentation
  • Acknowledgments
  • Legal