Sigil Requested Changes Under Consideration post Sigil-1.9.2

[KevinH]

We pass a single QStringList that effectively contains the values of match.group(0), match.group(1), ... created from our C++ match info object through the embedded python bridge code , to the replace function in mymod.py, and its returns a single string replacement value back via the bridge code.

We could pass along a counter, or an structure (tuple - think a list of QVariants) for memory storage as well.

It should work. Just one more embedded python routine.

It will be be a bit quick and dirty, and more limited in scope, but we have plugins to handle the fancy stuff.

Or we take advantage of the embedded python routines to return a Replacer object and invoke its routines so that object can have cross call storage until the we delete it. We used that approach for the pre Sigil 1.9 Opf parsing routine before it was rewritten in C++.

Or even just pass in a an QString that could hold serialized json for whatever storage they needed. And return a QString pair (replacement value and storage).

[KevinH]

I checked out how we internally handle ReplaceAll in Misc/SearchOperations.cpp and for each file we handle the replacements in reverse order so that all match objects are calculated just once. That means using python replacement functions would need changes if we wanted to use them for renumbering things as that would require a new routine that works in spine order from top to bottom in each file, unlike our current C++ approach which is done for better efficiency and speed.

I still think renumbering is better done by Doitsu's excellent plugin anyway.

[Doitsu]

Originally Posted by KevinH

I still think renumbering is better done by plugins anyway.

As I've already mentioned in this thread, I'm sure that my AddIDs plugin should cover most renumbering use cases and if I've missed one, I could easily add it.

Originally Posted by Turtle91

Is it possible to incorporate something similar to Calibre's "regex-function" in the find/replace. It seems to add a huge range of options without requiring individual plugins...

@Turtle91 would you need full renumbering support in regex functions, or are you already using my AddIDs plugin or other tools for this?

[KevinH]

Yes, I agree. I edited my post to indicate that.

Originally Posted by Doitsu

As I've already mentioned in this thread, I'm sure that my AddIDs plugin should cover most renumbering use cases and if I've missed one, I could easily add it.


@Turtle91 would you need full renumbering support in regex functions, or are you already using my AddIDs plugin or other tools for this?

[KevinH]

The more I think about it, even storage may not be useful since search order is not guaranteed. Saving something across calls is needed for counting/skipping, etc but reverse order would break that. Something to think about.

In addition, one off replaces make storage irrelevant. So providing storage would make sense just for Replace All type situations.

[Turtle91]

Originally Posted by Doitsu

As I've already mentioned in this thread, I'm sure that my AddIDs plugin should cover most renumbering use cases and if I've missed one, I could easily add it.


@Turtle91 would you need full renumbering support in regex functions, or are you already using my AddIDs plugin or other tools for this?

I use your plugin for renumbering and adding numbers to headings that don't have them.

I haven't looked at the possibilities of regex functions, other than its only limited by the programming talents of the user. I really liked the ability to use it to create Title Case, which Calibre used in their How To, but honestly didn't look into it further....life got in the way.

[democrite]

Perhaps one aspect to explain how I think of what Sigil could be is that coming from some experience of using shells and doing some amount of programming, as well as other things such as being used to automation on macOS as well as some familiarity with Vim and Emacs, is that I am used to being able to use the keyboard for nearly everything and avoiding having to use the mouse most of the time.

I understand most creating EPUBs may not seek such but then again much of EPUB creation is in some sense coding. Such is some of the consideration when I mention thing I would like. I am used to such efficiency yet many others may not be. Perhaps someday but I understand the goals may never align as such.

[KevinH]

The point we are trying to make is to then use "open with" with emacs or whatever editor does things the way you want.

Using the keyboard predominantly is fine (BetterRed does that) but having different widgets fighting for focus is not. And there are some things that a mouse or mouse pad are better at including selecting specific but widely separated files in BookBrowser.

If you can program, then modify your own copy of Sigil to do what you want. BeckyEbook does that and adds menus and features she needs or wants.

Our goal is to make Sigil work like most users want (myself included) who do not want to memorize more than a handful of useful key sequences and rely on the menus and toolbar icons for all others.

[KevinH]

Would anyone here find the following new feature for Sigil useful:

Add a "dry-run" mode for Find and Replace that would show the before and after results from a Regex Replace/Replace-All in a big table but not actually make any changes at all (or possibly wait until user says okay?). Maybe a simple Ctrl-Click on the Replace button to do the dry-run.

Imagine a table with two columns, the first showing a short context (3 to 5 words on each side of a match) for each match, and the second column showing the same short context with the replacement made. But no actual replacements are done ( or until the user okays it).

The number of words of context could be a user preference.

Effectively this would be a faster easier way of making a Checkpoint, doing the ReplaceAll, and comparing using File level highlighted diffs, and deciding whether to keep or revert to the Checkpoint all without Checkpointing at all.

Would this be a generally useful addition?

[Doitsu]

Originally Posted by KevinH

Add a "dry-run" mode for Find and Replace that would show the before and after results from a Regex Replace/Replace-All in a big table but not actually make any changes at all (or possibly wait until user says okay?).

IMHO, that would be a great addition. So far, I have been using a private regex tester plugin that shows all regex matches in the validation window, but a built-in option would be much better.

[Turtle91]

Yes...that would be awesome.

I currently use "Count All" to see if I'm in the ballpark, then replace individual ones a couple times to make sure it's doing it properly, then replace/find until I get tired of it, then replace all - after saving, of course.

Seeing everything in a table that I could quick scan, especially with an "accept changes" button would be the bee's knees!

[BeckyEbook]

Originally Posted by KevinH

Imagine a table with two columns, the first showing a short context (3 to 5 words on each side of a match) for each match, and the second column showing the same short context with the replacement made. But no actual replacements are done ( or until the user okays it).
(…)
Would this be a generally useful addition?

This idea looks exciting!
It is especially useful when a given replacement is not unambiguous and depends on a contest. I don't like to mindlessly click "Replace All", so this dry-run preview could become my favorite tool.

I use a similar solution every day, but in a simplified form – through a plugin, but at least I can preview the results in the "Validation Results" window.

[odamizu]

I like this idea a lot!

I currently do the same as Turtle91:

Originally Posted by Turtle91

... "Count All" to see if I'm in the ballpark, then replace individual ones a couple times to make sure it's doing it properly, then replace/find until I get tired of it, then replace all ...

A dry-run table would be awesome!

[phillipgessert]

I would also find that really useful.

[KevinH]

Okay, it appears to be quite popular. I will start looking at how to actually accomplish that.

Thanks to everyone that provided their feedback.