[Plugin] EnvVarEditor - GUI editor for Sigil's environment variables

[BeckyEbook]

@DiapDealer: Yes, the current version of AppImage would be great.

EDIT:
Unknown lines are saved here:

                    # unknown
                    lines.append(stripped)

@KevinH: Indeed, I had to merge the saved information (some from the dialog box and the rest, the unknown ones, from the file). Thank you.

[DiapDealer]

Originally Posted by BeckyEbook

@DiapDealer: Yes, the current version of AppImage would be great.

Happy to get you one. Though I don't think this is a Linux issue at this point:

https://github.com/dougmassay/win-qt...s/tag/v5.212-1

There's a Sigil-2.6.2-x86_64.AppImage asset at that link.

0.1.2 is now preserving my custom/unknown variables. Thanks! But now I notice that unchecking some boxes in the gui (like for SIGIL_SKIP_UPDATE_CHECK) does not remove (or change) that variable in the file. It stays SIGIL_SKIP_UPDATE_CHECK=1.

[BeckyEbook]

I ran a few tests and I hope that both objectives were achieved: restoring the broken deletion of entries without selection or entered values, and preserving unknown environment variables.

[DiapDealer]

A quick test of 0.1.3 looks great! Thanks!

[BeckyEbook]

I have published a new version of the plugin in the first post. Feel free to test it.

Here's a planned improvement I hope to add soon: the env-vars.txt file is optional, meaning users can still set environment variables in the traditional way – directly within the system via the command line, another application, or a batch/sh script. My goal is to add a new feature that will display information within a dialog box, letting the user know if a specific Sigil environment variable has been set at the system level instead of in the env-vars.txt file.

[BeckyEbook]

TL;DR: The beta version is available in the second post. Minimum Sigil version: 2.7.6

I’ve just uploaded a new beta version of the Environment Variables Manager plugin. This update is specifically designed to support the latest changes in Sigil 2.7.6 while also introducing several "Quality of Life" improvements to the user interface.

What's New in v0.1.15 (Beta):
Support for Unsetting Variables (Sigil 2.7.6+): Following the recent Sigil update, you can now explicitly "unset" environment variables. The plugin now supports the new tilde (~) prefix. In the dropdown menu, simply select "Unset", and the variable will be removed from the environment upon the next Sigil launch.

Smarter UI Automation:

• Auto-Check: When you switch a boolean variable to "Set", the checkbox is now automatically checked for you.
• Auto-Focus & Select: When switching a String or Numeric variable to "Set", the plugin now automatically focuses on that input field and selects the existing text. You can start typing immediately – no extra clicks required!
• Cleaner Logic: Improved handling of system-level variables (like SIGIL_PREFS_DIR) to prevent redundant saves when no actual changes were made.
• Refined Tooltips: Building on the great work by @mrprobert, tooltips and labels have been further polished for clarity.

Note for Beta Testers: This version has been tested on my setup, but since it involves new UI logic (signal blocking to prevent feedback loops), I’d appreciate any feedback – especially if you notice any quirks when switching between "Set", "Not set", and "Unset" modes.

The plugin should be stable, but as always with beta software, keep a backup of your env-vars.txt if you have a very complex setup.

Looking forward to your feedback!

[DiapDealer]

I like it! I especially like seeing which variables are set in the system/user environment and not in the env-vars.txt files. It's often hard to remember where such things are set. This makes it easy to track things down and determine whether you need to unset it in Sigil, or whether you can just remove it from the system variables entirely.

The only thing I noticed was that the check box stayed checked after unsetting a variable. The checkbox was greyed out, however, and the checkmark appears to be a cosmetic-only thing. It's unchecked when the plugin is next run. No big deal at all, I just thought I'd mention it.

Thanks!

[BeckyEbook]

Thanks. I've fixed it.
Please feel free to test the new version: 0.1.16-beta. The link is in the second post.

[jugaor]

Hi, BeckyEbook.
Thanks for this useful plugin!

But the 0.1.16 doesn't save the settings, even though I get this message:

Estado: success

The user closed the dialog box.

Please note that any changes to Sigil’s environment variables
will only take effect the next time Sigil is launched.

I thought it was because I was testing the Sigil betas (post 2.7.6), but no: I deleted the plugin, went back to the official Sigil, and reinstalled the plugin… also without success.

The 0.1.12 works with both versions of Sigil, but of course, I lose the new features you added.

[BeckyEbook]

Hmm…
I'm trying to figure out this issue.
You say the plugin isn’t working because it doesn’t save the environment variables to a file, right?

At the same time, you mentioned that you closed the dialog box, because the message "The user closed the dialog box" means that the user chose not to save the data to the file and selected "Cancel" instead of "Save," or pressed the Escape key, or closed the dialog box by clicking the "X."

Can you provide more details?
1. The state of the env-vars.txt file before running the plugin
2. What exactly you set in the plugin window
3. The state of the env-vars.txt file after saving(!) the variables in the plugin

[DiapDealer]

It's working fine (v0.1.16-beta) for me on Windows 10 with Sigil 2.7.6.

If I hit the Save button after any changes using the plugin, everything is saved to the env-vars.txt file.

The only time I see the "The user closed the dialog box" is when I Cancel the plugin (or close it with the 'X' button).

[DNSB]

I'm seeing the same as @DiapDealer under Windows 10 & Windows 11 with Sigil 2.8.0 (self compiled).

[BetterRed]

Originally Posted by BeckyEbook

Hmm…
I'm trying to figure out this issue.
You say the plugin isn’t working because it doesn’t save the environment variables to a file, right?

At the same time, you mentioned that you closed the dialog box, because the message "The user closed the dialog box" means that the user chose not to save the data to the file and selected "Cancel" instead of "Save," or pressed the Escape key, or closed the dialog box by clicking the "X."

On Windows 10/11, windows can also be closed with:

• Alt+Space,C,
• Alt+F4,
• from the taskbar
  • via Winkey+T, AppMenuKey,
  • addons that enable close on taskbar icon middle button click

No matter how you close it, Sigil itself responds exactly the same if you haven't Saved - a message and three buttons Save, Discard and Cancel. Ideally Sigil plugins that Save data should do the same.

BR

[DiapDealer]

I don't know why anyone would expect their changes to be saved by choosing any other option than clicking the quite prominently displayed 'Save' button. Any dismissal of the plugin dialog other than clicking the Save button is a "Don't Save" choice. How would adding another "Don't Save" button (Discard) simplify that? Discard and Cancel would be the same thing here: changes not saved.

Unless you're talking about the Plugin Runner dialog itself. Plugins have zero control over the buttons that appear there. They can only choose to leave the full runner displayed for debug purposes (quite common in betas), show smaller version without debug output, or close it automatically after the plugin is done running. But the plugin is already done running at that point. How you choose to dismiss the Plugin Runner dialog is immaterial to a plugin's run. Always will be.

[jugaor]

Originally Posted by BeckyEbook

Hmm…
I'm trying to figure out this issue.
You say the plugin isn’t working because it doesn’t save the environment variables to a file, right?

At the same time, you mentioned that you closed the dialog box, because the message "The user closed the dialog box" means that the user chose not to save the data to the file and selected "Cancel" instead of "Save," or pressed the Escape key, or closed the dialog box by clicking the "X."

Can you provide more details?
1. The state of the env-vars.txt file before running the plugin
2. What exactly you set in the plugin window
3. The state of the env-vars.txt file after saving(!) the variables in the plugin

BeckyEbook, I think I've been able to isolate the problem:

If we've only modified variables with Set/Not Set, it saves the changes normally. (Perhaps that's the case with DD and DNSB?)
But if we use variables with user input, the plugin no longer allows saving the changes (it only allows closing the window, displaying the message I already transcribed).

In my case, I had modified SIGIL_PREVIEW_TIMEOUT with a previous version. Version 0.1.16, upon detecting a value there, doesn't allow changing any other values. Only by setting it to "Not set" does it allow changing the other values ​​and saving the changes.
Video capture: 0.1.16 NO


Reinstalling 0.1.12 resolves the problem (but it's not a good solution).
Video capture: 0.1.12 YES



System: Windows 11 LA-Spanish, Sigil 2.80 (the latest beta, but the same behavior occurs in the official 2.7.6 version).