Bug 633 - [Chameleon - HelpWidget] Rename widget to EmbeddedHelp
: [Chameleon - HelpWidget] Rename widget to EmbeddedHelp
Status: VERIFIED FIXED
: Chameleon
Widget
: 1.99
: PC Windows 2000
: P3 trivial
: 2.0 RC 1
Assigned To:
:
:
:
:
: 584
  Show dependency treegraph
 
Reported: 2004-08-25 18:27 by
Modified: 2004-10-18 14:33 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2004-08-25 18:27:19
[Chameleon - HelpWidget] Rename widget to OnLineHelp 

Please rename HelpWidget to OnLineHelp. There is no need to have the word widget
in the name.
------- Comment #1 From 2004-09-03 13:23:52 -------
If this is to be changed, the name should be "OnlineHelp", not "OnLineHelp". 
------- Comment #2 From 2004-10-12 22:25:59 -------
I'm not sure I agree with OnlineHelp as the new name for this widget.  Any
comments on a new name?  Unfortunately we cannot use Help since it seems to
conflict with an internal name in PHP.
------- Comment #3 From 2004-10-12 22:39:30 -------
If this widget is a generalized Help widget then how about HelpCenter, Support
or SupportCenter?
------- Comment #4 From 2004-10-13 06:37:06 -------
My vote is for HelpCenter.
------- Comment #5 From 2004-10-13 07:41:05 -------
if the point of the help widget is to display the information from
<cham:onlinehelp><cham:onlinehelp> element from widget docs in a popup than the
widget could be called Onlinehelp (which you have rejected) or HelpPopup.

The help popup could as have some template configuration attribute request. I
think this needs to be figured out. It is not totally clear to me. 

This <cham:onlinehelp> element information could be extracted using an xslt
which could be a configurable option for the widget. or maybe not. :)
------- Comment #6 From 2004-10-13 07:48:57 -------
the purpose of the widget is to display the contents of the widget
documentation, specifically the onlinehelp tag, in a template.  The content of
this tag is documentation oriented at an end user of an application, so it
explains how to use a particular widget.  The intention is that an application
designer can create a help page as a chameleon template and embed the help text
for various widgets in the template, giving control to the designer over the
design, layout and other text in the help page.

I don't think HelpCenter captures the idea that this is help on just one widget.
------- Comment #7 From 2004-10-13 07:55:36 -------
I don't think the help widget should be called "HelpCenter" Because of the new
Help Viewer that Bill put together for the widget docs. The help viewer is more
the center point of all documentation and help. Also the help viewer is not even
a widget, but rather part of the chameleon itself. Which makes it more centeric
to chameleon.

The help widget should be used to bring help to chameleon applications. to bring
help to the user. so until we figure out what the help widget is realy for,
maybe the name can wait.

ha, I just read pauls reply. I agree with paul
------- Comment #8 From 2004-10-13 08:54:28 -------
Doesn't the "HelpViewer" eliminate the need for any help widget?  Or does this
widget do more than simply display text?

If I understand Paul correctly then perhaps this widget is actually a
"HelpContent" or "HelpDescriptor" widget...

------- Comment #9 From 2004-10-14 12:46:41 -------
The new name for the HelpWidget will be EmbeddedHelp. :) please update widget.
------- Comment #10 From 2004-10-18 13:53:37 -------
Classes have been renamed along with associatedd language file.  Assiging to
Paul to move files in CVS.
------- Comment #11 From 2004-10-18 14:33:05 -------
Paul has fixed this.
------- Comment #12 From 2004-10-18 14:33:28 -------
Verified.