[TYPO3-core] RFC: #6995 Context Senstitive Help text should be displayed faster

[Ernesto Baschny [cron IT]]

Christoph Lindenmueller wrote: on 17.12.2007 18:27:

> This is an SVN patch request.
> 
> Type: New feature
> 
> Bugtracker references:
> http://bugs.typo3.org/view.php?id=6995
> 
> Branches:
> trunk only
> 
> Problem:
> Context Senstitive Help text should be displayed faster.
> 
> Solution:
> Context Senstitive Help as Tooltip
> Context Senstitive Help takes long to start up in new window.
> Now the first Senstence of the CSH is shown when mouse is over the
> question mark help icon. The goal is to make the CSH more prominent and
> encourage to use it.
> 
> Notes:
> If you think it is too prominent this could also be an new mode "Display
> help tooltip" in "User Tools > User Settings > Context Sensitive Help
> mode".
> Background color of the mode "Display full text message" changed from
> brown to white because it looked odd.
> Tested in Firefox, IE, Safari

Yes, this looks pretty cool.

1) the output is not XHTML conformant, as you place a <span> around the
$text, which might contain <h4> etc. Better place a <div> around the
"typo3-csh-inline" stuff and style it in CSS

2) the output currently is converted to local language charset. You nede
to convert it to the current backends user charset. For example if you
set forceCharSet to utf-8 and you try to view german CSH, the umlaute
will be garbled ("?" in Firefox):
$GLOBALS['LANG']->hscAndCharConv($text, false);

3) You probably removed the $force parameter from helpTextIcon() because
it was not being used. The problem with that is that now any method from
outside that calls this function with 4 parameters will get a PHP error.
This was the "API" and it must be kept. Mark that forth parameter as
"DEPRECATED" in the comments.

4) If you set edit_showFieldHelp to "text" (the user can choose to
display text help "inline", see "Settings" in the "User tools"), the
tooltip is no longer good, because it will duplicate the text already
being shown. So it must be supressed in this situation.


Cheers,
Ernesto