Adding a limited Automate Feature To Sigil

[KevinH]

I think there is a plugin that tries to do that. However not all epub3 features are supported by epub2 unlike going from epub2 to epub3.

Since all new epub readers support epub3, and Kindle can accept epub3 for input why is going backwards important, as it will not help for archival purposes? And any "normal" fiction epub3 can add in an NCX and guide info to make them compatible with older epub2 only readers.

To future proof things, converting from epub2 to epub3 but making sure they have an ncx and guide for backwards compatibility would seem to be a better approach.

What am I missing?

Originally Posted by Turtle91

I noticed the "RemoveNCXGuideFromEpub3" function and was wondering if it is also possible to change an ePub3 to an ePub2.

Currently I manually open the opf from the zip file and change the version=3 to version=2 then save and reopen. Not a difficult thing to do, just time consuming.

I'm thinking this functionality would require closing the epub but leave the sigil shell open to run the script, then reopening the epub...

[Turtle91]

Originally Posted by KevinH

What am I missing?

I know there are those around here that pontificate about the joys of ePub2 but it's just me being lazy and not learning ePub3-isms yet. I still do everything in ePub2. One thing I DON'T like is ePub3's meta entries in the opf.

[DNSB]

Originally Posted by Turtle91

I know there are those around here that pontificate about the joys of ePub2 but it's just me being lazy and not learning ePub3-isms yet. I still do everything in ePub2. One thing I DON'T like is ePub3's meta entries in the opf.

You could try the Doitsu's epub2 output plugin. I tried it a couple of times and the output seemed quite clean but I found myself working more with epub3 files so never did a full job of testing it.

[MicroDrie]

Originally Posted by KevinH

Then as a proof of concept, a text file with a list of plugin names to run (one per line) could be read from a "automate01.txt" file stored in Sigil's Preferences folder. KevinH

I think it's a very good idea, but you see a lot of different ideas and wishes in this post.
Why not put the commands to be executed in a JSON file? This makes it much easier to add and maintain a program step (and its sequence), as well as the associated options and actions on the result of that step.

[DiapDealer]

There are no associated options or actions for each step. It's not that complicated. It's a list of tools to be run in succession, nothing more.

[Doitsu]

Originally Posted by MicroDrie

I think it's a very good idea, but you see a lot of different ideas and wishes in this post.
Why not put the commands to be executed in a JSON file? This makes it much easier to add and maintain a program step (and its sequence), as well as the associated options and actions on the result of that step.

Users only needed to manually edit automate lists in earlier beta versions. The latest beta comes with a dedicated Automate List Editor for creating/editing automation lists.



Besides, so far only one task requires a parameter, which is clearly indicated.

[KevinH]

Based on feedback from testers of the betas, the automate feature appears to be quite useful and will be present in the next release.

That leads to a 2 more things:

- How likely will this feature be used by newer or occasional users of Sigil? If not much, should the Automate Toolbar be hidden for all new Sigil users until enabled with the View menu?

- Is there anyone willing to contribute an Automate chapter for our Sigil User Guide? Perhaps with a couple of sample Automate Lists that users might find useful? A picture of the Automate Toolbar, and a picture of the Automate Editor and maybe even a picture of the resulting log?

If not, I will take a shot at it but I am a horrible writer.

Thanks,

ps:

I just pushed to master support for the following 4 new automate Tool commands (and added AutomateEditor support for them). Thank BeckyEbook for the idea!

SetBookBrowserToAllCSS
- "Select all CSS Files in BookBrowser"

SetBookBrowserToAllHTML
- "Select all HTML Files in BookBrowser"

SetBookBrowserToAllImages
- "Select all Image Files in BookBrowser"

SetBookBrowserToInitialSelection
- "Reset BookBrowser to its initial selection"

[DiapDealer]

Originally Posted by KevinH

ps:

I just pushed to master support for the following 4 new automate Tool commands (and added AutomateEditor support for them). Thank BeckyEbook for the idea!

SetBookBrowserToAllCSS
- "Select all CSS Files in BookBrowser"

SetBookBrowserToAllHTML
- "Select all HTML Files in BookBrowser"

SetBookBrowserToAllImages
- "Select all Image Files in BookBrowser"

SetBookBrowserToInitialSelection
- "Reset BookBrowser to its initial selection"

A very good idea! Especially useful for plugins that only operate on files selected in BookBrowser.

[odamizu]

Originally Posted by KevinH

... Is there anyone willing to contribute an Automate chapter for our Sigil User Guide? Perhaps with a couple of sample Automate Lists that users might find useful? A picture of the Automate Toolbar, and a picture of the Automate Editor and maybe even a picture of the resulting log? ...

If there are no other volunteers, I would be willing to put something together with two caveats:

1) I am swamped right now, so it may be some weeks before I can do this. Not sure what the time-frame is.

2) While I am intrigued by the new Automate feature, it's unlikely that I will actually use it. But I like learning new things and will be playing with the new Automate feature just to figure out how it works. If there's someone who will be actively using Automate and is willing to write the chapter, that would be better. If not, I'm game.

[KevinH]

No problems! We can wait. I am in no rush to release Sigil 1.8 since Sigil 1.7 seems to be quite stable and doing its job well.

To help speed things up, I have attached my very very rough draft of a new automate.xhtml chapter as a starting point. I have also added a few images and things.

When you have time, just let me know and I can get you a link to a pre-release build of Sigil for macOS so that you can see and play around with this new feature.

Please feel free to change anything you want in this chapter as I admit my writing style is not for everyone (or even for me!).

Thanks!

KevinH

Originally Posted by odamizu

If there are no other volunteers, I would be willing to put something together with two caveats:

1) I am swamped right now, so it may be some weeks before I can do this. Not sure what the time-frame is.

2) While I am intrigued by the new Automate feature, it's unlikely that I will actually use it. But I like learning new things and will be playing with the new Automate feature just to figure out how it works. If there's someone who will be actively using Automate and is willing to write the chapter, that would be better. If not, I'm game.

[odamizu]

Originally Posted by KevinH

... I have attached my very very rough draft of a new automate.xhtml chapter as a starting point ...

Thanks! The rough draft looks not so rough at all and will certainly speed things up.

When you have time, just let me know and I can get you a link to a pre-release build of Sigil for macOS so that you can see and play around with this new feature ...

If you have a pre-release build ready, I'd be interested in the link so that I have it on hand if I have some time here and there to play with it. Thanks!

[KevinH]

I will pm you the latest link.

Thanks!

[phillipgessert]

Originally Posted by KevinH

- How likely will this feature be used by newer or occasional users of Sigil? If not much, should the Automate Toolbar be hidden for all new Sigil users until enabled with the View menu?

I’d vote surface it up front. Personally, I get in my habits early and despite using sigil daily, this very feature has helped me find OTHER features I didn’t know existed (a category this feature would have also landed in).

[theducks]

Originally Posted by phillipgessert

I’d vote surface it up front. Personally, I get in my habits early and despite using sigil daily, this very feature has helped me find OTHER features I didn’t know existed (a category this feature would have also landed in).

↑ ↑ ↑ ✔
Once we find an app we like, we tend to prefer the way things were done. Thus I do my heavy lifting with Sigil. New features would end up buried and undiscovered in many cases (and have) if someone had not posted here.

OTOH don't do a full reset of a users toolbar setup without asking:
"new features require major toolbar x adjustments. OK? Skip"

[un_pogaz]

I didn't really follow the implementation of this feature, but now that the translations have appeared, which means that its arrival is imminent...
Only 3 automate lists?!

But, but, But No! What is this heresy?
10 automate (2 groups of 5, like plugin) would be a minimum for a such powerful feature!!