netbeans icon indicating copy to clipboard operation
netbeans copied to clipboard

XML Editor Extension Module Tutorial erratum

Open brutzman opened this issue 1 year ago • 5 comments

Apache NetBeans version

Apache NetBeans 14

What happened

Problem in HTML, specified choice not available

NetBeans XML Editor Extension Module Tutorial

https://netbeans.apache.org/tutorials/nbm-xmleditor.html

Specifying the Module’s Dependencies You will need to subclass several classes that belong to the NetBeans APIs. Each is declared as a module dependency.

In the Projects window, right-click the Libraries node and choose Add Module Dependency:

Search for each of the following APIs in the Add Module Dependency dialog, select the API, and then click OK to confirm it:

I/O APIs

Two different choices are provided,

  • I/O APIs - Swing
  • I/O API and SPI

The first one worked, I/O APIs - Swing

How to reproduce

Inspect tutorial page, perform steps described there

Did this work correctly in an earlier version?

No / Don't know

Operating System

Windows 10

JDK

OpenJDK 18.0.2

Apache NetBeans packaging

Apache NetBeans binary zip

Anything else

No response

Are you willing to submit a pull request?

No

Code of Conduct

Yes

brutzman avatar Aug 09 '22 23:08 brutzman

Hi @brutzman,

the tutorial page is already marked with "needs review" (although the link to jira is a bit outdated). Filing another issue is redundant. You can simply click "edit on github" and propose an updated version right away if you want to help. Assuming everything worked on NetBeans 14 with the updates you made, we could then also remove all the warning banners on that page.

mbien avatar Aug 10 '22 17:08 mbien

Have the Categories changes over time?

I see: "1. Choose File > New Project (Ctrl+Shift+N). Under Categories, select NetBeans Modules. Under Projects, select Module. Click Next."

For NB 14, should this be something like: "1. Choose File > New Project (Ctrl+Shift+N). Under Categories, select NetBeans Modules. Under Java with Maven Projects, select Module. Click Next."

ebresie avatar Aug 13 '22 13:08 ebresie

Following the "Next" at the end of "2." there is no "Basic Module Configuration panel as mentioned in step 3 which indicates.

"3. In the Basic Module Configuration panel, type org.netbeans.modules.showxmlstructure in Code Name Base. Click Finish."

There does not appear to be a "Basic Module Configuration panel" following step 2 however on the same panel where the Project Name and Location (on step 2), there is a number of items like the "Package" which maybe is what's being asked here. This also provide "artifact id, group ID, version, and package". This may be a side effect of this being a "Java with Maven" project.

Currently the next following step 2 takes the user to a "Module Options" panel which only allows "NetBeansVersion" to be specified. WHen doing "Next"

Should "step 2 and 3 be adjusted with the "package" added to step 2 and a more representative details added for step 3?

ebresie avatar Aug 13 '22 13:08 ebresie

Silly question, if you "edit on github" does this change the files used to eventually generate the "asf-site" branch targeted at the actual website?

ebresie avatar Aug 14 '22 14:08 ebresie

@mbien Is there a "label" for "Website" or "Docs" that can be appended to these types of issue?

ebresie avatar Aug 14 '22 15:08 ebresie