From dev-return-22001-archive-asf-public=cust-asf.ponee.io@netbeans.apache.org Fri Jun 11 13:49:49 2021 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mxout1-he-de.apache.org (mxout1-he-de.apache.org [95.216.194.37]) by mx-eu-01.ponee.io (Postfix) with ESMTPS id 0EC70180654 for ; Fri, 11 Jun 2021 15:49:49 +0200 (CEST) Received: from mail.apache.org (mailroute1-lw-us.apache.org [207.244.88.153]) by mxout1-he-de.apache.org (ASF Mail Server at mxout1-he-de.apache.org) with SMTP id 5C9176286D for ; Fri, 11 Jun 2021 13:49:47 +0000 (UTC) Received: (qmail 41067 invoked by uid 500); 11 Jun 2021 13:49:46 -0000 Mailing-List: contact dev-help@netbeans.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@netbeans.apache.org Delivered-To: mailing list dev@netbeans.apache.org Received: (qmail 41028 invoked by uid 99); 11 Jun 2021 13:49:45 -0000 Received: from spamproc1-he-de.apache.org (HELO spamproc1-he-de.apache.org) (116.203.196.100) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Jun 2021 13:49:45 +0000 Received: from localhost (localhost [127.0.0.1]) by spamproc1-he-de.apache.org (ASF Mail Server at spamproc1-he-de.apache.org) with ESMTP id 457CB1FF496 for ; Fri, 11 Jun 2021 13:49:43 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamproc1-he-de.apache.org X-Spam-Flag: NO X-Spam-Score: -0.001 X-Spam-Level: X-Spam-Status: No, score=-0.001 tagged_above=-999 required=6.31 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.2, SPF_PASS=-0.001] autolearn=disabled Authentication-Results: spamproc1-he-de.apache.org (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com Received: from mx1-he-de.apache.org ([116.203.227.195]) by localhost (spamproc1-he-de.apache.org [116.203.196.100]) (amavisd-new, port 10024) with ESMTP id AfWEAB12bSdO for ; Fri, 11 Jun 2021 13:49:41 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=2607:f8b0:4864:20::e2d; helo=mail-vs1-xe2d.google.com; envelope-from=ebresie@gmail.com; receiver= Received: from mail-vs1-xe2d.google.com (mail-vs1-xe2d.google.com [IPv6:2607:f8b0:4864:20::e2d]) by mx1-he-de.apache.org (ASF Mail Server at mx1-he-de.apache.org) with ESMTPS id CD5017FFBA for ; Fri, 11 Jun 2021 13:49:40 +0000 (UTC) Received: by mail-vs1-xe2d.google.com with SMTP id q2so3795549vsr.1 for ; Fri, 11 Jun 2021 06:49:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=7dhTx1kFXrA7b6VxIBdfnvu/QRSAUdwmdTNGc6S7m0I=; b=EY6EMkYVpQ139LwwpPq4dVkP+ItoKTCKAnaYPbEHVi9OYMAQGJdPwerJJbLhROl2Xf eqnT9ifQqhujwiPcsDrsLsQMLt9URBlPR/TckXaflw3XVtMadw68D2pck9joBsxHrt+i YL4vrNakth/sv1gaoxGT8UKIHKwcEvqBU5XwD4/MLbEMcksGjjU6INb4siFi6qrZJKXK 5EkvhTVLiUHR+q3chx6IzZq2AqqrWHMF5eyg6n65nPtfoOjvn9NXKOl+dT5hvXzctme+ OAhaeLkENiJzPczNhgVgPX/5qnTm4D2HWq5TQRf3CC65CTbDi6XERaf9tbpf+ARQ7jLe t/XA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=7dhTx1kFXrA7b6VxIBdfnvu/QRSAUdwmdTNGc6S7m0I=; b=QjWgK07W9TSVr7UByI+qVvc9CzLQI27l9Mfjk7ZJOPDfBrNgwMU/H1L5wBC18pmJmX 6h+r3HXcKtd9A2Gp5SrDGFqiNUaw3OYsaGr4gAycRHMIp098ETU9KD+MxWJjM63M4+tS 9+QR0PnxqWLJwsUxmpKBiY+61VTTDijtOcg3LPXmIpjzb3x57heNJalsswkrhnJ0nE/w nD1BghOqQhbkhqRapwcElR7kURfb4f8c03Nx/eQGf2yMZ4vd6uXE13iznpNBWxsJpD+t hQpUPNCn0/gWq59F8dpsrhDQ3ULXbDQkU+U/LUPyLCd1Py8VzgclmriWHIQTrRrzNktD jqfg== X-Gm-Message-State: AOAM5307FidzzpUHpvxc77T5AJR5XAvbMDIJrd27SpS2r1qUlr4TZEwL 44ZxuQ/eUNiJi0ICGn02hvzkWTvacH8nm1G461Ffav6Kr/s= X-Google-Smtp-Source: ABdhPJxCqQqhr3sBzcGwAN4LVYlkFxEQn3zQviV6Bnuaa7qKpVOIdjF9RbqzXHfqX9ccn42p0S5GRvEZRL8tJO4obag= X-Received: by 2002:a67:19c2:: with SMTP id 185mr6493960vsz.34.1623419372769; Fri, 11 Jun 2021 06:49:32 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Eric Bresie Date: Fri, 11 Jun 2021 08:49:21 -0500 Message-ID: Subject: Re: Status of JavaHelp To: dev@netbeans.apache.org Content-Type: multipart/alternative; boundary="0000000000000915e405c47dc73c" --0000000000000915e405c47dc73c Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable I=E2=80=99m not aware of any specific plans. Sounds like a few on the thread may have sone interest and some solutions but beyond that I=E2=80=99m not sure anyone has actively been working them = beyond what=E2=80=99s been expressed here. I think at the time I was trying to bring in an old plug-in that made use of it but beyond that I=E2=80=99m not focusing on it at the moment. Others may have more to say on the list. On Thu, Jun 10, 2021 at 8:53 AM Arcturus Bootes wrote: > Hi Eric, > > It's been some time you had a response to the questions you raised here. = I > noticed that with 12.4 the link to help now just opens the online > documentation. > > In terms of outstanding issues > < > https://issues.apache.org/jira/browse/NETBEANS-5225?jql=3Dproject%20%3D%2= 0NETBEANS%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%= 22platform%20-%20Help%20System%22%20ORDER%20BY%20priority%20DESC%2C%20updat= ed%20DESC > > > regarding this topic I didn't see anything specifically mentioning the pl= an > going forward. Do you know if there are any documented plans for the futu= re > of built in help? > > If the answer is that NetBeans is no longer looking to include built-in > help and you have to use the online docs then that's alright; just keen t= o > know where NetBeans stands on the matter. > > Regarding an RPC NetBeans platform application I'm working on (since NB 7 > and now using NB 12.0), I wanted to ideally keep in step with what NetBea= ns > is doing so I wanted to plan a way forward that would be compatible with > what NetBeans does ideally. > > Presently I am still adding the jhall jar and modified > org-netbeans-modules-javahelp.jar back in to retain the built in help > system. However I am now exploring options. > > Thank you. > > > On Mon, 27 Jul 2020 at 01:18, Eric Bresie wrote: > > > Having not drilled down too much yet and thinking from a system > perspective > > (and hope to get this out to the list for others as well)... > > > > Where in the codebase is/would the help functionality be located? And > > where does the help content reside (is there a standardize location) > > > > So assume there are a few parts to the help capabilities: > > (1) Ability to display help materials in a user friendly format > > (2) The help material may be context sensitive help (i.e. when in a giv= en > > context, bring up > > (3) Be compatible with existing local documentation > > (4) Be able to reference to remote documentation (sites) where applicab= le > > (5) Potential usage within the IDE and/or IDE modules > > (6) Potential usage by Netbeans platform applications > > > > What formats are presently supported (I.e. javadoc, html, text, markdow= n, > > etc.)? And does the existing interface allow alternative help formats > like > > this effectively? > > > > So basically swap out the JavaHelp interface with a HelpView/Viewer > > interface of some Type (maybe something like an HTML Viewer) component > here > > in some way? > > > > Eric > > > > On Sun, Jul 26, 2020 at 1:29 AM Tim Boudreau > wrote: > > > > > Funny, I was recently adding help to an old NetBeans-based image/vect= or > > > editor I've been toying with updating, and the idea of using Javadoc > > simply > > > made me ill, so I wrote the beginnings of a help system from scratch, > > where > > > help is generated in code annotations in Markdown, which an Antlr > parser > > > and some Swing magic render directly to the screen without ever > > translating > > > to HTML. It's a work in progress, as I have another project I'm tryi= ng > > to > > > wrap up. > > > > > > Many years ago, when Sun open sourced it, I had the joy of converting > the > > > code to Ant and making it open-source-friendly. It was old, > > > long-in-the-tooth and rather vile then - at best, it's an ugly (the > > classic > > > Swing "border buildup" issues) clone of 1990's era Windows Help. It = is > > > long past time for it to die. It's one of those things nobody actual= ly > > > likes, but nobody actually wants to write a replacement for either. > > > > > > I imagine it wouldn't be that hard to write something that can consum= e > > the > > > existing input files, but something simple, modern and that either us= es > > the > > > user's web browser, or at any rate doesn't demand in-application HTML > > > rendering, and doesn't require HTML as its markup, would be a good > idea. > > > > > > -Tim > > > > > -- > > Eric Bresie > > ebresie@gmail.com > > > --=20 Eric Bresie ebresie@gmail.com --0000000000000915e405c47dc73c--