modxcms / revolution

MODX Revolution - Content Management Framework
https://modx.com/
GNU General Public License v2.0
1.36k stars 529 forks source link

Improve "Help" documentation iframe #16056

Open Ruslan-Aleev opened 2 years ago

Ruslan-Aleev commented 2 years ago

Feature request

Summary

1) Open iframe in current manager language

In the "Help" section, an iframe appears with the documentation always in English, although the documentation itself already has translations.

help_frame

I suggest adding a manager language for url documentation, it's more convenient + maybe it will attract users to add/correct the translation.

Add the language key to the loadHelpPane function when generating the url for the documentation (see https://github.com/modxcms/revolution/blob/3.x/manager/assets/modext/core/modx.js#L450).

For example, now, if you click on "Help" in a resource, then the old page //docs.modx.com/help/Resources is requested, which through a redirect gives the already working page https://docs.modx.com/current/en/building-sites/resources (see https://github.com/modxcms/revolution/blob/3.x/manager/controllers/default/resource/resource.class.php#L572).

And in future a page with a language key will be requested, for example, //docs.modx.com/help/ru/Resources, which through a redirect gives the https://docs.modx.com/current/ru/building-sites/resources. And if there is no translation page, then in English.

2) Add an "Open in new window" button to the popup window with iframe documentation.

In a small window it is very difficult to read the documentation.

help_frame_2

3) Test work on mobile devices

On mobile devices, the "Help" window sometimes strangely opens, as if in 2 layers, and the first layer does not fit into the window (the documentation site does not adapt), and the second with an adaptive one. Close the first window, and under it another, but with adaptive. It doesn't look clear.

Why is it needed?

UX improvement

Related issue(s)/PR(s)

N/A

Jako commented 2 years ago

The 'Open in new window' button is a nice idea.

JoshuaLuckers commented 2 years ago

Great suggestions! The "Open in new window" button is really useful and, in my opinion, should be part of the final 3.0 release.

eydolan commented 2 years ago

not sure if 100% related to this but

in Firefox the help window moves the whole page up when you click it while you are in settings

image

image

in FF and chroms same thing