English User Manual as PDF Version 1.0.0

[bmclendon0612]

Just beginning to learn how to use this massive goodie, I went looking for a PDF of the manual and looked like their wasn't one. I like to have PDF manuals so I can highlight things and make notes in the document. After 30 years in the graphic design and publishing world my OCD brain found this unacceptable, so I made one. All the content is straight off the web as of Jan 23 2022. It's not perfect but I think it's useful. Haven't checked ALL the hyperlinks but the pile I checked worked fine, both for anchors in the document and for external links.

Would the powers that be like me to send them a copy? I'd like to distribute it to anyone that might find it helpful, but I'd like to do it with the blessing of the dev team or other relevant stakeholders. I'll sit on it until I get some direction, don't want to step on any toes.

By the way, your synth kicks major ass, and I'm just getting to know it. Thanks for all the hard work!

[baconpaul]

Wow thanks! You did this manually? That’s great!

would be happy to add it to our website with a link from current manual. Couple of thoughts

1. If you did it manually your pdf should probably say “based off manual from jan23” near top since we do update
2. If you did it automatically maybe we can make that part of our profess. I tried pandoc and it was unsatisfactory so all ears on tooling

finalky thank you! As I’m sure you can imagine we get an occasional “it’s bad you don’t have a pdf” but the idea of rolling up your sleeves and fixing it matches the spirit of the project nicely!

[bmclendon0612]

Had to do it manually, no decent tools to do otherwise. Like I said it isn't necessarily perfect or as beautiful as it deserves, but it's what I was able to do. I'll add a version number and send you a copy to have a look at. Bill

…

On Sun, Jan 23, 2022 at 4:23 PM Paul ***@***.***> wrote: Wow thanks! You did this manually? That’s great! would be happy to add it to our website with a link from current manual. Couple of thoughts 1. If you did it manually your pdf should probably say “based off manual from jan23” near top since we do update 2. If you did it automatically maybe we can make that part of our profess. I tried pandoc and it was unsatisfactory so all ears on tuning finalky thank you! As I’m sure you can imagine we get an occasional “it’s bad you don’t have a pdf” but the idea of rolling up your sleeves and fixing it matches the spirit of the project nicely! — Reply to this email directly, view it on GitHub <#5816 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMPA6NAHS33TULJ535MRLI3UXR5VDANCNFSM5MT4CN3Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Bill H. McLendon 1213 Bowman Road Birmingham, AL 35235 (205) 580-9385 ***@***.***

[baconpaul]

Awesome! Thanks so much!

[baconpaul]

Oh also pinging @VincyZed

[bmclendon0612]

Surge XT User Manual V1.0.0 English.pdf

[baconpaul]

Wow that's amazing!

@VincyZed / @mkruselj I think we should link this from the manual on the web page. Any reason not to?
Thank ou @bmclendon0612

[mkruselj]

We could absolutely link to atop the manual itself (right above the SXT logo).

My worry is how quickly this printed manual might end up being out of date (i.e. if I one day decide to do a typos pass through the whole manual)...

[baconpaul]

Yeah i think it will be useful through 1.0 and 1.1 which is a good long time it looks like.

[VincyZed]

Yeah that'd be great

[baconpaul]

OK cool!

Whoever gets it into the git repo first please close this issue

And thanks again @bmclendon0612

[mkruselj]

I'm on it!

[bmclendon0612]

Just let me know that somebody who knows what they're doing has looked through it to catch any obvious mistakes before you post it. When there are major version updates in the future, give me a shout and I'll try to keep the pdf current. Consider it my contribution for such am amazing synth. It's going to take me a long time to master it, but I think it's worth the effort. I've already come across some inspirational sounds and have just scratched the surface. Bill

…

On Tue, Jan 25, 2022, 10:22 AM Paul ***@***.***> wrote: OK cool! Whoever gets it into the git repo first please close this issue And thanks again @bmclendon0612 <https://github.com/bmclendon0612> — Reply to this email directly, view it on GitHub <#5816 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMPA6NGSNYRSDKUMLN3JAQTUX3E4PANCNFSM5MT4CN3Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[mkruselj]

@bmclendon0612 It would be nice to have page numbers in the footer, perhaps.

In the LFOs section, table with LFO shapes has misaligned text in the last column (and there is a weird red dot atop the page).

This is also a mistake in online manual - in Treemonster parameter list/table, there's a missing Hz unit for Low Cut, and wrong range is used for High Cut (it's the same range as Low Cut).

In Conditioner effect (this is our mistake), we're missing the Side Low Cut parameter. I'm adding the description now.

Mid-Side Tool table has one extraneous parameter listed, fixing that as well in the online manual.

There is a misplaced table on the page where Reverb 2 and Spring Reverb parameter list/tables are.

"Effect algorithms" section is an orphaned paragraph, it should start on next page.

Different effect headers seem to have different bold levels.

Tuning Editor section seems to have the same header level? Or maybe the font size is just not different enough.

I will fix the online manual with the things I've noticed. EDIT: It's fixed! You can check the commit diff here.

[bmclendon0612]

Thanks. It may take a few days to make the corrections, I'm consumed by a big project at the moment, but I'll get to it as soon as I can. Thanks for the info! Bill

…

On Tue, Jan 25, 2022 at 10:48 AM EvilDragon ***@***.***> wrote: @bmclendon0612 <https://github.com/bmclendon0612> It would be nice to have page numbers in the footer, perhaps. In the LFOs section, table with LFO shapes has misaligned text in the last column (and there is a weird red dot atop the page). This is also a mistake in online manual - in Treemonster parameter list/table, there's a missing Hz unit for Low Cut, and wrong range is used for High Cut (it's the same range as Low Cut). There is a misplaced table on the page where Reverb 2 and Spring Reverb parameter list/tables are. "Effect algorithms" section is an orphaned paragraph, it should start on next page. Different effect headers seem to have different bold levels. Tuning Editor section seems to have the same header level? Or maybe the font size is just not different enough. I will fix the online manual with the things I've noticed. — Reply to this email directly, view it on GitHub <#5816 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMPA6NEPQYRCJE4H6V7P3Q3UX3H57ANCNFSM5MT4CN3Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Bill H. McLendon 1213 Bowman Road Birmingham, AL 35235 (205) 580-9385 ***@***.***

[bmclendon0612]

Think I caught everything. If not, give me a shout. I fairly free for the day
Surge XT User Manual V1.0.0 English V2.pdf
.

[mkruselj]

Mid-Side Tool still has the extraneous parameter (Output) which is not there on the GUI.

Page 108 still has that extraneous table in bottom right corner.

That's all, the rest seems to be fixed!

Thanks for everything :)

[bmclendon0612]

Updated!

Bill
Surge XT User Manual V1.0.0 English V3.pdf

[mkruselj]

Thanks! All uploaded. Will close this issue but we can use it for back-and-forth still even if closed. Although, if you want to, you're most welcome on our Discord server!

[baconpaul]

So awesome! Thanks for contributing!

[juanriccio]

I would love a pdf manual, for similar reasons as the OP. Additionally, my main music machine lives offline, so reading the online docs from there is quite uncomfortable. As the OP, I've been searching without much luck.
I have been explained that it's a maintenance liability, and sure compiling it by hand is quite a job (thanks @bmclendon0612!).

Maybe there is some automated tool that can make a proper pdf, with a table of contents, from the source doc? If there were, generating a "digital hard copy" manual wouldn't be a chore.