? No Code Attached Yet
avatar PhocaCz
PhocaCz
2 Jan 2023

Steps to reproduce the issue

This issue is related to these issues:

#39544
#35594
#39538

We all know that one of the problems for newbies when using Joomla is that parameters are stored in multiple places, sometimes they can be overriden. That's why it's good to have help for these parameters. An example might be this problem:

#39544

There is no information about what function the parameter has.

Expected result

It is very helpful to have parameter hints

Actual result

Many parameters lack help.

#35594

My opinion (please, it's not a criticism) is still the same: An artificial problem has been created completely unnecessarily. In Joomla 3, the help was in the Tooltip and it didn't bother anyone. Those who wanted to visualize the help got the help, those who didn't, the help didn't bother them at all. And that's even in the case when someone finds specific help completely unnecessary and irrelevant. Since the Tooltip was removed, we started to think about how to solve it differently. The result is an overengineered solution that is not complete at all.

The result - without unnecessary discussions - is the missing help for these parameters. It is not clear what their exact function is.

System information (as much as possible)

Joomla 4.2.6
PHP 8.1

avatar PhocaCz PhocaCz - open - 2 Jan 2023
avatar joomla-cms-bot joomla-cms-bot - change - 2 Jan 2023
Labels Added: No Code Attached Yet
avatar joomla-cms-bot joomla-cms-bot - labeled - 2 Jan 2023
avatar brianteeman
brianteeman - comment - 2 Jan 2023

As repeatedly stated and as you well know. If you want to add some textual help then just submit a pull request to add it.

avatar PhocaCz PhocaCz - change - 2 Jan 2023
The description was changed
avatar PhocaCz PhocaCz - edited - 2 Jan 2023
avatar PhocaCz
PhocaCz - comment - 2 Jan 2023

I'm definitely going to do it, as soon as the Tooltips are returned (which in my opinion were senselessly discarded), I'm immediately ready to help with adding hints back to the system.

avatar brianteeman
brianteeman - comment - 2 Jan 2023

I guess your memory is failing you and you have forgotten that Nik added the toggle help button so that you can do this. Just as everyone else who screamed for the tips completely disappeared when the ability to add descriptions was added. No one other than Nik has added any. Guess it really wasnt that important after all.

avatar brianteeman
brianteeman - comment - 2 Jan 2023

This should be closed. There is nothing new here

avatar dgrammatiko
dgrammatiko - comment - 2 Jan 2023

I will repeat myself here: the inline help button was a mistake, it's inaccessible and with 4.3 introducing (probably) the tour guide (or whatever it name is) it's pretty obvious that was a wrong solution on a problem that the project had a way to fix in a very elegant way. Now Joomla has to support an inaccessible weird interface in parallel with the guided tour...

avatar PhocaCz
PhocaCz - comment - 2 Jan 2023

I guess your memory is failing you and you have forgotten that Nik added the toggle help button so that you can do this. Just as everyone else who screamed for the tips completely disappeared when the ability to add descriptions was added. No one other than Nik has added any. Guess it really wasnt that important after all.

Nik returned the Tooltips? Please read carefully what I write..

avatar PhocaCz
PhocaCz - comment - 2 Jan 2023

I will repeat myself here: the inline help button was a mistake, it's inaccessible and with 4.3 introducing (probably) the tour guide (or whatever it name is) it's pretty obvious that was a wrong solution on a problem that the project had a way to fix in a very elegant way. Now Joomla has to support an inaccessible weird interface in parallel with the guided tour...

I know it goes round and round, but there's just no way to go back and use what Tootlips were just made for?

avatar dgrammatiko
dgrammatiko - comment - 2 Jan 2023

I know it goes round and round, but there's just no way to go back and use what Tootlips were just made for?

So let me get this straight:

  • Joomla 4 was released with always visible descriptions (as long as there was some text)
  • You din't like it and Nik introduced an inaccessible interface to hide/show them to fix your problem
  • Now you requesting yet another interface (tooltips) for the same thing?
  • Joomla is actually planing (it did since my first POC) the guided tour for each page help

My dumb question here: how many interfaces solving the same problem are satisfactory/maintainable/consistent/etc?

avatar PhocaCz
PhocaCz - comment - 2 Jan 2023

You keep misinterpreting me. I did not like the removal of Tooltips. Nobody has created anything that solves my problem, because nobody returned back the Tooltips. And please don't make it sound like Joomla's problems are my problems.

The matter is simple to understand. Yesterday I taught a new Joomla user. I wasn't able to do something as trivial as embedding an image/logo on the site (Cassiopeia template). The problems cycled:

  • no display of images ( #39538 )
  • not setting height and width ( #39543 )
  • inability to see help for two similar parameters ( #39544 )

The training ended in failure. We lost a new Joomla user.

Me, for my needs I use Gantry and have no problems with setting logo. So again: please don't make it sound like Joomla's problems are my problems.

avatar dgrammatiko
dgrammatiko - comment - 2 Jan 2023

please don't make it sound like Joomla's problems are my problems.

@PhocaCz honestly I don't want to fight over this but Joomla 4 was released without any problems regarding the description of the input fields, as long as there was some text that was always visible. The most accessible and intuitive interface, no javascript no tooltips nothing more required. You (I hope I'm not attributing this falsely to you, if so pardon me) requested some way to hide those descriptions (behind a tooltip as in J3) but what the project accepted (wrongly imho, as I had explained in that issue) the toggle Inline Help, which is completely inaccessible and on top of that it doesn't actually fit your expectations. The problem here is getting extremely complicated as the project is planing to release the guided tour (which with fairly little code could act also as something extra to the descriptions), so cumulatively we end up with multiple interfaces for the same problem! Also the tooltips are requested back.
Honestly, if I had to make the call here I would revert the inline help and go back to the always visible descriptions and leave the extra details to the guided tour (with the assumption that forms could provide a simple JSON and not require an extra plugin for the guided tour).
Simplicity is the ultimate sophistication...

avatar PhocaCz
PhocaCz - comment - 2 Jan 2023

You (I hope I'm not attributing this falsely to you, if so pardon me) requested some way to hide those descriptions (behind a tooltip as in J3)

My opinion is clear, completely consistent - not "some way to hide ..." , but returning what worked in Joomla 3 - Tooltips - which are intended for this task

Possible solutions:

a) Tooltips - intended to this task, it appeared from the discussion that they should be OK due to accessibility

b) Help display under the parameter - it's OK, but not for longer help - to the argument that longer help does not belong here, it was clearly answered that people value even this longer help before visiting an external resource and thus interrupting the current activity

c) Toggle Button - partially solves b) but will never be as simple, straightforward and effective as a)

After reading the entire discussion, I simply found a) to be the most suitable. Thus, I ask myself the philosophical question why the most suitable solution was removed and replaced with something that constantly causes problems and takes everyone's time. :-(

But back to the topic:

#39544

The problem here is that we don't know what the parameter actually does, and thanks to a bug we can't test what filling it means. Because entering a value probably won't do anything thanks to a bug

Honestly, if I had to make the call here I would revert the inline help and go back to the always visible descriptions and leave the extra details to the guided tour

As discussed, "jumping off" at work is very unproductive and distracting. It can completely throw off the workflow. (this opinion is not from my head, it was mentioned in the discussion). The same with long text help that interferes with work.

avatar dgrammatiko
dgrammatiko - comment - 2 Jan 2023

@PhocaCz you do realise that I had coded the tooltip that you're asking for but it was decided to go with the always visible descriptions (and I was fine with that decision). FWIW the preview is here https://joomla-projects.github.io/custom-elements/#/tip and the code is dated back to 2017! adding that code next to any input should be a couple of hours work all and all...

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

I don't want to fight over this

@dgrammatiko so simply don't. @PhocaCz suggested what many have suggested before (tooltips) and questions its removal. Which was highly questionable indeed. Above all he is voicing his concerns (which he has every right to do). Nothing more than this.

it was decided to go with the always visible descriptions

@dgrammatiko and now comes valid question: why it was decided against tooltips? Serious question.

Nik added the toggle help button

@brianteeman its not a question who added it, its a question who (and why) removed it........ not to mention that I highly doubt that Nik (btw: why we cannot even mention him anymore? I think I know, but want to hear from leader) added it.

============

avatar chmst
chmst - comment - 4 Jan 2023

I think I know, but want to hear from leader

no comment.

It is not a question of who did what. At the end it is always a decision of the whole group of developers, testers, maintainers, release managers.

avatar brianteeman
brianteeman - comment - 4 Jan 2023

sorry I dont respond to trolls

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

At the end it is always a decision of the whole group of developers, testers, maintainers, release managers.

@chmst depends on project, but all groups you mentioned wouldnt need to decide upon sth, if there wasnt the need/there was no problem rose by someone..

sorry I dont respond to trolls

@brianteeman completely your choice that you are entitled to. I respect that. Seriously. Even if you call me s troll (which, btw, I do not agree with). I dont mind being called a troll as I know Im not.

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

@coolcat-creations I sent email and prefer to solve this in private.

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

#35594 - This discussion is extensive and a lot of information can be gleaned from it

The intention was probably clear, to clean up the help, delete unnecessary texts and perhaps simplify everything by displaying the text directly below the parameters.

Why am I opening this topic? No, it's not trolling or any other way of creating trouble. I personally don't care who, what, etc.? The decision was simply made. The problem why I opened this topic is simple. It is an unresolved topic, still relevant and problematic.

Just see: #39545 (comment)

You are facing a possible new Joomler and you are not able to do such a trivial thing as insert an image as a logo in the default template and when you look for help on the parameters, it is nowhere to be found.

img
(As a person with cca15 years of experience with Joomla, I know what the first parameter means, I don't know what the others mean exactly. I personally look into the code, but I don't know for a standard user).

Three possible solutions and their pros and cons listed here:
#39545 (comment)

a) Tooltips - a feature that was created for these purposes
b) Help displayed under the parameter - not OK for longer text
c) Toggle button - technically complicated and more complex

This problem is still open and unsolved, the summary of a) to c) is not a criticism and does not ask who, what and why, it is just a summary of possible solutions.

This post was created as an issue because it is an issue. If no one on the core team cares, let this post die, after a while someone will close it saying it's an old post.

BTW Technically, Tooltips are accessible in Joomla 4, they work on hover or click events and take the value from an XML file by default.

img
(or as written here: #39545 (comment) )

That is, if anyone thinks that I have a personal problem with help in this case. No I don't, I can look at the code and in my extensions I use the Tooltips available by default in Joomla 4. This is purely a Joomla problem and mostly affects standard users.

avatar brianteeman
brianteeman - comment - 4 Jan 2023

for what feels like the hundredth time of saying it. If you feel that something needs additional information then add it. No one will object to that.

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

for what feels like the hundredth time of saying it. It is not so easy as it seems.

Someone sometimes decided that the given information was not needed.
img

I'm not the one to decide, and I'm not going to add parameter after parameter and argue with someone if it's relevant information or not. The advantage of Tooltips is that even if you display unnecessary information for someone, it doesn't bother anyone. E.g. basically no one clicks on the help for the Title parameter, but the fact that even the unnecessary information is there does not bother anyone and that is the advantage of Tooltips.

Yes, if Tooltips are brought back and it is agreed that information that may be worthless to someone can be displayed there, I will definitely join.

avatar brianteeman
brianteeman - comment - 4 Jan 2023

I now have absolutely no idea what you are talking about and what you want to happen - dioes anyone else understand?

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

@brianteeman yes, I understamd what @PhocaCz talks about.

avatar chmst
chmst - comment - 4 Jan 2023

@brianteeman

  • Descriptions from J3 should be restored when they were useful (from the point of view of a newbie)
  • They should be displayed as tooltips (as we have on status buttons, for example).

I myself sometimes miss descriptions. Then I use to read the code or the tooltip in a J3 installation but this is not user friendly.

avatar dgrammatiko
dgrammatiko - comment - 4 Jan 2023

@chmst @PhocaCz @wojtekxtx great, so who's doing the PR that reverts the inline help toggle button and adds the tooltip needed code?

Also, technically you can't remove the inline help button before J5 as it's a B/C break...

avatar chmst
chmst - comment - 4 Jan 2023

I wrote a summary of the discussion (response to @brianteeman), to make clear what is required nothing else.

And said that I am missing some descriptions (where we can easily make small PRs if needed).

avatar brianteeman
brianteeman - comment - 4 Jan 2023

I would be against restoring anything as a tooltip that is not done in such a way as to indicate one is available. That would be an accessibility fail - there must be an indicator.

Otherwise my view has not changed in 4 years. If you want to add some more text then please submit a pr

avatar coolcat-creations
coolcat-creations - comment - 4 Jan 2023

But I wrote an indicator in J3 ? Can't this code be used?

avatar brianteeman
brianteeman - comment - 4 Jan 2023

But I wrote an indicator in J3 ? Can't this code be used?

of course

avatar dgrammatiko
dgrammatiko - comment - 4 Jan 2023

But I wrote an indicator in J3

#18452 is @coolcat-creations 's PR for anyone wondering

avatar coolcat-creations
coolcat-creations - comment - 4 Jan 2023

But I wrote an indicator in J3

#18452 is @coolcat-creations 's PR for anyone wondering

Thank you currently not in the office so it complicated to
search and reference it :-)

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

who's doing the PR

@dgrammatiko: not me. At least not now. Till early next week Im super busy.........

B/C break...

@dgrammatiko so what?

avatar dgrammatiko
dgrammatiko - comment - 4 Jan 2023

so what?

You're right, B/C breaks are not a problem anymore 😕

@dgrammatiko: not me. At least not now. Till early next week Im super busy.........

Right, https://github.com/joomla/joomla-cms/pulls/wojtekxtx

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

Otherwise my view has not changed in 4 years. If you want to add some more text then please submit a pr

I really don't want to lecture and advise, but it is not appropriate to make a political decision first and then possibly do PR?

We are well aware of the scenario of creating a PR and then pushing it through. One user works on it for a long time, makes a PR, then learns in the discussion that something else is expected in the newer version, misunderstandings, rifts and unnecessary conflicts occur. An example of a dark admin template theme.

Although I personally would like a PR for the return of Tooltips, I am based on the opinion of about 3-5 people from our community, but that is still not enough. There is a core team here that should clearly say: a), b) or c)

avatar brianteeman
brianteeman - comment - 4 Jan 2023

Otherwise my view has not changed in 4 years. If you want to add some more text then please submit a pr

I really don't want to lecture and advise, but it is not appropriate to make a political decision first and then possibly do PR?

For the avoidance of any confusion my view has always been that where necessesary there should be "descriptions".

Not sure what you mean about politics

c) Toggle button - technically complicated and more complex

Could you explain what is technically complicated and more complex about this option. It already exists you just need to add the text as has already It just needs the text

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

Could you explain what is technically complicated and more complex about this option. It already exists you just need to add the text as has already It just needs the text

#39545 (comment)

I don't know if I misunderstood this post wrongly, but:

... but what the project accepted (wrongly imho, as I had explained in that issue) the toggle Inline Help, which is completely inaccessible ...

Plus other things discussed long ago. Even if you have a toggle button, you still won't get rid of the problem of long help text, problems with a large number of parameters and scrolling to the toggle button, etc. Simply, a toggle button will never be as simple a solution as Tooltips.

c) is not a solution, it is a helper to solve some problems b). Thus, the simple solution a) became a more complicated solution b), which additionally needs c) - technically complicated and more complex.

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

Not sure what you mean about politics

Making a PR is a technical matter, deciding whether such a PR will be included in the project is a political decision. The political decision should be made before the creation of technical PR. Because otherwise it can turn out like many PRs (including the dark theme of the admin template PR)

avatar dgrammatiko
dgrammatiko - comment - 4 Jan 2023

Because otherwise it can turn out like many PRs (including the dark theme of the admin template PR)

Jan, you've mentioned that PR (I'm guessing you're referring to Nik's one here) twice but probably it's the wrong analogy. That PR tried to solve with PHP a problem that is in the Browser territory and in the way created unneeded complexity both for the templates and the editors and on top of that essentially blocking any new Bootstrap updates. Like BS2.1.3 and J3 but actually even worse. Honestly I feel like an idiot right now stepping up and helping (as I did when you asked me about Bootstrap 5.0, you do remember that, right?) because I could have let the project go with that solution and laugh from the sidelines seeing Joomla struggling the coming months. Maybe I should close both those PRs #39379 #39400 and go spend my time on something else...

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

@dgrammatiko

Please don't look for any complications here. My opinion (maybe a few people's too) is that simply to show the help the easiest solution is Tooltip.

If I misunderstood or misquoted something somewhere, then I'm sorry.

In no way do I want to criticize anyone's work or anyone's decisions.

I pointed out in this thread that some parameters are missing help, and also that it may be that it has moved away from Tooltips unnecessarily and the current solution is not that good. But that's just my opinion. If someone from the core team reads it and thinks about it, OK. If not, it just will be.

When I talk to people about PR issues, most of the time we agree on why there isn't a brainstorm first, then a political decision, and then the technical execution of the PR.

Personally, I was saddened by PR regarding the dark theme of the admin template. If there had been brainstorming before the technical PR, the PR would certainly not have turned out as badly as it did.

avatar brianteeman
brianteeman - comment - 4 Jan 2023

That was the developers choice. Sometimes people create an RFC before
starting work, sometimes not.

avatar PhocaCz
PhocaCz - comment - 4 Jan 2023

Yes, that's why I was just commenting that maybe it's better to know if there is any interest in it before doing a PR.

avatar wojtekxtx
wojtekxtx - comment - 4 Jan 2023

@dgrammatiko nowhere did I say Im busy with Joomla. So no idea how you came to this conclusion.

avatar chmst
chmst - comment - 10 Jan 2023

We could make a little change right now: Switch the inline help to visible per default, so that newbies see the information at once and experienced users can switch off.

avatar wojtekxtx
wojtekxtx - comment - 10 Jan 2023

@chmst sounds like a plan 👍

avatar Hackwar Hackwar - change - 23 Feb 2023
Labels Added: ?
avatar Hackwar Hackwar - labeled - 23 Feb 2023

Add a Comment

Login with GitHub to post a comment