Looking for Volunteers for New Chapters for Sigil User's Guide

[KevinH]

I will take tutorial_stylesheets.html
__________________
Ashley

Thank you!

[KevinH]

@Banjo,
FYI... After looking at the tutorials in greater detail and how they focus on the simple sequence of steps to create an epub, I am going to rename your tutorial on the inspector to become a normal chapter about the Inspector, just as I did with my Checkpoints chapter. That way the tutorial_* chapters retain the simple sequence of steps approach.

[Banjo]

Originally Posted by KevinH

@Banjo,
FYI... After looking at the tutorials in greater detail and how they focus on the simple sequence of steps to create an epub, I am going to rename your tutorial on the inspector to become a normal chapter about the Inspector, just as I did with my Checkpoints chapter. That way the tutorial_* chapters retain the simple sequence of steps approach.

Sounds like a good idea. Using the inspector is probably not a beginner sort of activity.

BTW, I was just looking at that chapter and noticed a typo in it. I duplicated the word "the" in one instance.

"In the previous figure of the Console, you can see that I have typed '$0' into the Console, and it is displaying the the contents of the selected node."

[KevinH]

This change will be in the next version.

Thanks,

KevinH

Originally Posted by Banjo

Sounds like a good idea. Using the inspector is probably not a beginner sort of activity.

BTW, I was just looking at that chapter and noticed a typo in it. I duplicated the word "the" in one instance.

"In the previous figure of the Console, you can see that I have typed '$0' into the Console, and it is displaying the the contents of the selected node."

[Banjo]

Looks like we are getting down to just a few tutorials.

I will take on tutorial_generate_toc.html unless somebody else wants it. It looks mostly OK, but we might want to add just a few words about lower level header tags and what that does to the TOC.

I also think that the HTML TOC gets its information from the TOC rather than directly from the HTML files (is this incorrect?) We might want to put a reminder that it is necessary to create the regular TOC before creating the HTML TOC.

Just some thoughts.

[KevinH]

It is yours!

I you decide to expand it please remember to not duplicate too much from the table of contents chapter. Just reference it.

Thank you.

Originally Posted by Banjo

Looks like we are getting down to just a few tutorials.

I will take on tutorial_generate_toc.html unless somebody else wants it. It looks mostly OK, but we might want to add just a few words about lower level header tags and what that does to the TOC.

I also think that the HTML TOC gets its information from the TOC rather than directly from the HTML files (is this incorrect?) We might want to put a reminder that it is necessary to create the regular TOC before creating the HTML TOC.

Just some thoughts.

[Banjo]

Originally Posted by KevinH

It is yours!

I you decide to expand it please remember to not duplicate too much from the table of contents chapter. Just reference it.

Thank you.

OK. I probably won't do too much to it. Just check it out to make sure that it flows with the rest of the book.

[BeckyEbook]

I noticed a little thing: in the user_interface.html file,

Remove Open and Close Tag Pair (no equivalent menu entry)

should:

Remove Open and Close Tag Pair Format→Remove Tag Pair

I can see quite a few minor typographic inconsistencies in the code, so when it's fully updated I’ll take the entire file and fix all of those places.

It's about classic changes:
* hyphen in the middle of the text to ndash – 8 times, 1 time is to be converted to −
* mdash in the middle of the text for ndash – 6 times
* simple quotation marks for the correct one (it’s a tedious job and has to be done by hand, avoiding those places where the simple quotation marks need to stay, but I’ll do it)
* correct apostrophes (e.g. Sigil’s)
* standardization of arrows pointing to a menu item (->, =>, →). For the sake of readability, I propose to list them all with ⮞ [EDIT: this is high-number-unicode] or ➜, but I would like the opinion of others. As it stands, in bold, → is almost invisible.
* ellipsis made of dots

BTW: Rare code coloring error caused by an asterisk. (Treats text as a comment /*… */)

[KevinH]

Hi BeckyEbook,

That would be wonderful!

Thanks

KevinH

Originally Posted by BeckyEbook

I noticed a little thing: in the user_interface.html file,

Remove Open and Close Tag Pair (no equivalent menu entry)

should:

Remove Open and Close Tag Pair Format→Remove Tag Pair

I can see quite a few minor typographic inconsistencies in the code, so when it's fully updated I’ll take the entire file and fix all of those places.

It's about classic changes:
* hyphen in the middle of the text to ndash – 8 times, 1 time is to be converted to −
* mdash in the middle of the text for ndash – 6 times
* simple quotation marks for the correct one (it’s a tedious job and has to be done by hand, avoiding those places where the simple quotation marks need to stay, but I’ll do it)
* correct apostrophes (e.g. Sigil’s)
* standardization of arrows pointing to a menu item (->, =>, →). For the sake of readability, I propose to list them all with ⮞, but I would like the opinion of others. As it stands, in bold, → is almost invisible.
* ellipsis made of dots

BTW: Rare code coloring error caused by an asterisk. (Treats text as a comment /*… */)

[Banjo]

I have updated the file tutorial_generate_toc.html and attached the new version. I added a couple of notes that may not be obvious to a novice, but might be good information, i.e. excluding a heading is persistent, and HTML TOC needs to be generated after EPUB TOC.

Maybe that is overkill. You can leave them out if it looks too busy to you.

I also noticed another typo in table_of_contents.html. Just search for "stringly".

"If your chapter names do not use heading tags (h1, h2, etc.) as described above, then you will not be able to generate a TOC automatically. As heading tags are very important for Accessibility reasons you should stringly consider adding them."

[KevinH]

Fixed stringly to strongly typo.
Added in your edited chapter. I will post this version this evening.

Thanks!

KevinH

Originally Posted by Banjo

I have updated the file tutorial_generate_toc.html and attached the new version. I added a couple of notes that may not be obvious to a novice, but might be good information, i.e. excluding a heading is persistent, and HTML TOC needs to be generated after EPUB TOC.

Maybe that is overkill. You can leave them out if it looks too busy to you.

I also noticed another typo in table_of_contents.html. Just search for "stringly".

"If your chapter names do not use heading tags (h1, h2, etc.) as described above, then you will not be able to generate a TOC automatically. As heading tags are very important for Accessibility reasons you should stringly consider adding them."

[KevinH]

We are down to the last unclaimed file that needs to be edited:

tutorial_convert_to_html.html

This is the one I would like to add info about the use of plugins to import .docx and odf Word/LibreOffice/OpenOffice files. It is also the place to talk about using Styles when editing in Word/Open/LibreOffice.

As I said earlier, I really need someone who has walked through this using one or two of the plugins that handle this best or permission to use any documentation those plugins may already have in our User Guide.

So hopefully someone more experienced than I will step forward for this last unclaimed chapter.

I have updated the epub version of the user-guide in the first post of this thread as:

src_updated_20210301_02.epub

It has everything mentioned to date except for the change to class example and the things BeckyEbook just found.

If anyone has any unfinished but claimed chapters that they woud like help with, please let people know here.

Once I get the last edited chapters in place, I will update the official repo (after BeckyEbook has fixed things!) with the latest version and make it an official user-guide release. I will also update the version of the guide in the Sigil docs folder on GitHub.

I realize the new user-guide does not read smoothly and may not be to everyone's taste, but this version is now leaps ahead of the 0.9.X version we had previously.

So thank you everyone who has contributed. If anyone wants their real name as opposed to their MR user id in the title credits, please just let me know and I will add them.

[odamizu]

Originally Posted by BeckyEbook

I noticed a little thing: in the user_interface.html file ...

Thanks for catching that!

Originally Posted by KevinH

... If anyone has any unfinished but claimed chapters that they woud like help with, please let people know here ...

I still owe you four chapters: book_browser, manage_plugins, find_replace, saved_searches.

I am still committed to doing all four, but I know that I am slow

[BeckyEbook]

@Ashjuk:

1. Please add space to tutorial-find-regex-chapter.png screenshot to comply with the content.
2. Can you repeat the spellcheck-context-suggestion.png screenshot so that the context menu displays a little lower and the misspelled word "wrd" is better visible?
3. All individual icons are 33x33px except one which seems huge (compared to the others): insert-image.png
4. Not updated images:
   • thumbnail+-.png
   • tutorial-links-insert-link.png

[KevinH]

I just redid the tutorial-links- images in my just posted version as macOS. So they should all be fine now unless I made a mistake.

See src_updated_20210301_02.epub in the first thread. I redid them on macOS to better show the diversity of guis that users may have and to update from bookview to codeview in the tutorials.

If I missed one please let me know.