View Single Post
Old 11-01-2016, 02:19 PM   #23
KevinH
Sigil Developer
KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.
 
Posts: 8,544
Karma: 5703586
Join Date: Nov 2009
Device: many
Hi Hitch,

Quote:
Originally Posted by Hitch View Post
Kevin:
IF you (or anyone else here) has stuff you've drafted up, but just want polishing for, or details, or screenshots + polishing the writing, I'm happy to leap in with both feet. Can't say I'll be FAST, 'cuz timecrunches, but I will work on it.

Hitch

Doitsu has jumped in and has taken a shot at updating the User's Guide! It has reached the point of just needing some polishing which I hope you can help us with.

We would hope to have the following small changes made as well as cleaning it up and polishing it (shrinking screenshot file sizes, etc) if possible:

1. Replace any mention of the specific versions of Python/Qt that are included with the installers with just "Python 3" and "Qt5" because the specific version are likely to change a lot and really do not matter to the end user. That will help to keep the manual more up-to-date.

2. To somehow make it clearer that the toc tools (minus the html one) affect the NCX when editing an epub2, and affect the NAV when editing an epub3. I think Doitsu mentioned it in one place, but we'd like to see that emphasized everywhere it's applicable if possible because many users are new to the changes with editing epub3 ebooks compared to epub2.

3. Replace all screenshots with screenshots from a Windows box as github download statistics indicate that Windows Users are by far the largest downloader way overwhelming both Mac and Linux/Source downloaders combined.

So I hope you can squeeze in the polishing of this updated manual (see the attachment). If not, please just let us know and we will try to find some other volunteers.

Once we get the final version we will post it to github for everyone and then if there is enough interest, I can try to wiki-fy each chapter of the guide so in the future, users can share the workload of updating it.

I do not know much about shared editing with a Wiki but if that doesn't work we could create a github repository for just the user's guide and people can post pull requests to get things changed.

Thanks,

KevinH

ps. Everyone ... please thank Doitsu for all his hard work on this guide! Not to mention all of his great plugins, all of his testing and feedback on new features, and all of the help he provides here to anyone with questions! Sigil would not be the same without all of his help and support.
Attached Files
File Type: epub Sigil_User_Guide_updated.epub (6.99 MB, 513 views)
KevinH is offline   Reply With Quote