Yoshimi User Guide

[Folderol]

I thought it best to start a separate thread for this, so...

I think the 'structure' of this is now complete, and I don't think any more images are needed. As a reminder, there is a runnable version on my website:
http://www.musically.me.uk/test/index.html

And the project page is:
https://github.com/Yoshimi/yoshimi_user_guide_sources

However, if anyone has some spare time (whatever that is) please have a go at filling out one or two of the sections, and 'claim' them on here so we know to leave it to you (and I can make sure nobody else is intending to work on the same one). If you're unsure of anything, refer to the old manual, but leave out all the 'Why and Wherefore'. You can find it here:
https://github.com/Yoshimi/yoshimi-doc/ ... manual.pdf

As an example, I'll be completing 'Main' which is mostly done now, and has all the features and styling you might want to use, then I'll move on to 'Settings'

As all the pages are self contained, you can either send them to me by email, or if you have a github account send a pull request to the project.

Finally, at the foot of the index page I'll eventually be putting an alphabetical list of all the contributors, so there's your chance for fame! (sorry about the fortune bit)

[Folderol]

There is now a lot more done on this. I'd really appreciate someone looking through, and letting me know how navigable (comprehensible?) they find it.

Still at:
http://www.musically.me.uk/test/index.html

[zenguitar]

Hi Will,

I've just had a quick scan through and I can see you've made great progress. No immediate issues with navigation.

Andy

[Martin Walker]

Looking good Will - a few comments as I navigated:

1. https://www.musically.me.uk/test/install/install.htmlSurely the two links to the source files should be clickable? I'm also going to be attempting a Yoshimi Pi update myself in the near future, so I'll let you know whether these instructions make sense once I've tried it myself

2. https://www.musically.me.uk/test/filter/filter.htmlPresumably there are still more filters to be described other than The Formant Filter on this page?

3. https://www.musically.me.uk/test/pad/pad.htmlI got as far as this Padsynth page and then there was no Next option. Shouldn't there be one to take the reader to Effects? Ah, my apologies - I now see that there are no more Next options from this point on, so that's obviously as far as you've got.

Excellent work!

Martin

[Folderol]

Thanks for checking this out guys.

Yes, Martin, not having those as clickable links was a pretty obvious oversight (where's that 'DOH' smiley). I'll put it right soon.

There are indeed still a lot of gaps. I built up the outline first with mostly placeholders so I could develop an overall consistent style, and am now filling in the details - with some help from Yoshimi's little band of helpers (TM).

I knew this would all take some time, but it has been even slower than I expected

[Folderol]

Yet more work on this.

There is now a complete list of CCs and NRPNs directly supported but Yoshimi. I'm hoping this is clear enough. Previous notes were rather patchy and even the old guide was a bit fragmented.

In the process, I uncovered two regressions that stopped parts of it working, one going back to 2018. As nobody had complained, that suggests no-one was using it

However, in the latest build it is now working correctly, with one 'extra' in Vectors (now fully described) that isn't available in either the GUI or CLI!

As before, as well as being in the doc directory of the latest build this can be found at:

http://www.musically.me.uk/test/index.html

I know there are still spelling errors in parts of the guide (it's getting quite big now) so if anyone fancies some bedtime reading, please try and dig them out

I'm now looking at filling in info on the CLI. However I won't be including full lists of all the commands. You easily get them interactively while running!

P.S. If you help get this all ticketty-boo then your name could be add to the contribs at the bottom

[Folderol]

Some final(?) tweaks here and there, including a bit more descriptive info at the top of the Add, Sub, Pad sections.
Prolly your last chance to comment before it goes to press (as it were)

[Folderol]

Wake up at the back there
As I mentioned to some people... err somewhere...
I'm currently planning on producing a set of diagrams showing the various sections and interconnections. It will take quite a while, but I want to make sure I pitch it in the most comprehensible manner.

One potential stumbling block is how to indicate routing switches. Coming from an electronic background the obvious answer would be standard switch designations, but would the average person recognise them.

One that seems simple but at the same time maybe not so much, is the part audio output routing. This can go via additional controls and mixing to the main L/R audio output, directly to a separate part audio output, or both!

Suggestions most welcome!

[James Perrett]

One potential stumbling block is how to indicate routing switches. Coming from an electronic background the obvious answer would be standard switch designations, but would the average person recognise them.

Take a look at a selection of mixer manuals - most of the leading manufacturers include block diagrams which are aimed at general users.

[Drew Stephenson]

I would have thought there was a set of British Standards for this as well?
I get that the BS version may not be immediately intuitive to someone without an electronics background, but it will be a lot easier to look up if they don't intuit your replacement image either.

[Folderol]

Thanks for the suggestions.
I did have a look through user guides for various synths. The only maker I could find with decent diagrams was Moog, and I'm pleased to say the form they use is very similar to what I had in mind
So... that's the easy bit sorted out. Now to actually get down to it... when I'd be much happier going out for walks