Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

toggle inlinehelp in jem settings #1587

Closed
jojo12 opened this issue Jun 13, 2023 · 55 comments
Closed

toggle inlinehelp in jem settings #1587

jojo12 opened this issue Jun 13, 2023 · 55 comments
Labels
change fixed Have a commit with the solution. J4 question Further information is requested
Milestone

Comments

@jojo12
Copy link
Contributor

jojo12 commented Jun 13, 2023

see items #1338 and #1339 too.
I tried with these articles. now I see very short time the toggle and then it disappears.
Would be good to have it visible and enabled.
[by the way: there are a lot of description who aren't useful, because they say the same as the label. But only if you can make them visible, it is good to write better texts".]

@jojo12 jojo12 added bug Something isn't working question Further information is requested change labels Jun 13, 2023
@mckillo
Copy link
Collaborator

mckillo commented Jun 13, 2023

I have the same issue in edit event view (backend). When the button move to the right, disappear (by 'd-none' class ). I have to debug it.

@mckillo
Copy link
Collaborator

mckillo commented Jun 14, 2023

Add inlinehelp button to FormView: "This pull request has been automatically rebased to 5.0-dev. No new features will be merged into Joomla! 4.3 series. Joomla! 4.4 series is a bridge release to make migration from Joomla! 4 to 5 as smooth as possible." See joomla/joomla-cms#39073

@mckillo
Copy link
Collaborator

mckillo commented Jun 14, 2023

\media\system\js\inlinehelp.min.js is javascript to add 'd-none' class and hidden the bottom.
This is Joomla core. I think that we'll have to wait.

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 14, 2023

Ok, but why this is working in com_config and in modules since JL4.1?

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

I don't know, but it doesn't work. There are alot issues about this button ( joomla/joomla-cms#37819, joomla/joomla-cms#37917, joomla/joomla-cms#37849, joomla/joomla-cms#39073, joomla/joomla-cms#35610)

In my debugger of javascript .... If I rename \media\system\js\inlinehelp.min.js file (not load and load inlinehelp.js) .... the 'Toggle Inline Help' buttom appears but It doesn't work.

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 15, 2023

Thank for your researches. In this case I am not very happy with the responsable makers of Joomla (not with you :-) ). The guided tours isn't the better way.

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

JEM4 - help page buttom

Alternative, prepare help pages in the JEM web.
There are to migrate JEM web with J3 to J4, create a menú /help/4.0/... or manual page.

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 15, 2023

yes, I've seen. (but I think, this could be for 4.01.

@jojo12 jojo12 removed the bug Something isn't working label Jun 15, 2023
@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

I have installed JEM 4.0 rc1 in Joomla 5.0.0 alfa1 with PHP 8.2 (with small version change into pkg_jem_v4.0rc1\pkg_jem\packages\com_jem.zip\com_jem\script.php to 5.1.0) and JEM works.
I'll try to check this 'Toggle Inline Help buttom witn JEM+JL5.0.0a1

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

Nothing, it doesn't work.
jl500a1\media\system\js\inlinehelp.js is the same, don't change.
I think that there is something that I don't see. I don't understand.

JEM4 - help page buttom soens't appear on Joomla5 5 0 alpha 1

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

This isn't going to work, because in JEM views, the fields are showing with getLabel and getInput, but 'Toggle Inline Help buttom' works when the fields are generate by renderField layout (use LayoutHelper::render). This is the problem, there are to change all JEM views to use 'Toggle Inline Help buttom'. And I have doubts that it is a final solution in JL5.0

I'll think to find alternative workaround without change all view code (when the field has a description in xml file)

JEM4 - help page buttom soens't appear on Joomla5 5 0 alpha 1 (test alternative to works)

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

I think that I have found the way.
Change call getLabel and getInput to show the field for renderfield.

mckillo added a commit that referenced this issue Jun 15, 2023
Change getLabel and getInput for renderfield. This commit is a test, if it works, we can export other views and tabs.
@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

When you have time check these two commits of this issue. Tested in JL 4.3.2 & JL 5.0.0a1

JEM4 -Toggle Inline Help works (draft to change code use renderfield)

If we approve this change, we must add the styles (css) of the fields. I think it's a simple solution to adapt.
Tell me, your opinion and testing.

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 15, 2023

yes it works: the toggle is visible and when clicking on it, the text under the field appears. It is the label.

Now it only needs to finde the desc of the label.
EDIT: I have to look into the DESC-KEYS
EDIT2: That's it, we have a lot of LABEL_DESC-KEYS, which are the same as the LABEL-KEYS!

@mckillo
Copy link
Collaborator

mckillo commented Jun 15, 2023

All field descriptions are in \administrator\components\com_jem\models\forms*.xml (JEM views in backend)
In my case, this last commit is for event view and use event.xml

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 15, 2023

exact! ;-)

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 15, 2023

I tried in settings basiclayout. It works there too!

mckillo added a commit that referenced this issue Jun 16, 2023
Change getLabel and getInput for renderfield. This commit is a test, if it works, we can export other views and tabs.
mckillo added a commit that referenced this issue Jun 16, 2023
Active Toggle Inline Help in other backend views: category, group, venues, setting.
@mckillo
Copy link
Collaborator

mckillo commented Jun 16, 2023

JEM4 -Toggle Inline Help works (migration render fields in setting)

See commit above. Active Toggle Inline Help in other backend views: category, group, venues, setting.

@mckillo
Copy link
Collaborator

mckillo commented Jun 16, 2023

@Heklaterriol See this branch https://github.com/jemproject/JEM-Project/tree/active-help and last commits.
This feature 'Inline help' is for v.4.0.1, don't merge to the rc1.
I'll have to apply more change and review style. There are fields with foreach, and they are diferents (not render).

mckillo added a commit that referenced this issue Jun 16, 2023
this file was missing from last commit about inlinehelp.
@jojo12
Copy link
Contributor Author

jojo12 commented Jun 16, 2023

I like the specific help too: it links directly to the right JEM help page!

@mckillo
Copy link
Collaborator

mckillo commented Jun 16, 2023

It would be good to know the help structure in the new web.
For example, if the help page will be in:
https://www.joomlaeventmanager.net/help/4.0/
https://www.joomlaeventmanager.net/documentation/4.0/
https://www.joomlaeventmanager.net/documentation/4.0/backend/
https://www.joomlaeventmanager.net/documentation/4.0/backend/control-panel
https://www.joomlaeventmanager.net/documentation/4.0/backend/events
https://www.joomlaeventmanager.net/documentation/4.0/backend/venues
https://www.joomlaeventmanager.net/documentation/4.0/backend/categories
https://www.joomlaeventmanager.net/documentation/4.0/backend/groups
https://www.joomlaeventmanager.net/documentation/4.0/backend/settings
https://www.joomlaeventmanager.net/documentation/4.0/modules/
https://www.joomlaeventmanager.net/documentation/4.0/modules/basic
https://www.joomlaeventmanager.net/documentation/4.0/modules/wide
https://www.joomlaeventmanager.net/documentation/4.0/modules/calendar
https://www.joomlaeventmanager.net/documentation/4.0/modules/teaser
https://www.joomlaeventmanager.net/documentation/4.0/modules/banner
https://www.joomlaeventmanager.net/documentation/4.0/modules/junilee
https://www.joomlaeventmanager.net/documentation/4.0/plugin/
https://www.joomlaeventmanager.net/documentation/4.0/plugin/content
https://www.joomlaeventmanager.net/documentation/4.0/plugin/list-events-content
https://www.joomlaeventmanager.net/documentation/4.0/plugin/smart-search
https://www.joomlaeventmanager.net/documentation/4.0/plugin/comments
https://www.joomlaeventmanager.net/documentation/4.0/plugin/mailer
https://www.joomlaeventmanager.net/documentation/4.0/plugin/quick-icon
https://www.joomlaeventmanager.net/documentation/4.0/plugin/search

and if the help structure were defined, then we can custom the help buttom to link each pages.
Do you like it? This should be in other issue, do you open it?

@mckillo
Copy link
Collaborator

mckillo commented Jun 20, 2023

But the user already has JEM-Help to see internally this static content as first resource, I think, that we can add this help button to redirect the user to external help on the JEM web (dynamic content or the help updater and extender).

On the other hand:

  • If JEM has a documentation website we can send the url of reference to other users to help them.
  • If we need to publish any help or modification help in the extension, you need a new version, so, with the help web page, we can publish this help for all people without any new version.

Other extensions (Akeeba, Phoca, JCE, Acymailing, ....) has documentation on their website. Google indexes these pages and the users find help about JEM. The official documentation is the reference how Joomla does too or other event managers extension.

What is better (internal or external)?

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 21, 2023

You're right. Better would be both!

@ernst67
Copy link
Contributor

ernst67 commented Jun 21, 2023

Yes, good points mckillo!

Both would be excellent. For the name I would simply refer to JEM4 (to avoid misunderstandings with Joomla4)
JEM 4 is now for Joomla 4 but may live to Joomla5

So as URLs":

www.joomlaeventmanager.net/documentation/JEM4/backend/

Agree?

@mckillo
Copy link
Collaborator

mckillo commented Jun 21, 2023

Yes, I agree, but as url is better in lower case /jem4/, so if there are others extension .... can be differentiated ... who knows :-)
When you have it, let me know and I'll change the url in the code

@mckillo
Copy link
Collaborator

mckillo commented Jun 22, 2023

https://www.joomlaeventmanager.net/documentation/jem4/
https://www.joomlaeventmanager.net/documentation/jem4/backend/
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/export-data
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/import-data
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/housekeeping
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/css-manager
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/load-sampledata
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/update-check
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/manage-plugins
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/help
https://www.joomlaeventmanager.net/documentation/jem4/backend/control-panel/statistics
https://www.joomlaeventmanager.net/documentation/jem4/backend/events
https://www.joomlaeventmanager.net/documentation/jem4/backend/events/add-event
https://www.joomlaeventmanager.net/documentation/jem4/backend/venues
https://www.joomlaeventmanager.net/documentation/jem4/backend/venues/add-venue
https://www.joomlaeventmanager.net/documentation/jem4/backend/categories
https://www.joomlaeventmanager.net/documentation/jem4/backend/categories/add-category
https://www.joomlaeventmanager.net/documentation/jem4/backend/groups
https://www.joomlaeventmanager.net/documentation/jem4/backend/groups/add-group
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/basic-settings
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/event-page
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/layout
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/global-parameters
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/user-control
https://www.joomlaeventmanager.net/documentation/jem4/backend/settings/config-info
https://www.joomlaeventmanager.net/documentation/jem4/modules/
https://www.joomlaeventmanager.net/documentation/jem4/modules/basic
https://www.joomlaeventmanager.net/documentation/jem4/modules/wide
https://www.joomlaeventmanager.net/documentation/jem4/modules/calendar
https://www.joomlaeventmanager.net/documentation/jem4/modules/teaser
https://www.joomlaeventmanager.net/documentation/jem4/modules/banner
https://www.joomlaeventmanager.net/documentation/jem4/modules/junilee
https://www.joomlaeventmanager.net/documentation/jem4/plugin/
https://www.joomlaeventmanager.net/documentation/jem4/plugin/content
https://www.joomlaeventmanager.net/documentation/jem4/plugin/list-events-content
https://www.joomlaeventmanager.net/documentation/jem4/plugin/smart-search
https://www.joomlaeventmanager.net/documentation/jem4/plugin/comments
https://www.joomlaeventmanager.net/documentation/jem4/plugin/mailer
https://www.joomlaeventmanager.net/documentation/jem4/plugin/quick-icon
https://www.joomlaeventmanager.net/documentation/jem4/plugin/search
https://www.joomlaeventmanager.net/documentation/jem4/plugin/search
https://www.joomlaeventmanager.net/documentation/jem4/plugin/others/acymailing
https://www.joomlaeventmanager.net/documentation/jem4/plugin/others/community-builer
https://www.joomlaeventmanager.net/documentation/jem4/override
https://www.joomlaeventmanager.net/documentation/jem4/languages
https://www.joomlaeventmanager.net/documentation/jem4/github

This will be the help structure menu. Any more?
In the begining with an article empty with the same name of the end menu.
We would can use Phoca Documentation for Joomla 4 (Template override of blog content, not component...when we'll have website in J4).

@mckillo
Copy link
Collaborator

mckillo commented Jun 22, 2023

There will be to define the design style of content, I proposal to create a fisrt article (real example) to define the template for all help article, for example:

  • Intro (1-3 lines).
  • Capture view or options from JEM extension (front or backend)
  • Define all option. This can be the descripcion of field (ini file)
    • extension help of this field (if apply).
      with time or when it will be necesary, extend with)
  • Sample config (sector or practical uses).

@ernst67
Copy link
Contributor

ernst67 commented Jun 23, 2023

I'm not too keen to use yet another component (Phoca Documentation like you proposed). Actually, Phoca Download is one of the more complicated components to upgrade the site from Joomla3 to 4.
I need to export and import all tabels.

I think the documentation can be completed with with just Joomla articles and a menu structure.

For most things we do I always check with Kunena and see how they solve it. Actually, they also use articles, but their documentation contains more than just the help files. Look at this:

https://docs.kunena.org/en

Their help is only onder item 9 in the list: Manual.
If we do it like that it would allow us to have more "general" items in the documentation e.g. about mimimum requirements, etc.

So I will set up the menu like you proposed onder Documentation. I propose to add "help" or "manual' after "jem4" for those items that will be linked from component.
I guess all the url's containing "backend" will be linked from the help button?.

@mckillo
Copy link
Collaborator

mckillo commented Jun 23, 2023

I only agree with Joomla (my reference/proposal was for Phoca Documentation for J4, it isn't component, not table, only content template override), but I don't remember that JEM website is in J3.

It's good example of Kukena (9.Manual for backend and frontend).
I think that it isn't necessary to add "help" or "manual, it was redundancy because before there was /documentation/, another it could be to change /documentation/ to /manual/.

And yes, all urls with backend will be linked from the help button.

@ernst67
Copy link
Contributor

ernst67 commented Jun 26, 2023

All articles have been created. You can see them when logged in the site: a top menu item "documentation" appears.
The menu is displayed on the right, I set up 2 menu structures to choose from. One is always expanded, the other is an accordeon style menu

@mckillo
Copy link
Collaborator

mckillo commented Jun 26, 2023

Perfect, I'm on it

@ernst67
Copy link
Contributor

ernst67 commented Jun 26, 2023

Please not the extra "manual" I had to add to the URL.

And I just added a third navigation menu (all 3 are on the right hand side). Personally I prefer number 2, but curious for your opinion...

@mckillo
Copy link
Collaborator

mckillo commented Jun 26, 2023

Ok I wait that you finish it.

@ernst67
Copy link
Contributor

ernst67 commented Jun 26, 2023

Well, just tell me which you prefer

@mckillo
Copy link
Collaborator

mckillo commented Jun 26, 2023

Option 2 too, white and colapse is clear and clean. But add +1or +2 size letter, in mobile is some little.

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 27, 2023

I agree to mckillo option 2

@ernst67
Copy link
Contributor

ernst67 commented Jun 27, 2023

Done. Changing the font size (currently 12) into something bigger messes up the layout of the module. (I tested in Firefox).
If you have any tip they are welcome!

Also added some articles under the general info ("basics") about system requirements, installation and upgrading (Jojo, i stole the text from your forum post).
Please have a look and feel free to make adaptions

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 27, 2023

well done!😉

@ernst67
Copy link
Contributor

ernst67 commented Jun 27, 2023

rubber?

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 27, 2023

Robber, my english, sorry

@mckillo
Copy link
Collaborator

mckillo commented Jun 27, 2023

I like it ... tomorrow I'll update the inline-help branch with the new link help button.

@ernst67
Copy link
Contributor

ernst67 commented Jun 27, 2023

OK. Meanwhile I have set the the documentation area to public viewing

@jojo12
Copy link
Contributor Author

jojo12 commented Jun 27, 2023

you can see the documentation, but it's written "You are not authorised to view this resource."

@mckillo
Copy link
Collaborator

mckillo commented Jun 28, 2023

@ernst67 Me too, same error. See PM.

@ernst67
Copy link
Contributor

ernst67 commented Jun 28, 2023

@mckillo
I answered your PM

@mckillo mckillo added the J4 label Jul 7, 2023
@jojo12
Copy link
Contributor Author

jojo12 commented Aug 1, 2023

it works, can this be closed?
(it's always possible to find better declarations!)

@mckillo
Copy link
Collaborator

mckillo commented Aug 1, 2023

Yes, the inline help was included in the request-answer branch. All urls for Documentation (website) are in code now (v.4.0.1).
Can be closed.

@jojo12 jojo12 added the fixed Have a commit with the solution. label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change fixed Have a commit with the solution. J4 question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants