Looking for Volunteers to help update Sigil Users Guide

[User_Z]

Originally Posted by KevinH

FYI, there is a simpler way to handle the Find and Replace buttons in case you are at all interested that does not require qss changes at all:

Simply edit your sigil_v6.ini file and add the following line to it under [find_replace]

frbuttonstextonly=true

Not only for my information, but for everyone's information, there are many ways to do something, if you also know about it.

I have four sigil_v6.ini files in different places on my computer's disk. To which of them should I add this secret parameter? Or is it the file that I will see after clicking the "Settings Catalog" button on the "Settings" panel.

And in general, where can I see a list of parameters + a description of their action that Sigil uses in its different settings files and which are not available through the "Settings" panel?

[odamizu]

Okay! I am hoping to get to this sometime next week ...

Originally Posted by KevinH

@odamisu,

I forgot that the cover template uses PLACEHOLDERS that are not used elsewhere in the template files.

This is pretty obscure so I have added a new chapter to the sigil-user-guide called advanced_topics.xhtml that has a section on this cover-template*.xhtml and its PLACEHOLDERS and many other things.

So the best way for you to deal with this is in add_cover.xhtml might be to just mentions that using your own cover template file is possible and putting a link to the "advanced_topics.xhtml" chapter.


(ps I posted a preview of this advanced_topics chapter in one of the earlier posts)

Thanks!

Kevin

[KevinH]

Originally Posted by User_Z

Not only for my information, but for everyone's information, there are many ways to do something, if you also know about it.

I have four sigil_v6.ini files in different places on my computer's disk. To which of them should I add this secret parameter? Or is it the file that I will see after clicking the "Settings Catalog" button on the "Settings" panel.

And in general, where can I see a list of parameters + a description of their action that Sigil uses in its different settings files and which are not available through the "Settings" panel?

You should only have one file exactly named "sigil_v6.ini" in your Sigil Preferences Location folder. Why do you have 4? Do you have 4 different installations of Sigil under different user names?

As far as I know, that is the only setting that has no ui for it. I found it yesterday while looking at the FindReplace.cpp source code. I had forgotten it even existed. Other things are typically set with environment variables. These are now described in the new advanced_topics.zip chapter I just posted.

[DiapDealer]

I believe we were once experimenting with a user setting to turn off the F&R icons. Reading an ini pref from the SettingsStore is a much quicker/easier test than coding environment variable logic (not to mention coding UI integration). So it can probably more accurately be described as an abandoned/incomplete/vestigial/forgotten experiment, rather than a secret parameter. There are no secrets in open source code, after all.

I believe it was determined that the qss option was sufficient for the 8 people in the world who refused to accept/embrace the new F&R icons at the time. No full ui-configurable parameter required.

By the way... is "Settings Catalog" really one of the translations of "Open Preferences Location"?

[User_Z]

>You should only have one file exactly named "sigil_v6.ini" in your Sigil Preferences Location folder. Why do you have 4? Do you have 4 different installations of Sigil under different user names?


One computer, one user, one Sigil installation.

I install new versions of the program over previous ones to save all settings.

[KevinH]

So somehow your Sigil Preferences Location folder is in 4 different places or you have symlinks from 4 different folders pointing to it. Since they are all the exact same size with the exact same modification date, my guess is symlinks are involved somehow.

I do not know Windows well enough to distinguish paths using symlinks versus the true absolute path.

Perhaps someone with knowledge of Windows could comment?

[PeterT]

I believe there is only a single INI file. From https://answers.microsoft.com/en-us/...2633b8b?page=2 it would appear that there are

What you are seeing is junctions and symbolic links, that are present in order to maintain support for legacy applications.

C:\Documents and Settings - junction - points to C:\Users
C:\Users\All Users - symbolic link - points to C:\Program Data
C:\Documents and Settings\All Users - same as C:\Users\All Users
C:\ProgramData\Application Data - junction - points back to C:\ProgramData

If you want to list all them all, open command prompt and enter: dir /a:l /s C:\

[BetterRed]

Originally Posted by DiapDealer

I believe we were once experimenting with a user setting to turn off the F&R icons. Reading an ini pref from the SettingsStore is a much quicker/easier test than coding environment variable logic (not to mention coding UI integration). So it can probably more accurately be described as an abandoned/incomplete/vestigial/forgotten experiment, rather than a secret parameter. There are no secrets in open source code, after all.

I believe it was determined that the qss option was sufficient for the 8 people in the world who refused to accept/embrace the new F&R icons at the time. No full ui-configurable parameter required.

By the way... is "Settings Catalog" really one of the translations of "Open Preferences Location"?

I'm 1 of the 8

I don't appear to have anything regarding F&R buttons in qt.qss, all I have is this:

:focus {border: 1px solid yellow;}
QMenu {border: 1px solid yellow;}
QComboBox#cbSearchMode QAbstractItemView,
QComboBox#cbLookWhere QAbstractItemView,
QComboBox#cbSearchDirection QAbstractItemView {border: 1px solid yellow;}

However I do have the setting in sigil_v6.ini, viz:

. . .
[find_replace]
visible=true
advanced_visible=true
regexoptiontextonly=true
frbuttonstextonly=true
regexoptionunicodeproperty=false
search_mode=0
look_where=0
search_direction=0
. . .

Should I replace the .ini setting with qt.qss code, and if so can someone provide the code I need to add?

BR

[BeckyEbook]

Both solutions (by ini or by qss) are practically the same, although I must admit that the method by qss is more flexible (you can control each button separately).

Link: https://www.mobileread.com/forums/sh...5&postcount=14

[DiapDealer]

Originally Posted by BetterRed

I'm 1 of the 8

I don't appear to have anything regarding F&R buttons in qt.qss, all I have is this:

However I do have the setting in sigil_v6.ini, viz:

. . .
[find_replace]
visible=true
advanced_visible=true
regexoptiontextonly=true
frbuttonstextonly=true
regexoptionunicodeproperty=false
search_mode=0
look_where=0
search_direction=0
. . .

Should I replace the .ini setting with qt.qss code, and if so can someone provide the code I need to add?

BR

It's your choice. It makes no difference (except for the extra granularity of the qss method Becky mentioned). We're not going to remove the manual settings parameter now that it's made it into several releases -- and been adopted by at least a few of the eight.

[KevinH]

Perhaps adding some of BeckyEbook's qss tweaks to the Advanced Topics might be useful:

Here is a short list I culled from some recent posting:

Show Find Replace Buttons as Text Only
QFrame QToolButton#findNext, QFrame QToolButton#replaceCurrent, QFrame QToolButton#replaceFind, QFrame QToolButton#restart, QFrame QToolButton#replaceAll, QFrame QToolButton#count {
qproperty-toolButtonStyle: ToolButtonTextOnly;}

Show Find Replace Buttons as icons and text
QFrame QToolButton#findNext, QFrame QToolButton#replaceCurrent, QFrame QToolButton#replaceFind, QFrame QToolButton#restart, QFrame QToolButton#replaceAll, QFrame QToolButton#count {
qproperty-toolButtonStyle: ToolButtonTextBesideIcon;}

Use QSS to hide all tooltips.
QToolTip {max-width:0; max-height:0; margin:0; padding:0;}

Hide Previous Find Replace History
QFrame QComboBox QAbstractItemView::item {max-height: 0;}
#cbFind, #cbReplace {qproperty-maxCount:0;}

@BeckyEbook, do you have any others you might be able to share for use in the Sigil-User-Guide Advanced Topics chapter?

[BeckyEbook]

My experiments don't always lend themselves to wider use, and then I'm the only person in the world who uses such non-standard settings, because, after all, it's mostly about individual taste.
I work in Sigil practically every day, so my preferences are simply due to the mode of this work, which is why, among other things, I have a validation results box above Code View, because I mostly analyze the results of validation plugins.
It is also important to note that my changes are more about Windows in a Classic Sigil Dark Theme.

/* Setting the monotype font in the Find and Replace fields */
/* Instead of "Consolas" use your favorite font, preferably the one you use in Code View. */
#cbFind, #cbReplace {font-family: "Consolas"; font-size: 12px;}

/* Change the default selection color to a similar green color scheme for the new logo/icon. */ 
*,
*::separator,
*::handle,
*::tab-bar,
*::tab,
*::section {
  selection-background-color: #00404a;
  selection-color: white;
}

/* Sigil version number in About box in different color */
QLabel#lbVersionDisplay {color: #FFA000;}

/* Gray background in About box on Authors tab */
QTextEdit#creditsDisplay {background-color: #323232;}

/* Gray background of the BookBrowser panel */
#bookbrowser {background-color: #323232;}

/* No BookBrowser panel borders  */
#bookbrowser {border: 1px solid #323232;}

/* No Find&Replace panel borders */
QFrame {border: 1px solid #323232;}

[odamizu]

Hi Kevin,

My knowledge of advanced Sigil features is already showing.

In the current add_cover.xhtml chapter, it says: "To modify the template Sigil uses for the HTML cover file, create a file in your Preferences directory called cover.xhtml."

Is this cover.xhtml file now deprecated in favor of the new cover-template*.xhtml file?

I tried both, and only the cover-template*.xhtml file worked for me in the current beta; the cover.xhtml file did not appear to work. But before I delete the info about cover.xhtml and replace it with cover-template*.xhtml, I want to make sure this is correct.

[KevinH]

Yes "cover.xhtml" it is no longer used for templates. Now cover-template2.xhtml (for epub2) and cover-template3.xhtml (for epub3) are what are used to hold the template information and they should be placed in the Sigil Preferences Location folder.

The file name created in BookBrowser will still default to be called "cover.xhtml" unless that name is already used.

Thanks!

Kevin

[odamizu]

Okay. Also, I noticed that the default cover file text shown in the User Guide does not appear to be the same default text I get when don't add a template. Not sure if that's something I'm doing or misunderstanding or if I should update this in the User Guide.

What's in the User Guide:

Spoiler:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Cover</title>
</head>

<body>
<div style="text-align: center; padding: 0pt; margin: 0pt;">

[...etc.]

What I get with the beta:

Spoiler:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<title>Cover</title>
</head>
<body>
<div style="height: 100vh; text-align: center; padding: 0pt; margin: 0pt;">

[... etc]

Should I update?