Visual Cue in Add Semantics dialogue box?

[theducks]

I would love any feed back in the set symantics dialog. (Bold when set would also be fine with me)
And, I too know how to check the guide. But if I manage to do one twice while setting, I would see immediate feedback of oops!

[KevinH]

I will look into that for a future release after our QtWebEngine Betas are released. It should be doable.

[KevinH]

Originally Posted by BeckyEbook

I know, I know ... an old thread, discussed many times, and also linked to an even older one.
It worried me a few years (!), but I think I have an idea that should appeal to both programmers and users.

I know exactly how to check the semantics (guide in opf, landmarks in nav, hover or report), but I want to SEE immediately those files that have set semantics.

And ... I succeeded.

I have the "X" icon assigned to .xhtml files by default (other people usually have a browser icon there). An icon with a checkmark means a file with semantics. I suggest the default icon "document-validate_16px.png" for testing

Now, when checkmark (or something else) I know straight away that there is semantics in this file and then I can easily look at the tooltip. When an ebook has 100 chapters - it makes a difference!

The change requires only two lines of code.
File: \src\MainUI\OPFModel.cpp

        if (semantic_type_all.contains(path)) {
            tooltip += " (" + semantic_type_all[path] + ")";
            item->setIcon(QIcon(QString::fromUtf8(":/main/document-validate_16px.png")));
        }
        if (manifest_properties_all.contains(path)) {
            tooltip += " [" + manifest_properties_all[path] + "]";
            item->setIcon(QIcon(QString::fromUtf8(":/main/document-validate_16px.png")));
        }

Only two things are worrying me:
1. It rather works in Windows, but since Sigil is a multi-system program, the solution should work everywhere, including Linux and Mac. Can anyone build a version in these systems and check it out?

2. Is this idea just an unnecessary bloat or a useful change?

Proof of concept – animated gif.

Mixing Icons and Text on MacOS systems has many bugs in Qt (especially with tabs) which is why we remove the icons from tabs on Mac now.

So this would not be my preferred solution.

[Doitsu]

Originally Posted by BeckyEbook

2. Is this idea just an unnecessary bloat or a useful change?

I like your idea, but, it'd override the OS specific HTML and XHTML file icons.

I'd prefer one of the following solutions, provided they don't require major code changes:

• changing the icon background color
• inverting the icon colors
• adding a yellow highlight
• overlaying the default icon with a small plus sign or a small baggage tag icon.

I'm sure other Sigil users will come up with better suggestions.

[lumpynose]

Completely replacing the icon bothers me; it seems like a bit much. Putting the file name in bold would work for me, or even better maybe, putting it in italics. But even that bothers me some because I'm thinking that it'd make the list busy/noisy. The Eclipse IDE has a nice method, it modifies the icon on the left; for example, overlaying in the bottom left corner with a yellow warning triangle or a red stop sign.

[lumpynose]

Originally Posted by Doitsu

I like your idea, but, it'd override the OS specific HTML and XHTML file icons.

I'd prefer one of the following solutions, provided they don't require major code changes:

• changing the icon background color
• inverting the icon colors
• adding a yellow highlight
• overlaying the default icon with a small plus sign or a small baggage tag icon.

I'm sure other Sigil users will come up with better suggestions.

Are the system icons sacred? For comparison, here are some of the eclipse file icons. I'm wondering if it's easier to fiddle with them when they're ones built into Sigil instead of the system icons.

[BetterRed]

I would prefer a solution that only 'highlighted' files that have a semantic tag, and left untagged files alone. And my preference would be to decorate the file name with bold and/or italic rather than changing the icons to ticks and crosses. I have different defaults for xhtml and html, hence different icons.

And when version 1.0 comes along I'm hoping I'll be able to create chapter folders that contain all chapter specific content (main text, images, notes text etc) - in which case the file type based icons would be preferred, i.e. the same as I see most everywhere else.

BR

[lumpynose]

Here's an example from eclipse where I put some junk in a file giving it a syntax error. The little arrow on the right bottom corner is because it's not directly in the project but a link to the file elsewhere.

[KevinH]

I am more inclined to add an asterisk after the file name if that is relatively easy to do. And then in the Add Semantics dialog add an asterisk on the current semantic if one exists. Again, mixing icons and text on the mac platform is not working correctly in Qt all of the time.

I am also thinking a table/spreadsheet for mass editing of file semantics may be useful but it is a easy project for a plugin so that may be a better choice as mass changing of semantics is not an often needed item.

KevinH

[BeckyEbook]

Originally Posted by KevinH

I am more inclined to add an asterisk after the file name if that is relatively easy to do.

Asterisk may be a problem, because Sigil may consider the asterisk to be part of the filename and it will scream when renaming. Maybe there is a workaround, but my tries have failed.

[BetterRed]

Originally Posted by lumpynose

Are the system icons sacred?

For me - yes.

If a package wants to use a different set of file/mime type icons it should include a method of ignoring them - e.g. an XXXXXX_USE_SYSTEM_ICONS environment variable, or at least a means of changing them, a'la calibre's ...\resources\images\mimetypes folder.

BRRRRR (it's cold today - again)

[BetterRed]

Originally Posted by KevinH

I am more inclined to add an asterisk after the file name if that is relatively easy to do. And then in the Add Semantics dialog add an asterisk on the current semantic if one exists. Again, mixing icons and text on the mac platform is not working correctly in Qt all of the time.

To most of us an asterisk in/near a file name indicates a wildcard

How about a unicode check mark ✓ (✓)

BR

[DiapDealer]

Originally Posted by KevinH

And then in the Add Semantics dialog add an asterisk on the current semantic if one exists.

In my opinion, the Add Semantics dialog is the ONLY place visual indication of this nature would be useful and/or necessary.

[theducks]

Originally Posted by DiapDealer

In my opinion, the Add Semantics dialog is the ONLY place visual indication of this nature would be useful and/or necessary.

YEP
This tells us WHAT has been designated. The other way (file) only tells us something was done.

[KevinH]

Originally Posted by BeckyEbook

Asterisk may be a problem, because Sigil may consider the asterisk to be part of the filename and it will scream when renaming. Maybe there is a workaround, but my tries have failed.

It might require adding a one character wide field in the BookBrowser model.

If so, then I am not sure it is worth it. Adding the current semantic set would take up too much horizontal space. Mousing over the file is fast and easy and the tooltip will tell you what you want. So TheDuck's and DiapDealers suggestion might be the way to go.

Again, this is for after our upcoming Beta.