This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 21278 - Modules Tutorial opening doc't is very unclear
Summary: Modules Tutorial opening doc't is very unclear
Status: RESOLVED WONTFIX
Alias: None
Product: usersguide
Classification: Unclassified
Component: API Support (show other bugs)
Version: 3.x
Hardware: PC Windows ME/2000
: P4 blocker (vote)
Assignee: Jesse Glick
URL:
Keywords:
Depends on:
Blocks: 18707
  Show dependency tree
 
Reported: 2002-03-06 23:17 UTC by mobigeek
Modified: 2005-09-07 00:08 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
Suggested updated docs for this issue. (2.27 KB, text/plain)
2002-03-07 00:20 UTC, mobigeek
Details
A step-by-step description of creating a Hello World module using the IDE Module template (3.59 KB, text/plain)
2002-03-07 21:06 UTC, mobigeek
Details

Note You need to log in before you can comment on or make changes to this bug.
Description mobigeek 2002-03-06 23:17:29 UTC
1. Help -> Help Sets -> Open APIs Support
2. Click on (not expand) the folder "Module Tutorials"
3. Follow the instructions

Unless one has a good knowledge of the IDE and where each of
the parts are, it is quite troublesome to get started.

Each sentence of the second paragraph states a necessary
high-level step in the process of creating an Open API module,
but it does not describe how to do that step (i.e. which menu items
to select, which dialog to fill out, where the "JAR" is that is
to be clicked, etc...)

And before someone says "who would develop a plugin without
knowing the IDE intimately?".  I am porting a plugin I wrote for another
IDE (that I also don't know well).  I did not have this much trouble
getting started with their Open Tools API...  ;-)
Comment 1 mobigeek 2002-03-07 00:20:53 UTC
Created attachment 4971 [details]
Suggested updated docs for this issue.
Comment 2 mobigeek 2002-03-07 00:24:10 UTC
I've just posted a file containing a suggested replacement/addition
to the "unclear" docs.  The steps within are from a non-hard-core
NB user.  The steps are clear for "newbies", but may have some
inefficiencies and/or bad practices.  Feel free to make mods as
necessary (I'd be happy to make further changes if given specific 
feedback).
Comment 3 Jesse Glick 2002-03-07 08:42:06 UTC
Thanks for the report. Also see issue #18707, these edits should be
applied together I guess.
Comment 4 mobigeek 2002-03-07 21:06:59 UTC
Created attachment 4993 [details]
A step-by-step description of creating a Hello World module using the IDE Module template
Comment 5 mobigeek 2002-03-07 21:09:47 UTC
I just uploaded a step-by-step tutorial for creation of a 
Hello World! IDE module.

The instructions (step #3 specifically) have three questions
set out in square brackets.  These are questions about particular
wording of the Wizard dialogs.  Might be worth turning those questions
into bugs/enhancement requests.

Hope this serves some use.
Comment 6 Marek Grummich 2002-07-22 08:20:37 UTC
Target milestone was changed from '3.4' to TBD.
Comment 7 Jesse Glick 2003-03-10 17:45:23 UTC
No time for it, alas.
Comment 8 Jesse Glick 2005-09-07 00:08:03 UTC
Obsolete.