[Extension] Attributes description tooltip

[Guillaume Lajarige]

Disclaimer: This is not an official Combodo extension, it has been done on my spare time. Therefore, it's not officially supported by Combodo. I'll now post on my personal account to avoid confusion.

Hi everyone,

I made an extension to display a better decoration and tooltip on attribute labels in the console.

A ? is added next to the attribute's label to indicate that a description is available for an attribute.

Works with all objects (standard / from extensions / custom made), but only attributes for which a description exists will be affected. Description comes from iTop's dictionary entry 'Class:<CLASS_NAME>/Attribute:<ATTRIBUTE_CODE>+' => 'Some description about the attribute'.

It's available on GitHub and Molkobain I/O.

Note: By default iTop has not much descriptions, if you want to add some, you have to add dictionary entries

Cheers,
Guillaume

[Benjamin LAURENCE]

Hi guillaume,
Thank's a lot for sharing !

[Guillaume Lajarige]

Hi everyone,

Just updated the extension to make it comaptible with iTop 2.6+

[Molkobain]

Hi everyone!

I packaged a new version version of the extension including the "Molkobain's newsroom provider". Long story short, admins will get notified in iTop when a new extension is released or when there is an update available. 😄

Cheers,
Guillaume

Note: Of course this can be disabled in the configuration file.

[Tihomir Vlahovski]

Yo MAN! Stop posting this anonce in every recent topic. It's even not relevant to the discussion.

[Molkobain]

Hello Tihomir, actually it is, those are my extensions (check the disclaimer in the OP). I just updated them with a new feature, so I'm letting people know.

Most people on this forum only subscribe to some topics, not the whole forum, so I had to updated each topics. If you subscribed to the whole forum, sorry for the inconvenience!

[Tihomir Vlahovski]

I know that, but what I am saying is that the "update" is the same on all posts.
Anyway, I don't want to change the post topic in other direction.

Btw, thanks for the extentions.

Cheers,
-Tiho

[Matthieu KURLENDER]

Hi,
I just installed this extension. I have the question mark saying there is a tip, but when I put the mouse over, the tip doesn't appear.
Any idea of what I missed ?

Regards,

[Pierre Goiffon]

Hello,
Reading the extension documentation I see :

No configuration needed, the extension can be used out of the box!

But also :

Works with all objects (standard / from extensions / custom made), but only attributes for which a description exists will be affected.

Are you testing on fields with description ?

[Molkobain]

Hello Matthieu,

You might have an error somewhere. In a browser like Firefox or Chrome, could you open the dev. tools (F12), go to the "Console" tab, then reload the page and share what is printed?

Also, if you could share a screenshot (redact sensitif data), it would be great.

Thanks,
Guillaume

[Matthieu KURLENDER]

Hi,

Here is the error I got into the console tab of Chrome.
I checked the properties of the file mentionned and rights are set to 644 (linux VM)

Regards,

[Molkobain]

This file is part of the standard iTop package, as you said you checked the properties it means that it is present on your system.

To see if the permissions are ok, on the screenshot you provided, right click on the top-right filename and choose "open in a new tab". If you can see the content of the script, your permissions are ok and we need to investigate further. Otherwise, check your permissions again.

Guillaume

[Matthieu KURLENDER]

I already did this check, and yes, I can see the content of the file in the browser.

[Molkobain]

Ok thanks. Than it might be one of the tooltip description. Can you tell us where you got the extension and which version it is?

[Matthieu KURLENDER]

I downloaded the extension from the iTop hub and got the molkobain-handy-framework & molkobain-newsroom-provider from your github.

The versions are :

Molkobain's newsroom provider Version: 1.0.1
Molkobain's handy framework Version: 1.2.4
Attributes description tooltip Version: 1.0.0

[Molkobain]

I suggest you install the latest version from GitHub here. On iTop Hub the extension is not up to date.

Additionally, could tell me which version of iTop you are running?
Also, could you make the screenshot again but with the message expanded? (Click on the arrow in the top left corner)

Thanks!

[Matthieu KURLENDER]

Hi,

Many thanks, it works now :)

The itop version I actually use is : 2.6.1.4463

Many thanks again

[Molkobain]

Glad to here it worked! Compatibility with iTop 2.6 was part of the v1.0.1 😊

FYI, the handy framework and newsroom provider are included in the extension releases, so you don't have to get them from GitHub. It wasn't included in your version because the Hub doesn't have the latest versions (should be fixed in early '20)

Have a nice day,
Guillaume

[Molkobain]

Hi everyone,

Version v1.2.0 is available on GitHub and Molkobain I/O ! It brings the compatibility with iTop 2.7+.

Cheers, 😊
Guillaume

[Sergi]

Hi!
I'm using this extension, it's great, thanks for the great work.
I'm trying to add a linebreak in the text and I'm struggling, I tried html tags<p></p> or <br> etc, and also string \n \n\r etc. all of them are printed as text in the tooltip but not interpreted as linebreaks.
Is there any character that I can add to the dictionary description that add a line break?
Thanks!

PS: I know it's meant to be used to describe the attribute and probably the linebreaks don´t make sense, but I'm trying to use it to add more information about the possible values to select.

[Jeffrey Bostoen]

Try the HTML linebreak: <br>

[Sergi]

Sorry, I forgot to "code" the tags in my initial post and they were interpreted as linebreaks :D
Already tried that and it doesn´t work :(

[Molkobain]

Hello Sergi,

Thanks for the feedback!

Regarding your issue, HTML tags are removed from the dict entry before being put in the tooltip to avoid XSS attacks. But now that you mention it, as dict. entries are defined by the administrator (and not a user input), we might assume that they are safe and that we can indeed display the HTML...

I'll try to make a new version in the coming weeks :)

Cheers,
Guillaume

[Sergi]

Thanks for your answer.
I was asking as I didn´t want to put my dirty hands on the code :D
but I did, sorry...
this made the trick for me, in uiextension.class.inc.php

        // Create tooltip
        var sContent = $('<div />').text($(this).attr('title'));
        sContent.html(sContent.html().replace(/\\n/g,'<br/>'));

I just did it, I have to double check that I haven't broken anything else.
Regards,

[Molkobain]

Hello everyone,

A small message to let know that thanks to @sergifm feedback, the extension now supports multi-line tooltips! You can find it on GitHub and Molkobain I/O as v1.2.0.

Take care 🖖
Guillaume