Zynthian-help

Hi @zynthianers!

This is a little report about the progresses on the new help system & user guide for Vangelis:

  • Zynthian UI’s help pages have been moved to a new repository: zynthian-help

  • The help pages are now accessible by 3 ways:

    All the 3 show the same contents from the repository zynthian-help. The zynthian-help repository now includes a little server based in python’s tornado that allows to serve the help pages locally. Very useful for editing and testing the changes.

  • The web-browser versions (webconf & online) include extra screenshots and videos. I’m thinking of integrating the “zynthian mockup” to allow playing complete workflow captures with all the LEDs, button and knob details.

  • Yes. It would be nice to have an index panel at left :wink:

Although there is still a long way to complete all the “holes”, the pieces start to get aligned now.
Documenting zynthian is a huge task, and a difficult one, so … if some of you is interested in helping with this, please, contact me!!

All the best,

13 Likes

And here is an updated User’s Guide based on that Context Sensitive Help, with an index:

8 Likes

Another update on the new user’s guide for vangelis:

  • Completed and improved Basic Concepts section
  • Added new User Interface section
  • Added new Preset View section
  • Lots of fixes and adjustments

The remaining more important holes are:

  • Complete “Pattern Note Editor” section
  • Write “Pattern CC Editor” section
  • Write “Clippy” section
  • Complete “SooperLooper” section

It would be nice to write sections for all the other screens, like:

  • Admin
  • Engines
  • ZS3s
  • Snapshots
  • Chain Options
  • Processor Options
  • MIDI Input
  • MIDI Output
  • Audio Output
  • Audio Input
  • etc.

This is not so important because all these screens have quite decent “tips” in the right side panel.
Perhaps it’s enough to explain the user that they should read the tips carefully :wink:

Anyway, please, test and review the help. You can do it on-line:

https://help.zynthian.org

or updating your zynthian and accessing the on-screen help. The contents are exactly the same, except for the screenshots that are omitted in the on-screen help.

You can report errors, pitfalls, typos, etc. here, on this thread, or better, send the fixes via PR to the zynthian-help repository:

GitHub - zynthian/zynthian-help: On-screen help and user guide for the Zynthian UI · GitHub

Enjoy!

4 Likes

This is exactly the approach I have been talking for lists with info panel. The help for these views describes how to use the list and contextual help is provided by the info pane. I don’t see benefit in repeating the displayed info text in a help file. The info panel is available to zynvoice also.

1 Like

How? When entering an option only the option is read out. Or did something change there since last week when I tried this?

I find the text in the info panel to be too tiny for an zynthian 4 with a 3.5" screen. Is it possible to make this text somewhat larger? (yes, I am getting that age…).

And here is the updated user guide based on the new files and with V5 section first:

https://drive.google.com/file/d/1-Sq2D6xK1afav5yOZe2mq-c2C07Csq8d/view?usp=drive_link

1 Like

Increasing the font size is not the problem. The problem is the limited space in the 3.5 inch display. I stopped using 3.5 inch displays because i’m also “getting that age”. 3,5 inch is for the young :grin:

Regards,

3 Likes

Press the ZynVoice button. From the docs:

The ZynVoice button may be used to stop the current announcements. If ZynVoice is silent, the ZynVoice button will trigger a context announcement. By default this is the name of the current view but may also include some context for that view, for example: it may tell you the highlighted entry in a list.

I see what you mean with space. The icon wastes a lot of it. However, this area can be scrolled with encoder 3.

        fs = min(int(0.8 * zynthian_gui_config.font_size), side_width // 16)

(/zynthian/zynthian-ui/zyngui/zynthian_gui_selector_info.py)

sets the font size to 7, because the side_width calculated value will always be smaller than 0.8 of the font size. A font size of 7 is really inaccessible.

I created a PR which

  1. Clamps the font-size to 0.7*config size < relative to available width < config size.
  2. Reduces the size of the image (half the height and width), that is taking up a lot of space, but only when the font-size would otherwise have to shrink to be less than 0.7 times the user font size.
  3. Adds left-right arrow key for touch-only devices that may not have a way to rotate knob 3.

Note in the engine selector view, you can press knob 3 to open this text in the Help View. This is great, but alas we cannot easily do this in all places.

1 Like

Thanks, but:

The ZynVoice button (S4 or F4) is not configured to do this in the default wiring profiles. Only its long press is configured to do TTS_TOGGLE_ENABLE. Its short action is set to e.g. PG4, screen_zs3, arrow down, depending on the wiring profile.

Setting the short press to TTS_TOGGLE_PLAYBACK enables the behavior as described in the Help (which is great by the way).

That sounds like a bug. My plan was to have this configured as zynvoice button. Maybe @jofemodo had a different idea.

Only V4-studio profile is configured like this currently. V4-stage has not been modified yet.

Regards

Sorry. Indeed V4-stage profile is already modified to use long-S4 to enable TTS.
The user needs to re-assert the profile to get the changes.

Regards,

Hi @jofemodo the issue is not so much the long press binding (which was vacant before), but the short-press binding.

Hi @niels !

Short-S4 in V4 and short-F4 in V5 should change its functionality when TTS is enabled. It should be re-mapped to toggle TTS play.

AFAIK, apart from this, the only change in button functionality when TTS is enabled is this:

  • In help screen:
    • short knob 2 (V4’s learn/shot) => pause/resume TTS text voice
    • bold knob 2 (V4’s learn/shot) => trigger encoder TTS info

Regards,

Can anybody quickly help: I found the help pages, but I don’t know how to leave them again. Custom build with onscreen buttons, but the help page expands to full screen and none of the encoders are helpful.

Have you tried tapping anywhere on the top right to maybe make the onscreen buttons visible again?

Tap there times., or slide to left.

Yes

How?

I mean, I managed to excape the pages via UI VNC and their virtual ESC key, but that may not be a solution for every occasion.