View Single Post
Old 02-10-2021, 10:21 AM   #1
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: 7,654
Karma: 5433388
Join Date: Nov 2009
Device: many
Looking for Volunteers for New Chapters for Sigil User's Guide

Hi All,

EDIT: The update is now complete as of March 12th, 2021


Given the feature and ui changes, Sigil's User Guide really really needs updating and some new chapters added.

The possible new chapters relate to:

1. Sigil's new Icon themes including what each icon means in each set, how to select one of the pre-installed icon themes in Preferences and how to set your own custom icon theme. (Edit: Done in Custom UI chapter)

2. An improved discussion of Plugins for users. Including where to find them, how to install them, how to remove them, how to assign icons to plugin placeholders, etc. Perhaps including a very brief summary of some of the major plugins out there: epubcheck, flightcrew, KindleImport, ODTImport, Kindlegen, epub3-itizer, Access-Aide, etc, etc. (Edit: To be handled in Manage Plugins Chapter)

3. A chapter on changing an epub's internal folder names and paths, moving and renaming files using move and rename and the regular expression renaming. How to change file extensions, how to "standardize to old Sigil's folder structure", how to create a default custom empty epub. (Edit: Handled in various places but more could be done about Custom Default Layouts in a future version of the user guide).


And on top of all of that, we have updated the photos and modernize all existing chapters to show the existing menu structure and functions while keeping the wonderful existing tutorials on clips, and indexing and other things.


So if anyone would like to help give back to Sigil, updating just one existing chapter or adding just one new chapter would be a wonderful way to give back and help others all at the same time!

As a standard we can all use the default main icon set for any images so that new users are shown a consistent interface.

So if anyone is willing to help with just one chapter, please post to this thread which one you are willing to take lead on (current chapter or proposed) so duplication of efforts is minimized.

I will do all of the merging back into the user manual to help make things easier.

The very latest user's guide can be found in repository form here:

https://github.com/Sigil-Ebook/sigil-user-guide

and in epub form can be found attached to this post as:

Sigil_User_Guide_2021.03.18_epub3.epub


Thanks to all volunteers who have helped!
KevinH


-- Update --

A repository with some updated screenshots is available here:

https://drive.google.com/drive/folde...E03ldjIG-Cvks7


All chapters have now been claimed and edited and a final cleanup has been done. It should be final.
Attached Files
File Type: epub Sigil_User_Guide_2021.03.18_epub3.epub (5.67 MB, 170 views)

Last edited by KevinH; 03-16-2021 at 12:06 PM. Reason: Adding link to current epub version
KevinH is offline   Reply With Quote