https://github.com/molkobain/itop-console-tooltips
Extension for iTop: Inform your users about the purpose of object fields with small tooltips.
https://github.com/molkobain/itop-console-tooltips
hacktoberfest itop itop-extension itop-module
Last synced: about 1 month ago
JSON representation
Extension for iTop: Inform your users about the purpose of object fields with small tooltips.
- Host: GitHub
- URL: https://github.com/molkobain/itop-console-tooltips
- Owner: Molkobain
- Created: 2018-02-15T16:25:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-09T17:10:23.000Z (almost 3 years ago)
- Last Synced: 2025-01-13T04:26:34.989Z (over 1 year ago)
- Topics: hacktoberfest, itop, itop-extension, itop-module
- Language: PHP
- Homepage:
- Size: 2.25 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
👋 Available on [iTop Hub](https://store.itophub.io/en_US/products/molkobain-console-tooltips) & [Molkobain I/O!](https://www.molkobain.com/product/console-tooltips/)
# iTop extension: molkobain-console-tooltips
* [Description](#description)
* [Compatibility](#compatibility)
* [Downloads](#downloads)
* [Installation](#installation)
* [Configuration](#configuration)
* [Change log](CHANGELOG.md)
## Support
If you like this project, you can buy me beer, always appreciated! 🍻😁
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BZR88J33D4RG6&source=url)
## Description
Display a tooltip on object's attributes (console only). 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.
Can be set on any field, to provide a long description to explain the usage of a particular field. This description can be more explicit to explain the meaning and expected usage of the field.
Description comes from iTop's dictionary entry ``'Class:/Attribute:+' => 'Some description about the attribute'``.
As part of the standard datamodel, only few fields have such description documented, especially because it is specific to the way an organization uses iTop. But with this extension, it's a good opportunity to enrich your dictionnary with business tooltips for online guidance to your users.
*Note: By default iTop has not much descriptions, if you want to add some, you have to add dictionary entries.*
## Compatibility
Compatible with iTop 2.3 to 2.7\
Obsolete for iTop 3.0+ as it is now directly included in iTop 🙌
## Dependencies
* Module `molkobain-handy-framework`
* Module `molkobain-newsroom-provider`
* Module `molkobain-fontawesome5-pack`
*Note: All dependencies are included in the `dist/` folder, so all you need to do is follow the installation section below.*
## Downloads
Stable releases can be found either on the [releases page](https://github.com/Molkobain/itop-console-tooltips/releases), [iTop Hub](https://store.itophub.io/en_US/products/molkobain-console-tooltips) or on [Molkobain I/O](https://www.molkobain.com/product/console-tooltips/).
Downloading it directly from the *Clone or download* will get you the version under development which might be unstable.
## Installation
Installation procedure is the same as for any iTop extension, just follow the instruction on the iTop official documentation [here](https://www.itophub.io/wiki/page?id=extensions%3Ainstallation).
## Configuration
No configuration needed, the extension can be used out of the box!
### Parameters
Some configuration parameters are available from the Configuration editor of the console:
* ``enabled`` Enable or disable extension. Possible values are ``true`` or ``false``, default is ``true``.
* ``decoration_class`` Change tooltip icon by setting any *Font Awesome 5* icon classes (see [here](https://fontawesome.com/icons?d=gallery&m=free) for examples). Default is ``fas fa-question``.
*Example:*
```
'molkobain-console-tooltips' => array (
'enabled' => true,
'decoration_class' => 'fas fa-question',
),
```
### Multi-line tooltips
For multi-line tooltips, just put regular line breaks (not HTML) in your dictionnary file:
```
'Class:Rack/Attribute:nb_u+' => 'Height in units (U) of the rack
Note: Standard racks have 42U',
```
## Licensing
This extension is under [AGPLv3](https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License).
## Third party libs
This extension embeds the Font Awesome 5.15.3 library. For more information visit its [website](https://fontawesome.com).