backdrop-contrib / beautytips_node

Display any node page inside a BeautyTip.
GNU General Public License v2.0
0 stars 0 forks source link

Improve the configuration page #3

Open olafgrabienski opened 6 years ago

olafgrabienski commented 6 years ago

The title of the configuration page admin/config/user-interface/beautytips/node-settings (path may change in future) is "User interface" (parent configuration level), I guess it should be "Beautytips" or "Beautytips Node".

It would be nice to add a short help text at top of the configuration page, providing people with the code which makes Beautytips Node tooltips working. Here's the respective information from the Drupal module page:

When you create your links manually, you will need to add the class "beautytips-node" to the link. That is the only class required and the module will handle the BeautyTip loading internally. Your link could look like any of these:

<a class="beautytips-node" href="my-first-node">My Example</a>
// if you are using views, you use set the row class to 'beautytips-node' under the 'Format settings'
<div class="beautytips-node">
<a href="my-first-node">My Example</a>
</div>

(I volunteer to improve the help text.)

Graham-72 commented 6 years ago

@olafgrabienski I have now added the code example to the help text though I am not sure about the wording, nor the way I have used markup to do this.

olafgrabienski commented 6 years ago

Thanks for adding the help text including the code example. Regarding the markup, I don't know what's best practice in such a case, but I'll try to improve the wording.

olafgrabienski commented 6 years ago

Update: With the official release, the references to Views and to div containers where temporarily removed from the help text. Currently the help text looks like this:

When you create your links manually, you will need to add the class "beautytips-node" to the link. That is the only class required and the module will handle the BeautyTip loading internally. Your link could look like this: <a class="beautytips-node" href="my-tip-node">My Example</a>

olafgrabienski commented 6 years ago

For the time being, I'd suggest to take the simpler text from the README and to add an example to it:

To use a node as the content of a BeautyTip, create a link to that node and add the class "beautytips-node" to the link. Example: <a class="beautytips-node" href="/about">About us</a>

olafgrabienski commented 6 years ago

Reminder: let's complete the help text when the module works with Views and/or surrounding div containers.