You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@netbeans.apache.org by Eric Bresie <eb...@gmail.com> on 2021/03/07 17:49:45 UTC
UML, Donations, and JavaHelp Oh-My
While attempting to understand the Netbeans IDE/Platform architecture, I
thought the community-UML contrib would help but recall recent attempts
involved awaiting on donation 6 and addressing dependencies on JavaHelp
which seems to be deprecated and/or no longer in widespread use in Netbeans.
Looking through some old threads (1) and JIRA tickets, I’ve found the
general consensus seems to be JavaHelp is basically deprecated and/or no
longer activity being utilized.
I’ve seen a few threads which seems to indicate the way forward is to have
the help materials to be translated into some common format (i.e. either
html, asciidoc, docwiki) and then render either in a internal/external web
view or have some new component to render the context as applicable. To
minimize the work on updating help, I believe the hope was these would be
basically backwards compatible to reduce the need for too much translation.
So all that said, is anyone actively developing an Alternative Help?
Or is the way forward to create help in some specific non-JavaHelp way and
any dependencies on Java-Help replace by something else?
——
Reference:
(1) Status of JavaHelp
https://lists.apache.org/thread.html/rd6f2c0d5090e9628a9ca9ee7af6febb8ac94ed034455ebfd02a44a92%40%3Cdev.netbeans.apache.org%3E
(2) Donation 6 Status
https://lists.apache.org/thread.html/rf849eb22e67b1b53830693703b63f88c4d1203c101e7c8edd32c3b89%40%3Cdev.netbeans.apache.org%3E
Eric
--
Eric Bresie
ebresie@gmail.com
Re: JavaHelp in browser (was: UML, Donations, and JavaHelp Oh-My)
Posted by Aleksandra Misic <al...@gmail.com>.
Hello,
I just wanted to say I was very interested in contributing to this project
and would like to echo my professors questions on what could be done
further.
Best regards,
Aleksandra Mišić
On Thu, 8 Apr 2021 at 20:45, Zoran Sevarac <se...@gmail.com> wrote:
> Hi Jens and thanks for the great work.
> I have a student at University of Belgrade, Aleksandra Misic
> aleksandra.1misic@gmail.com, who is doing an open source project and is
> interested to contribute to this project.
> I will also help her.
> So what what would be the best way to contribute and push development of
> this hel plugin?
> I think that it would be very useful for many NetBeans Platform based
> applications.
>
> Best regards
> Zoran
>
>
> On Thu, Mar 18, 2021 at 12:33 PM Jens Hofschröer <ap...@nigjo.de> wrote:
>
> > Am 08.03.2021 um 11:33 schrieb Jens Hofschröer:
> > > Hi
> > >
> > > Am 07.03.2021 um 18:49 schrieb Eric Bresie:
> > >> I’ve seen a few threads which seems to indicate the way forward is to
> > >> have
> > >> the help materials to be translated into some common format (i.e.
> either
> > >> html, asciidoc, docwiki) and then render either in a internal/external
> > >> web
> > >> view or have some new component to render the context as applicable.
> To
> > >> minimize the work on updating help, I believe the hope was these would
> > be
> > >> basically backwards compatible to reduce the need for too much
> > >> translation.
> > >>
> > >> So all that said, is anyone actively developing an Alternative Help?
> > > >> Or is the way forward to create help in some specific non-JavaHelp
> > > way and
> > > > any dependencies on Java-Help replace by something else?
> > > >
> > >
> > > May be I can extract the more generic part an open source it, but I can
> > > not say in which time frame due to my daily work.
> >
> > Here is an eary version: https://github.com/nigjo/nb-help
> >
> > The default implementation just sends the JavaHelp page to the local
> > Browser. No navigation like in JavaHelp itself. It is possible to reuse
> > this in an RCP and the implementations can be replaced by own
> > "renderers". I updated our own help system to use this module, so this
> > might be updated in the future.
> >
> > There are currently not that many JavaDocs, but most is done via
> > services. Also there are no security checks for the output, so be aware
> > and use it only in an trusted environment.
> >
> > Jens
> >
> > --
> > http://blog.nigjo.de/netbeans/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
> > For additional commands, e-mail: dev-help@netbeans.apache.org
> >
> > For further information about the NetBeans mailing lists, visit:
> > https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
> >
> >
> >
> >
>
> --
> Zoran Sevarac, PhD, Associate Professor
> University of Belgrade, Faculty of Organisational Sciences, Department for
> Software Engineering
> Java Champion <https://community.oracle.com/community/java/java-champions>
> | Oracle Groundbreaker Ambassador | Deep Netts <http://www.deepnetts.com>
> Co-founder & CEO
>
Re: JavaHelp in browser (was: UML, Donations, and JavaHelp Oh-My)
Posted by Zoran Sevarac <se...@gmail.com>.
Hi Jens and thanks for the great work.
I have a student at University of Belgrade, Aleksandra Misic
aleksandra.1misic@gmail.com, who is doing an open source project and is
interested to contribute to this project.
I will also help her.
So what what would be the best way to contribute and push development of
this hel plugin?
I think that it would be very useful for many NetBeans Platform based
applications.
Best regards
Zoran
On Thu, Mar 18, 2021 at 12:33 PM Jens Hofschröer <ap...@nigjo.de> wrote:
> Am 08.03.2021 um 11:33 schrieb Jens Hofschröer:
> > Hi
> >
> > Am 07.03.2021 um 18:49 schrieb Eric Bresie:
> >> I’ve seen a few threads which seems to indicate the way forward is to
> >> have
> >> the help materials to be translated into some common format (i.e. either
> >> html, asciidoc, docwiki) and then render either in a internal/external
> >> web
> >> view or have some new component to render the context as applicable. To
> >> minimize the work on updating help, I believe the hope was these would
> be
> >> basically backwards compatible to reduce the need for too much
> >> translation.
> >>
> >> So all that said, is anyone actively developing an Alternative Help?
> > >> Or is the way forward to create help in some specific non-JavaHelp
> > way and
> > > any dependencies on Java-Help replace by something else?
> > >
> >
> > May be I can extract the more generic part an open source it, but I can
> > not say in which time frame due to my daily work.
>
> Here is an eary version: https://github.com/nigjo/nb-help
>
> The default implementation just sends the JavaHelp page to the local
> Browser. No navigation like in JavaHelp itself. It is possible to reuse
> this in an RCP and the implementations can be replaced by own
> "renderers". I updated our own help system to use this module, so this
> might be updated in the future.
>
> There are currently not that many JavaDocs, but most is done via
> services. Also there are no security checks for the output, so be aware
> and use it only in an trusted environment.
>
> Jens
>
> --
> http://blog.nigjo.de/netbeans/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
> For additional commands, e-mail: dev-help@netbeans.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
>
--
Zoran Sevarac, PhD, Associate Professor
University of Belgrade, Faculty of Organisational Sciences, Department for
Software Engineering
Java Champion <https://community.oracle.com/community/java/java-champions>
| Oracle Groundbreaker Ambassador | Deep Netts <http://www.deepnetts.com>
Co-founder & CEO
Re: JavaHelp in browser (was: UML, Donations, and JavaHelp Oh-My)
Posted by Jaroslav Tulach <ja...@gmail.com>.
Yes, this looks quite nice.
I have to admit I don't miss the integrated JavaHelp functionality. It is
21st century and people google for problems - (especially) developers don't
need integrated help anymore, imho. Should, however, the NetBeans project
want to get JavaHelp-like behavior back, then I think Jen's project would
be a very good base. Nothing has to be changed in the NetBeans modules, we
have the documentation. The registrations in
https://github.com/nigjo/nb-help/blob/main/src/main/java/de/rwthaachen/wzl/gt/nbm/nbhelp/HelpDisplayer.java
would just take care of rendering the existing help pages in the browser.
Great work! Thank you, Jens.
-jt
čt 18. 3. 2021 v 12:48 odesílatel Geertjan Wielenga
<ge...@googlemail.com.invalid> napsal:
>
> Great progress, thank you for taking this on.
>
> Gj
>
> On Thu, Mar 18, 2021 at 12:33 PM Jens Hofschröer <ap...@nigjo.de> wrote:
>
> > Am 08.03.2021 um 11:33 schrieb Jens Hofschröer:
> > > Hi
> > >
> > > Am 07.03.2021 um 18:49 schrieb Eric Bresie:
> > >> I’ve seen a few threads which seems to indicate the way forward is to
> > >> have
> > >> the help materials to be translated into some common format (i.e.
either
> > >> html, asciidoc, docwiki) and then render either in a
internal/external
> > >> web
> > >> view or have some new component to render the context as
applicable. To
> > >> minimize the work on updating help, I believe the hope was these
would
> > be
> > >> basically backwards compatible to reduce the need for too much
> > >> translation.
> > >>
> > >> So all that said, is anyone actively developing an Alternative Help?
> > > >> Or is the way forward to create help in some specific non-JavaHelp
> > > way and
> > > > any dependencies on Java-Help replace by something else?
> > > >
> > >
> > > May be I can extract the more generic part an open source it, but I
can
> > > not say in which time frame due to my daily work.
> >
> > Here is an eary version: https://github.com/nigjo/nb-help
> >
> > The default implementation just sends the JavaHelp page to the local
> > Browser. No navigation like in JavaHelp itself. It is possible to reuse
> > this in an RCP and the implementations can be replaced by own
> > "renderers". I updated our own help system to use this module, so this
> > might be updated in the future.
> >
> > There are currently not that many JavaDocs, but most is done via
> > services. Also there are no security checks for the output, so be aware
> > and use it only in an trusted environment.
> >
> > Jens
> >
> > --
> > http://blog.nigjo.de/netbeans/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
> > For additional commands, e-mail: dev-help@netbeans.apache.org
> >
> > For further information about the NetBeans mailing lists, visit:
> > https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
> >
> >
> >
> >
Re: JavaHelp in browser (was: UML, Donations, and JavaHelp Oh-My)
Posted by Geertjan Wielenga <ge...@googlemail.com.INVALID>.
Great progress, thank you for taking this on.
Gj
On Thu, Mar 18, 2021 at 12:33 PM Jens Hofschröer <ap...@nigjo.de> wrote:
> Am 08.03.2021 um 11:33 schrieb Jens Hofschröer:
> > Hi
> >
> > Am 07.03.2021 um 18:49 schrieb Eric Bresie:
> >> I’ve seen a few threads which seems to indicate the way forward is to
> >> have
> >> the help materials to be translated into some common format (i.e. either
> >> html, asciidoc, docwiki) and then render either in a internal/external
> >> web
> >> view or have some new component to render the context as applicable. To
> >> minimize the work on updating help, I believe the hope was these would
> be
> >> basically backwards compatible to reduce the need for too much
> >> translation.
> >>
> >> So all that said, is anyone actively developing an Alternative Help?
> > >> Or is the way forward to create help in some specific non-JavaHelp
> > way and
> > > any dependencies on Java-Help replace by something else?
> > >
> >
> > May be I can extract the more generic part an open source it, but I can
> > not say in which time frame due to my daily work.
>
> Here is an eary version: https://github.com/nigjo/nb-help
>
> The default implementation just sends the JavaHelp page to the local
> Browser. No navigation like in JavaHelp itself. It is possible to reuse
> this in an RCP and the implementations can be replaced by own
> "renderers". I updated our own help system to use this module, so this
> might be updated in the future.
>
> There are currently not that many JavaDocs, but most is done via
> services. Also there are no security checks for the output, so be aware
> and use it only in an trusted environment.
>
> Jens
>
> --
> http://blog.nigjo.de/netbeans/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
> For additional commands, e-mail: dev-help@netbeans.apache.org
>
> For further information about the NetBeans mailing lists, visit:
> https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
>
>
>
>
JavaHelp in browser (was: UML, Donations, and JavaHelp Oh-My)
Posted by Jens Hofschröer <ap...@nigjo.de>.
Am 08.03.2021 um 11:33 schrieb Jens Hofschröer:
> Hi
>
> Am 07.03.2021 um 18:49 schrieb Eric Bresie:
>> I’ve seen a few threads which seems to indicate the way forward is to
>> have
>> the help materials to be translated into some common format (i.e. either
>> html, asciidoc, docwiki) and then render either in a internal/external
>> web
>> view or have some new component to render the context as applicable. To
>> minimize the work on updating help, I believe the hope was these would be
>> basically backwards compatible to reduce the need for too much
>> translation.
>>
>> So all that said, is anyone actively developing an Alternative Help?
> >> Or is the way forward to create help in some specific non-JavaHelp
> way and
> > any dependencies on Java-Help replace by something else?
> >
>
> May be I can extract the more generic part an open source it, but I can
> not say in which time frame due to my daily work.
Here is an eary version: https://github.com/nigjo/nb-help
The default implementation just sends the JavaHelp page to the local
Browser. No navigation like in JavaHelp itself. It is possible to reuse
this in an RCP and the implementations can be replaced by own
"renderers". I updated our own help system to use this module, so this
might be updated in the future.
There are currently not that many JavaDocs, but most is done via
services. Also there are no security checks for the output, so be aware
and use it only in an trusted environment.
Jens
--
http://blog.nigjo.de/netbeans/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
For additional commands, e-mail: dev-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: UML, Donations, and JavaHelp Oh-My
Posted by Jens Hofschröer <ap...@nigjo.de>.
Hi
Am 07.03.2021 um 18:49 schrieb Eric Bresie:
> I’ve seen a few threads which seems to indicate the way forward is to have
> the help materials to be translated into some common format (i.e. either
> html, asciidoc, docwiki) and then render either in a internal/external web
> view or have some new component to render the context as applicable. To
> minimize the work on updating help, I believe the hope was these would be
> basically backwards compatible to reduce the need for too much translation.
>
> So all that said, is anyone actively developing an Alternative Help?
>> Or is the way forward to create help in some specific non-JavaHelp
way and
> any dependencies on Java-Help replace by something else?
>
Not actively and not in the public. I have done a netty proxy server
which encapsulates our current Docbook-JavaHelp output in a "nicer"
HTML5 page template and recreates a simple menu for that pages.
That "updated" page is displayed in the systems default browser. I have
managed to capture the current F1 key presses. It is working for us but
there a more things to do (link generic templates and cross help linking)
May be I can extract the more generic part an open source it, but I can
not say in which time frame due to my daily work.
Jens
--
http://blog.nigjo.de/netbeans/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@netbeans.apache.org
For additional commands, e-mail: dev-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists