Re: [platform-ua-dev] Conditional help text in Eclipse 3.2

["Curtis D'Entremont" <curtispd@xxxxxxxxxx>]

Currently all filtering is turned off
in infocenter mode. It would certainly be possible to implement what you
describe below and turn it on, however it should be noted that there would
still be filters that do not make sense in infocenter mode. For example,
the filters that check the existence of a plugin, or whether an activity
is turned on or not, would have no meaning if the user doesn't have eclipse
installed and is just browsing documentation. 

I agree that this scenario is very desirable
and I've opened an enhancement to track this:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=142526

Thanks,
Curt

John Arthorne/Ottawa/IBM@IBMCA
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

18/05/2006 11:33 AM

Please respond to
"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>

To	"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>
cc
Subject	Re: [platform-ua-dev] Conditional help text in Eclipse 3.2

It seems to be a major weakness of this approach if filters cannot be used
to present either/or text.  Are you saying that all filters are ignored
in infocenter mode, or just the os/ws/arch ones?  Would it make sense
to have an "infocenter" filter property so someone can make text
conditionally appear only in infocenter mode?  That would allow a
solution like this: 

<!-- For eclipse.org -->
<span filter="infocenter">
Bring focus to the interface widget in question by clicking on it
or using the Tab key
and then press
F1 (Ctrl+F1 on GTK+ or Help key on Carbon).
</span>

<span filter="!infocenter">
       <!-- For Windows -->
       <span filter="ws=win32">
       Bring focus to the interface widget in question by
clicking on it
       (or using the Tab key)
       and then press F1.
       </span>

       <!-- For Linux GTK -->
       <span filter="ws=gtk">
       Bring focus to the interface widget in question by
clicking on it
       and then press Ctrl+F1.
       </span>

       <!-- For Macs -->
       <span filter="ws=carbon">
       Bring focus to the interface widget in question by
clicking on it
       and then press the Help key.
       </span>
</span>

Curtis D'Entremont/Toronto/IBM@IBMCA
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

18/05/2006 10:28 AM

Please respond to
"Eclipse Platform User Assistance component developers list."

To	"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>
cc	platform-ua-dev@xxxxxxxxxxx, platform-ua-dev-bounces@xxxxxxxxxxx
Subject	Re: [platform-ua-dev] Conditional help text in Eclipse 3.2

Hi Michael, 

You are correct that in 3.2 you can use filtering in your docs to create
conditional sections. However the filters will only take effect when the
help is integrated with the workbench (or standalone mode); filter attributes/elements
are ignored on infocenter mode (i.e. http://help.eclipse.org/help31/index.jsp).
This is because the user may simply be browsing the infocenter to read
more about a particular topic, or trying to debug a problem on a product
that doesn't ship the isv docs, and using, say, a separate laptop to read
the docs online. This may be confusing to the reader.

If you intend to have your docs both integrated with a product and available
on an infocenter, you will need to make sure that the content still makes
sense if all filters are turned off. So the fragment you provided wouldn't
work well in infocenter  (it would repeat itself several times). The
current mechanism isn't really applicable for enumerating different platform
behaviors, especially when the behavior is different on each platform.
It is instead geared more toward exceptions (e.g. Note: On linux, you have
to do X in addition to the steps above). However for future we are open
to expanding the filtering to handle more cases. For the specific instance
you provide I would recommend simply listing it out without filters, i.e.
"To get context help press F1 (Shift-F1 on GTK, Help on Mac)".

I've added some docs on dynamic content, including filtering, in the latest
builds. Have a look at Platform Plug-in Developer Guide -> Programmer's
Guide -> User assistance support -> Dynamic content, and the Filtering
topic under it. This information will be available on help.eclipse.org
once 3.2 has released. The document you were looking at is the original
proposal for the feature. 

Thanks, 
Curtis

Michael Behm <mbehm@xxxxxxxxxx>
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

18/05/2006 08:15 AM

Please respond to
"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>

To	platform-ua-dev@xxxxxxxxxxx
cc
Subject	[platform-ua-dev] Conditional help text in Eclipse 3.2

[Reposted from platform-help-dev@xxxxxxxxxxx]


I understand that in the 3.2 documentation, text can be conditionalized
as described here:
http://www.eclipse.org/eclipse/platform-ua/proposals/xhtml/HelpDynamicContent.html



The valid values are:
For ws: win32 motif gtk photon carbon unknown
For os: win32 linux aix solaris hpux qnx macosx unknown

My question is, what is the markup that allows text to appear on
http://help.eclipse.org/help31/index.jsp pages? I'm assuming that it is
the "unknown" setting, but I would like to have that confirmed.

Example:
========

<h2>Context-sensitive help</h2>

<p>If you are working through a task and encounter part of the interface
that you do not understand, use context-sensitive help.

<!-- For eclipse.org -->
<span filter="os=unknown">
Bring focus to the interface widget in question by clicking on it
or using the Tab key
and then press
F1 (Ctrl+F1 on GTK+ or Help key on Carbon).
</span>

<!-- For Windows -->
<span filter="ws=win32">
Bring focus to the interface widget in question by clicking on it
(or using the Tab key)
and then press F1.
</span>

<!-- For Linux GTK -->
<span filter="ws=gtk">
Bring focus to the interface widget in question by clicking on it
and then press Ctrl+F1.
</span>

<!-- For Macs -->
<span filter="ws=carbon">
Bring focus to the interface widget in question by clicking on it
and then press the Help key.
</span>

</p>


_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev