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

[KevinH]

The Sigil version should be nearly identical to the Chrome browser version (but it might be a few versions behind) for the most part. The network stuff is really only useful for epub3 remote resources, just like the javascript console is really only useful for epub3s that use javascript.

Yes a basic description of what a DOM tree is (a tree based parsing of their xhtml code in CodeView) would help but showing how to click on the tree to expand and collapse it to find the tags (nodes) of interest and where to look (for the selected tag) for the layout details height/width and where that tag/node inherits its css definitions from (especially important for cascading part of css) are probably the most important parts for most epub developers.

Then pointing people with external links for all of the rest of it in case they are interested.

That would be grand!

[Banjo]

Got it. I am working on it.

[Tex2002ans]

Originally Posted by KevinH

Anything you can do to save file size without hurting things too much would be appreciated. [...]

Image processing is not my forte!

I compressed the PNGs from:

14.4MB->11.2MB

by running them through TruePNG. (The older compression tool made by the guy who created ScriptPNG + ScriptJPG, now known as pingo.)

It works by:

• losslessly compressing the image
• throwing away the Alpha if not needed
• removing the metadata.

QoL Side Note: And while I was skimming through the images, I noticed:



When presenting data in columns, it's best to follow these key rules:

• Text = left-aligned
• Numbers = right-aligned
  
  • Aligning on decimal if needed.
• + Match headings with the data's alignment.

This allows your eyes to easily read/compare rows.

So this:

(Left) (Left)    (Left)
Level  Included  Hidden
h1     9         0
h2     52        0
h3     0         182
h4     0         61
h5     0         0
h6     0         0

would change to this:

(Left)  (Right)  (Right)
Level  Included  Hidden
h1            9       0
h2           52       0
h3            0     182
h4            0      61
h5            0       0
h6            0       0

(All "ones"/"tens"/"hundreds" align.)

Similar alignments can probably be used in other number-columns throughout Sigil.

I'm thinking:

• Spellcheck List's "Count" column
• The numbers in Tools > Reports

would be easier to read with right-alignment too.

File Size
123.34
56.78
9.00
1.23

vs.

File Size
   123.34
    56.78
     9.00
     1.23

[odamizu]

Hi Kevin,

Here’s the User Interface chapter.

I went through it line-by-line, attempting to make sure, to the best of my novice ability, that everything is up-to-date as of Sigil 1.5.0.

Note: I did the menus and toolbars in the order that they appear on the default interface with a clean install.

Let me know if I should keep going. I was thinking to take on Preferences next. Though if there are faster, more experienced Sigil users who want to jump in, that’s okay too

ETA: I just uploaded a new zip (User_Interface_v2.zip) with smaller PNGs (using tinypng.com).

[KevinH]

Wonderful! Thank you! I will integrate what you have created into the user guide.

Yes please do Preferences as well if you are willing.

Speed is not that important. The user guide desperately needed to be overhauled.

Take care,

Kevin

Originally Posted by odamizu

Hi Kevin,

Here’s the User Interface chapter.

I went through it line-by-line, attempting to make sure, to the best of my novice ability, that everything is up-to-date as of Sigil 1.5.0.

Note: I did the menus and toolbars in the order that they appear on the default interface with a clean install.

Let me know if I should keep going. I was thinking to take on Preferences next. Though if there are faster, more experienced Sigil users who want to jump in, that’s okay too

[Ashjuk]

I have worked my way through the images from the master copy.
I have reduced the overall size from 13.8Mb down to 3.05Mb without sacrificing too much in the way of quality.

I have uploaded them to the Google Drive folder for you to have a look at.

[KevinH]

Wow! Great work!

I will grab them later tonight when I have a free moment. I only have my ipad today so I can't do much.

Thank you!

Kevin

Originally Posted by Ashjuk

I have worked my way through the images from the master copy.
I have reduced the overall size from 13.8Mb down to 3.05Mb without sacrificing too much in the way of quality.

I have uploaded them to the Google Drive folder for you to have a look at.

[KevinH]

Thanks. I will look into adding alignment to the table columns you mentioned but no numeric decimal alignment is available in Qt so it would have to be simulated by string conversion to fixed number of digits and right alignment.

That said, the alignment of the "tooltip" in the shown image is not easily changed or important as it is only a tooltip, not a real table.

Take care,

Kevin

Originally Posted by Tex2002ans

I compressed the PNGs from:

14.4MB->11.2MB

by running them through TruePNG. (The older compression tool made by the guy who created ScriptPNG + ScriptJPG, now known as pingo.)

It works by:

• losslessly compressing the image
• throwing away the Alpha if not needed
• removing the metadata.

QoL Side Note: And while I was skimming through the images, I noticed:

Attachment 185498

When presenting data in columns, it's best to follow these key rules:

• Text = left-aligned
• Numbers = right-aligned
  
  • Aligning on decimal if needed.
• + Match headings with the data's alignment.

This allows your eyes to easily read/compare rows.

So this:

(Left) (Left)    (Left)
Level  Included  Hidden
h1     9         0
h2     52        0
h3     0         182
h4     0         61
h5     0         0
h6     0         0

would change to this:

(Left)  (Right)  (Right)
Level  Included  Hidden
h1            9       0
h2           52       0
h3            0     182
h4            0      61
h5            0       0
h6            0       0

(All "ones"/"tens"/"hundreds" align.)

Similar alignments can probably be used in other number-columns throughout Sigil.

I'm thinking:

• Spellcheck List's "Count" column
• The numbers in Tools > Reports

would be easier to read with right-alignment too.

File Size
123.34
56.78
9.00
1.23

vs.

File Size
   123.34
    56.78
     9.00
     1.23

[BeckyEbook]

Originally Posted by KevinH

That said, the alignment of the "tooltip" in the shown image is not easily changed or important as it is only a tooltip, not a real table.

It's a tooltip with a table, so it can be done



EDIT: The reports will also work.

size_item->setTextAlignment(Qt::AlignRight);

[Tex2002ans]

Originally Posted by BeckyEbook

It's a tooltip with a table, so it can be done

[...]

EDIT: The reports will also work.

size_item->setTextAlignment(Qt::AlignRight);

[KevinH]

Pull Requests that I can merge would be much welcomed. Or even posting a diff or patch and pming me a link would work.

Originally Posted by BeckyEbook

It's a tooltip with a table, so it can be done



EDIT: The reports will also work.

size_item->setTextAlignment(Qt::AlignRight);

[odamizu]

I just uploaded a new zip file (User_Interface_v2.zip) with smaller PNGs. Reduced the total from 2.6 MB to 637 KB. Hopefully that is meaningful. You can grab it from my original post above.

I will move on to Preferences!

Originally Posted by KevinH

Wonderful! Thank you! I will integrate what you have created into the user guide.

Yes please do Preferences as well if you are willing.

Speed is not that important. The user guide desperately needed to be overhauled.

Take care,

Kevin

[KevinH]

Great! Thank you! I will grab everything this evening when I get to a desktop or my laptop computer. All I have access to now is an ipad.

Kevin

Originally Posted by odamizu

I just uploaded a new zip file (User_Interface_v2.zip) with smaller PNGs. Reduced the total from 2.6 MB to 637 KB. Hopefully that is meaningful. You can grab it from my original post above.

I will move on to Preferences!

[KevinH]

Thank you so much for the PR. I have merged it just now!

Kevin

Originally Posted by BeckyEbook

It's a tooltip with a table, so it can be done



EDIT: The reports will also work.

size_item->setTextAlignment(Qt::AlignRight);

[Banjo]

I have finished the tutorial on how to use the Inspector tool. The files have been zipped into the attached zip file.

All the file names begin with "tutorial_inspector" for consistency. There is one html file and 22 images.

I designed the page to go under the Tutorials page.

I created the page inside of the Sigil user manual, so if you unzip the files and import them into the manual, it should all work. I placed the chapter at the end of the tutorial section, but feel free to place it anywhere you want it.

Also, feel free to edit as needed.

Let me know if you have any problems with it, and I will fix them.