springframework-rcp-dev

[Springframework-rcp-dev] Advice on JavaHelp

[Benoit X. <bx...@ob...>]

Hi *,

=20

I=92d like to benefit from our experience here. Have you developed some
JavaHelp?

If so, which tool did you find easiest to keep a =93manual=94 as well as =
a
javahelp export?

=20

How did you integrate it in a SpringRC application? I have used the
HelpContentCommand:

org.springframework.richclient.command.support.HelpContentsCommand

=20

This is useful, however, has anyone done some Context-sensitive help? Is
there any support in Spring RC for it? An =93F1=94 key?

Like the ability to specify a help path for a view or a field?  We have =
the
.label, .caption, .icon, .image fields etc  it would be great to add a
.helpPath or something similar with an overlay=85

=20

Any suggestion, comment, experience, code would be welcomed!

=20

Many thanks, as usual,

=20

Benoit.

=20

-------------------------------

IMPORTANT NOTICE This communication contains information that is =
considered
confidential and may also be privileged . It is for the exclusive use of =
the
intended recipient(s). If you are not the intended recipient(s) please =
note
that any form of distribution, copying or use of this communication or =
the
information in it is strictly prohibited and may be unlawful. If you =
have
received this communication in error please return it to the sender and
delete the original.

=20


No virus found in this outgoing message.
Checked by AVG Free Edition.=20
Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date: =
17/09/2007
13:29
=20

Re: [Springframework-rcp-dev] Advice on JavaHelp

[Peter De B. <pet...@gm...>]

Benoit,

some code/pointers to get you started:

Context sensitive help in forms:
- the JavaHelpFormComponentInterceptorFactory has to be defined in your list
of form component interceptors, and the helpSetPath property has to point to
your helpset location.
- make sure your FormModel has an id, otherwise only the property name will
be used
- create entries in your <xxxxxx>.jhm files (one for each form property):
                  <mapID target="<formModelId>.<property>" url="path to html
help file"/> <!-- path to html file can contain named anchor, so you can
bundle all information about one form in one html file, divided in sections
using named anchors-->
- when you open your form, press F1 when in a form component, the help wil
open and jump to the correct html file
- JavaHelpFormComponentInterceptorFactory will be committed to svn, when I
have time ;-), but still needs some cleanup (error handling, ...)

The method above uses <formModelId>.<property> as helpkey. A future version
could first check for a helpKey entry in a properties file, and fall back to
the <formModelId>.<property> behaviour.

Hope this helps,

Peter


On 9/18/07, Benoit Xhenseval <bx...@ob...> wrote:
>
>  Hi *,
>
>
>
> I'd like to benefit from our experience here. Have you developed some
> JavaHelp?
>
> If so, which tool did you find easiest to keep a "manual" as well as a
> javahelp export?
>
>
>
> How did you integrate it in a SpringRC application? I have used the
> HelpContentCommand:
>
> org.springframework.richclient.command.support.HelpContentsCommand
>
>
>
> This is useful, however, has anyone done some Context-sensitive help? Is
> there any support in Spring RC for it? An "F1" key?
>
> Like the ability to specify a help path for a view or a field?  We have
> the .label, .caption, .icon, .image fields etc  it would be great to add a
> .helpPath or something similar with an overlay…
>
>
>
> Any suggestion, comment, experience, code would be welcomed!
>
>
>
> Many thanks, as usual,
>
>
>
> Benoit.
>
>
>
> -------------------------------
>
> IMPORTANT NOTICE This communication contains information that is
> considered confidential and may also be privileged . It is for the exclusive
> use of the intended recipient(s). If you are not the intended recipient(s)
> please note that any form of distribution, copying or use of this
> communication or the information in it is strictly prohibited and may be
> unlawful. If you have received this communication in error please return it
> to the sender and delete the original.
>
>
>
> No virus found in this outgoing message.
> Checked by AVG Free Edition.
> Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> 17/09/2007 13:29
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Springframework-rcp-dev mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
>
>

Re: [Springframework-rcp-dev] Advice on JavaHelp

[Peter De B. <pet...@gm...>]

Benoit,

to have context sensitive help in a view you can follow this method:

1. create your help html files
2. create entries in your <xxxxxx>.jhm file
3. in your view.createControl() method: get a reference to your helpset,
create a helpbroker, and enable help on individual components in your view.
4. to have a help button in your view: create a button with a help icon,
then call HelpBroker.enableHelpOnButton()


Some spring-rich specific class wrapping HelpBroker should still be created=
,
so the helpset and broker can be reused by the views and the
JavaHelpFormComponentInterceptorFactory.
If you'd like to, you can create this class, and contribute it to the
project ;-)


hope this helps,

Peter

On 9/18/07, Benoit Xhenseval <bx...@ob...> wrote:
>
>  Hi *,
>
>
>
> I'd like to benefit from our experience here. Have you developed some
> JavaHelp?
>
> If so, which tool did you find easiest to keep a "manual" as well as a
> javahelp export?
>
>
>
> How did you integrate it in a SpringRC application? I have used the
> HelpContentCommand:
>
> org.springframework.richclient.command.support.HelpContentsCommand
>
>
>
> This is useful, however, has anyone done some Context-sensitive help? Is
> there any support in Spring RC for it? An "F1" key?
>
> Like the ability to specify a help path for a view or a field?  We have
> the .label, .caption, .icon, .image fields etc  it would be great to add =
a
> .helpPath or something similar with an overlay=85
>
>
>
> Any suggestion, comment, experience, code would be welcomed!
>
>
>
> Many thanks, as usual,
>
>
>
> Benoit.
>
>
>
> -------------------------------
>
> IMPORTANT NOTICE This communication contains information that is
> considered confidential and may also be privileged . It is for the exclus=
ive
> use of the intended recipient(s). If you are not the intended recipient(s=
)
> please note that any form of distribution, copying or use of this
> communication or the information in it is strictly prohibited and may be
> unlawful. If you have received this communication in error please return =
it
> to the sender and delete the original.
>
>
>
> No virus found in this outgoing message.
> Checked by AVG Free Edition.
> Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> 17/09/2007 13:29
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Springframework-rcp-dev mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
>
>

Re: [Springframework-rcp-dev] Advice on JavaHelp

[Benoit X. <bx...@ob...>]

Peter,

=20

This works beautifully, many thanks for providing the code and =
guidelines
for a view.

=20

As for feedback, it seems that an exception will be raised every time a
formId.propertyName is not found in the HelpSet. This is a bit brutal,
unfortunately I have not found a way to actually check whether an entry
exists or not and disable the F1 accordingly. It would be a most useful
thing to be able to do.

=20

Finally, could any of you share your experience with a decent authoring
tool? Which one do you use? (we would like to be able to produce a
PDF/manual as well as the HelpSet from the same source).

=20

We=92ve found 3 main candidates:

-          Adobe RobotHelp (expensive, $999) HYPERLINK
"http://www.adobe.com/products/robohelp/"http://www.adobe.com/products/ro=
boh
elp/

-          HelpBreeze $249, HYPERLINK
"http://www.solutionsoft.com/javahelp.htm"http://www.solutionsoft.com/jav=
ahe
lp.htm=20

-          Helen 2 $169, HYPERLINK
"http://www.software7.biz/"http://www.software7.biz/=20

=20

Anyone used these?

Is there another one that could handle both documents and JavaHelp =
creation?

=20

Many thanks!

Kind regards from London,

=20

Benoit

=20

-------------------------------

IMPORTANT NOTICE This communication contains information that is =
considered
confidential and may also be privileged . It is for the exclusive use of =
the
intended recipient(s). If you are not the intended recipient(s) please =
note
that any form of distribution, copying or use of this communication or =
the
information in it is strictly prohibited and may be unlawful. If you =
have
received this communication in error please return it to the sender and
delete the original.

=20

From: spr...@li...
[mailto:spr...@li...] On Behalf =
Of
Peter De Bruycker
Sent: 18 September 2007 14:30
To: spr...@li...
Subject: Re: [Springframework-rcp-dev] Advice on JavaHelp

=20

Benoit,

to have context sensitive help in a view you can follow this method:

1. create your help html files
2. create entries in your <xxxxxx>.jhm file
3. in your view.createControl() method: get a reference to your helpset,
create a helpbroker, and enable help on individual components in your =
view.=20
4. to have a help button in your view: create a button with a help icon,
then call HelpBroker.enableHelpOnButton()


Some spring-rich specific class wrapping HelpBroker should still be =
created,
so the helpset and broker can be reused by the views and the
JavaHelpFormComponentInterceptorFactory.=20
If you'd like to, you can create this class, and contribute it to the
project ;-)


hope this helps,

Peter

On 9/18/07, Benoit Xhenseval <HYPERLINK
"mailto:bx...@ob..."bx...@ob...> wrote:

Hi *,

=20

I'd like to benefit from our experience here. Have you developed some
JavaHelp?

If so, which tool did you find easiest to keep a "manual" as well as a
javahelp export?

=20

How did you integrate it in a SpringRC application? I have used the
HelpContentCommand:

org.springframework.richclient.command.support.HelpContentsCommand

=20

This is useful, however, has anyone done some Context-sensitive help? Is
there any support in Spring RC for it? An "F1" key?

Like the ability to specify a help path for a view or a field?  We have =
the
.label, .caption, .icon, .image fields etc  it would be great to add a
.helpPath or something similar with an overlay=85

=20

Any suggestion, comment, experience, code would be welcomed!

=20

Many thanks, as usual,

=20

Benoit.

=20

-------------------------------

IMPORTANT NOTICE This communication contains information that is =
considered
confidential and may also be privileged . It is for the exclusive use of =
the
intended recipient(s). If you are not the intended recipient(s) please =
note
that any form of distribution, copying or use of this communication or =
the
information in it is strictly prohibited and may be unlawful. If you =
have
received this communication in error please return it to the sender and
delete the original.

=20

=20

No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date: =
17/09/2007
13:29


-------------------------------------------------------------------------=

This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
HYPERLINK "http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/"
\nhttp://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Springframework-rcp-dev mailing list
HYPERLINK
"mailto:Spr...@li..."Springframework-rcp=
-de
v...@li...
HYPERLINK
"https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev"
\nhttps://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev=20

=20

No virus found in this incoming message.
Checked by AVG Free Edition.
Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date: =
17/09/2007
13:29


No virus found in this outgoing message.
Checked by AVG Free Edition.=20
Version: 7.5.487 / Virus Database: 269.13.22/1015 - Release Date: =
18/09/2007
11:53
=20

Re: [Springframework-rcp-dev] Advice on JavaHelp

[Peter De B. <pet...@gm...>]

Benoit,

I haven't used any of the tools. I would opt for authoring the help in
docbook, and then transforming it with an ant build script to pdf and
javahelp.

regards,

Peter
<http://jhelpdev.sourceforge.net/>


On 9/20/07, Benoit Xhenseval < bx...@ob...> wrote:
>
>  Peter,
>
>
>
> This works beautifully, many thanks for providing the code and guidelines
> for a view.
>
>
>
> As for feedback, it seems that an exception will be raised every time a
> formId.propertyName is not found in the HelpSet. This is a bit brutal,
> unfortunately I have not found a way to actually check whether an entry
> exists or not and disable the F1 accordingly. It would be a most useful
> thing to be able to do.
>
>
>
> Finally, could any of you share your experience with a decent authoring
> tool? Which one do you use? (we would like to be able to produce a
> PDF/manual as well as the HelpSet from the same source).
>
>
>
> We've found 3 main candidates:
>
> -          Adobe RobotHelp (expensive, $999)
> http://www.adobe.com/products/robohelp/
>
> -          HelpBreeze $249, http://www.solutionsoft.com/javahelp.htm
>
> -          Helen 2 $169, http://www.software7.biz/
>
>
>
> Anyone used these?
>
> Is there another one that could handle both documents and JavaHelp
> creation?
>
>
>
> Many thanks!
>
> Kind regards from London,
>
>
>
> Benoit
>
>
>
> -------------------------------
>
> IMPORTANT NOTICE This communication contains information that is
> considered confidential and may also be privileged . It is for the exclus=
ive
> use of the intended recipient(s). If you are not the intended recipient(s=
)
> please note that any form of distribution, copying or use of this
> communication or the information in it is strictly prohibited and may be
> unlawful. If you have received this communication in error please return =
it
> to the sender and delete the original.
>
>
>
> *From:* spr...@li... [mailto:
> spr...@li...] *On Behalf Of *Pet=
er
> De Bruycker
> *Sent:* 18 September 2007 14:30
> *To:* spr...@li...
> *Subject:* Re: [Springframework-rcp-dev] Advice on JavaHelp
>
>
>
> Benoit,
>
> to have context sensitive help in a view you can follow this method:
>
> 1. create your help html files
> 2. create entries in your <xxxxxx>.jhm file
> 3. in your view.createControl() method: get a reference to your helpset,
> create a helpbroker, and enable help on individual components in your vie=
w.
> 4. to have a help button in your view: create a button with a help icon,
> then call HelpBroker.enableHelpOnButton()
>
>
> Some spring-rich specific class wrapping HelpBroker should still be
> created, so the helpset and broker can be reused by the views and the
> JavaHelpFormComponentInterceptorFactory.
> If you'd like to, you can create this class, and contribute it to the
> project ;-)
>
>
> hope this helps,
>
> Peter
>
> On 9/18/07, *Benoit Xhenseval *<bx...@ob...> wrote:
>
> Hi *,
>
>
>
> I'd like to benefit from our experience here. Have you developed some
> JavaHelp?
>
> If so, which tool did you find easiest to keep a "manual" as well as a
> javahelp export?
>
>
>
> How did you integrate it in a SpringRC application? I have used the
> HelpContentCommand:
>
> org.springframework.richclient.command.support.HelpContentsCommand
>
>
>
> This is useful, however, has anyone done some Context-sensitive help? Is
> there any support in Spring RC for it? An "F1" key?
>
> Like the ability to specify a help path for a view or a field?  We have
> the .label, .caption, .icon, .image fields etc  it would be great to add =
a
> .helpPath or something similar with an overlay=85
>
>
>
> Any suggestion, comment, experience, code would be welcomed!
>
>
>
> Many thanks, as usual,
>
>
>
> Benoit.
>
>
>
> -------------------------------
>
> IMPORTANT NOTICE This communication contains information that is
> considered confidential and may also be privileged . It is for the exclus=
ive
> use of the intended recipient(s). If you are not the intended recipient(s=
)
> please note that any form of distribution, copying or use of this
> communication or the information in it is strictly prohibited and may be
> unlawful. If you have received this communication in error please return =
it
> to the sender and delete the original.
>
>
>
>
>
> No virus found in this outgoing message.
> Checked by AVG Free Edition.
> Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> 17/09/2007 13:29
>
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Springframework-rcp-dev mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
>
>
>
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> 17/09/2007 13:29
>
> No virus found in this outgoing message.
> Checked by AVG Free Edition.
> Version: 7.5.487 / Virus Database: 269.13.22/1015 - Release Date:
> 18/09/2007 11:53
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2005.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Springframework-rcp-dev mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
>
>

Re: [Springframework-rcp-dev] Advice on JavaHelp

[Peter De B. <pet...@gm...>]

replace the processComponent in the interceptor to this:

[snip]
        public void processComponent(String propertyName, JComponent
component) {
            String key =3D getHelpKey(propertyName);

            if(broker.getHelpSet().getCombinedMap().isValidID(key,
broker.getHelpSet())) {
                broker.enableHelpKey(component, getHelpKey(propertyName),
broker.getHelpSet());
            }
        }
[/snip]

Peter


On 9/20/07, Peter De Bruycker <pet...@gm...> wrote:
>
>
> Benoit,
>
> I haven't used any of the tools. I would opt for authoring the help in
> docbook, and then transforming it with an ant build script to pdf and
> javahelp.
>
> regards,
>
> Peter
>  <http://jhelpdev.sourceforge.net/>
>
>
> On 9/20/07, Benoit Xhenseval < bx...@ob...> wrote:
> >
> >  Peter,
> >
> >
> >
> > This works beautifully, many thanks for providing the code and
> > guidelines for a view.
> >
> >
> >
> > As for feedback, it seems that an exception will be raised every time a
> > formId.propertyName is not found in the HelpSet. This is a bit brutal,
> > unfortunately I have not found a way to actually check whether an entry
> > exists or not and disable the F1 accordingly. It would be a most useful
> > thing to be able to do.
> >
> >
> >
> > Finally, could any of you share your experience with a decent authoring
> > tool? Which one do you use? (we would like to be able to produce a
> > PDF/manual as well as the HelpSet from the same source).
> >
> >
> >
> > We've found 3 main candidates:
> >
> > -          Adobe RobotHelp (expensive, $999)
> > http://www.adobe.com/products/robohelp/
> >
> > -          HelpBreeze $249, http://www.solutionsoft.com/javahelp.htm
> >
> > -          Helen 2 $169, http://www.software7.biz/
> >
> >
> >
> > Anyone used these?
> >
> > Is there another one that could handle both documents and JavaHelp
> > creation?
> >
> >
> >
> > Many thanks!
> >
> > Kind regards from London,
> >
> >
> >
> > Benoit
> >
> >
> >
> > -------------------------------
> >
> > IMPORTANT NOTICE This communication contains information that is
> > considered confidential and may also be privileged . It is for the excl=
usive
> > use of the intended recipient(s). If you are not the intended recipient=
(s)
> > please note that any form of distribution, copying or use of this
> > communication or the information in it is strictly prohibited and may b=
e
> > unlawful. If you have received this communication in error please retur=
n it
> > to the sender and delete the original.
> >
> >
> >
> > *From:* spr...@li... [mailto:
> > spr...@li...] *On Behalf Of *P=
eter
> > De Bruycker
> > *Sent:* 18 September 2007 14:30
> > *To:* spr...@li...
> > *Subject:* Re: [Springframework-rcp-dev] Advice on JavaHelp
> >
> >
> >
> > Benoit,
> >
> > to have context sensitive help in a view you can follow this method:
> >
> > 1. create your help html files
> > 2. create entries in your <xxxxxx>.jhm file
> > 3. in your view.createControl() method: get a reference to your helpset=
,
> > create a helpbroker, and enable help on individual components in your v=
iew.
> > 4. to have a help button in your view: create a button with a help icon=
,
> > then call HelpBroker.enableHelpOnButton()
> >
> >
> > Some spring-rich specific class wrapping HelpBroker should still be
> > created, so the helpset and broker can be reused by the views and the
> > JavaHelpFormComponentInterceptorFactory.
> > If you'd like to, you can create this class, and contribute it to the
> > project ;-)
> >
> >
> > hope this helps,
> >
> > Peter
> >
> > On 9/18/07, *Benoit Xhenseval *<bx...@ob...> wrote:
> >
> > Hi *,
> >
> >
> >
> > I'd like to benefit from our experience here. Have you developed some
> > JavaHelp?
> >
> > If so, which tool did you find easiest to keep a "manual" as well as a
> > javahelp export?
> >
> >
> >
> > How did you integrate it in a SpringRC application? I have used the
> > HelpContentCommand:
> >
> > org.springframework.richclient.command.support.HelpContentsCommand
> >
> >
> >
> > This is useful, however, has anyone done some Context-sensitive help? I=
s
> > there any support in Spring RC for it? An "F1" key?
> >
> > Like the ability to specify a help path for a view or a field?  We have
> > the .label, .caption, .icon, .image fields etc  it would be great to ad=
d a
> > .helpPath or something similar with an overlay=85
> >
> >
> >
> > Any suggestion, comment, experience, code would be welcomed!
> >
> >
> >
> > Many thanks, as usual,
> >
> >
> >
> > Benoit.
> >
> >
> >
> > -------------------------------
> >
> > IMPORTANT NOTICE This communication contains information that is
> > considered confidential and may also be privileged . It is for the excl=
usive
> > use of the intended recipient(s). If you are not the intended recipient=
(s)
> > please note that any form of distribution, copying or use of this
> > communication or the information in it is strictly prohibited and may b=
e
> > unlawful. If you have received this communication in error please retur=
n it
> > to the sender and delete the original.
> >
> >
> >
> >
> >
> > No virus found in this outgoing message.
> > Checked by AVG Free Edition.
> > Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> > 17/09/2007 13:29
> >
> >
> >
> > -----------------------------------------------------------------------=
--
> > This SF.net email is sponsored by: Microsoft
> > Defy all challenges. Microsoft(R) Visual Studio 2005.
> > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> > _______________________________________________
> > Springframework-rcp-dev mailing list
> > Spr...@li...
> > https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
> >
> >
> >
> > No virus found in this incoming message.
> > Checked by AVG Free Edition.
> > Version: 7.5.487 / Virus Database: 269.13.22/1013 - Release Date:
> > 17/09/2007 13:29
> >
> > No virus found in this outgoing message.
> > Checked by AVG Free Edition.
> > Version: 7.5.487 / Virus Database: 269.13.22/1015 - Release Date:
> > 18/09/2007 11:53
> >
> >
> > -----------------------------------------------------------------------=
--
> > This SF.net email is sponsored by: Microsoft
> > Defy all challenges. Microsoft(R) Visual Studio 2005.
> > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> > _______________________________________________
> > Springframework-rcp-dev mailing list
> > Spr...@li...
> > https://lists.sourceforge.net/lists/listinfo/springframework-rcp-dev
> >
> >
>