any interest in an *-env.txt file for setting env vars for Sigil

[BeckyEbook]

Great idea.

Here's a plugin for lazy users who don't want to manually edit env-vars.txt file.

[BetterRed]

Originally Posted by BeckyEbook

Great idea.

Here's a plugin for lazy users who don't want to manually edit env-vars.txt file.

Attachment 217583

You seem to be missing a couple:



SIGIL_USES_DARK_MODE maybe defunct, but SIGIL_PREFS_DIR is definitely active, I occasionally swap in "_AppData/Sigil/Prefs_default".

BR

PS: I assume use of the env-vars.txt file is optional.

[DiapDealer]

Originally Posted by BetterRed

SIGIL_PREFS_DIR is definitely active, I occasionally swap in "_AppData/Sigil/Prefs_default".

SIGIL_PREFS_DIR is one you won't be able to set with the new env-vars.txt feature. You have to know the prefs dir to find the env-vars.txt file that will set variable to find the prefs dir to find the env-vars.txt file to set the variable to find the.... you get the picture.

Originally Posted by BetterRed

PS: I assume use of the env-vars.txt file is optional.

Of course. The file does not exist by default.

[DNSB]

Originally Posted by BeckyEbook

Great idea.

Here's a plugin for lazy users who don't want to manually edit env-vars.txt file.

Nice!

I'll test it as soon as my compile finishes. I came here to whinge but KevinH ninja'd me.

[DiapDealer]

I'm loving this. So simple, so handy.

[KevinH]

Originally Posted by BeckyEbook

Great idea.

Here's a plugin for lazy users who don't want to manually edit env-vars.txt file.

Attachment 217583

Wow, nicely done! It was even smart enough to keep the custom env var names I was using for testing.

FWIW, I have tried to fix up the sigil-user-guide for future Sigil 2.6.2 release,
with info on the env-vars.txt file.

So if anyone is interested in vetting it and adding to it, please start by grabbing things from our sigil-user-guide repo master.

I tried to add in the force native dialogs env var that was previously missing, remove some duplication and add a second advanced topics chapter on python function replace.

Please take a peek and let me know if any changes are needed.

I hope to officially release it in sync with Sigil 2.6.2.

[BeckyEbook]

Thank you for your kind words.

SIGIL_PREFS_DIR is not Linux Only, although that is what the sigil-user-guide mentions.

I will add in the plugin a special support for this variable, which will not be read from env-vars.txt file but simply by os.getenv().

[KevinH]

Okay, I updated the user guide and tried to better describe SIGIL_PREFS_DIR.

Should we rename SKIP_SIGIL_ to SIGIL_SKIP_ or just leave it as is?

[BeckyEbook]

Alternatively, an intermediate output: rename, but support both versions.
An example precedent is here.

In short: we promote the "SIGIL_*" environment variables in the documentation (and in the plugin), but both variables will work.

[BetterRed]

Could BeckyEbook's Env Var Editor be another panel or tab in Preferences - then maybe no need for the env-vars.txt man in the middle ?

Probably need to restart Sigil after using it.

[KevinH]

Originally Posted by BetterRed

Could BeckyEbook's Env Var Editor be another panel or tab in Preferences - then maybe no need for the env-vars.txt man in the middle ?

No, the whole point of environment variables in Sigil are that they are reserved for obscure, dangerous, or little used settings that do not deserve a place in the Sigil Preferences menus. They should not be needed by a typical (non-advanced) user.

Having a plugin gui handle this is perfect for those who want or need a gui in order to edit a text file.

[DiapDealer]

Are you talking about renaming existing environment variables?

[BeckyEbook]

Yes. One of the variables (SKIP_SIGIL_UPDATE_CHECK) deviates a bit from the others because it doesn't start with "SIGIL_".

[DiapDealer]

I like the idea of supporting both if an env var is renamed, but it could complicate things a bit. Renaming already-in-use env vars strictly for the sake of SIGIL_* naming consistency is probably not something I'd bother with honestly. But if it doesn't break anything for existing users, knock yourselves out.

[KevinH]

Actually being able to search Sigil source code for "SIGIL_" to get all of the Sigil specific environment variables in one go is a nice thing to be able to do.

It is only a small one line change in main.cpp that will allow both SKIP_SIGIL_UPDATE_CHECK and SIGIL_SKIP_UPDATE_CHECK to work now.

@BeckyEbook, please change your gui to use SIGIL_SKIP_UPDATE_CHECK and I have changed the sigil_user_guide to do the same and we can deprecate SKIP_SIGIL_UPDATE_CHECK and remove it sometime down the road.

I have pushed this minor change to Sigil master and sigil-user-guide master.