[Plugin] CSSValidator - Offline W3C CSS Validator

[Doitsu]

Released: February 7, 2022
Current Version: "0.0.7"

This plugin allows you to validate CSS files with the offline version of the W3C CSS Validator.

Disclaimer: Even though it's unlikely that the plugin will somehow corrupt the epub that you're working on or crash Sigil, you may want to save your ePub or create a checkpoint before running this plugin.

Credits

BeckyEbook and RbnJrg tested earlier versions; BeckyEbook also created the plugin icon.

System requirements

This plugin requires Java and Sigil 0.9.8 or higher. If you uncheck the Use Bundled Python option, you'll also need to install Python 3.

To find out whether Java is installed, enter the following command in a terminal/command prompt window:
java -version (should display java version "1.8.0_xx" or a higher version number)

Installation

1. Select Manage Plugins from the Plugins menu and enable the Use Bundled Python option, if it isn't already enabled (or greyed out).
2. Click Add Plugin and select CSSValidator_v0.0.7.zip. This will install the plugin, which you can select via Plugins > Validation > CSSValidator.

Settings

Advanced users can change some CSS Validator settings by editing the following CSSValidator.json entries:

  "java_path": "java",

You can use this setting to define a custom Java path.

  "css_epub2_validation_spec": "css21",
  "css_epub3_validation_spec": "css3",

By default, the plugin will validate stylesheets in epub2 books against the CSS 2.1 specs and stylesheets in epub3 books against the CSS 3 specs.
If you want to validate them against different specs, simply change the default settings to one of the following values: css2, css21, css3 or css3svg. For example, you could use "css_epub3_validation_spec": "css3svg", to validate epub3 stylesheets against the CSS 3 + SVG specs.

  "ignore_message": [],

You can use this plugin setting to filter out certain errors and warnings via their ids. For example, you could use "ignore_message": ["vendor-extension"], to filter out warnings about vendor extensions, e.g. -webkit-hyphens: none;.

  "lang": "en"

By default, the plugin will select the Sigil GUI language as the default language for W3C CSS Validator error and warning messages, if the language is supported by the W3C CSS Validator. However, you can also change it to one of the following languages: "bg", "cs", "de", "el", "en", "es", "fa", "fr", "hi", "hu", "it", "ja", "ko", "nl", "pl", "pt", "ro", "ru", "sv", "uk", "zh".

(As with all JSON files, the last entry must not be terminated by a comma.)

To display the folder that contains CSSValidator.json select Edit > Preferences > Open Preferences Location. Then double-click plugins_prefs and CSSValidator.
Windows users can also press WIN+R, paste %localappdata%\sigil-ebook\sigil\plugins_prefs\CSSValidator into the Run dialog box and hit Enter.

Troubleshooting

If you're getting a Python error: an exception of type JSONDecodeError occurred. error message for all epub files, most likely Java isn't installed or the Java binary couldn't be found. (You can download Java from the Oracle website.)

License: GNU General Public License v3 (GPL-3)

[KevinH]

Added to the Sigil Plugin Index. A great addition! Thank You!

[odamizu]

I have been wishing for this for a long time

[Binchen]

Originally Posted by Doitsu

If you're getting a Python error: an exception of type JSONDecodeError occurred. error message for all epub files, most likely Java isn't installed or the Java binary couldn't be found. (You can download Java from the Oracle website.)

What about OpenJDK?

[DiapDealer]

Originally Posted by Binchen

What about OpenJDK?

Theoretically, there's no reason it shouldn't work. As long as typing:

java -version

at a command prompt works as expected. I'll try to check when I get home.

[Doitsu]

Originally Posted by Binchen

What about OpenJDK?

OpenJDK worked on my Linux machine.
If my EpubCheck plugin works on your machine, this plugin should work, too.

[DiapDealer]

Works fine with OpenJDK for me, as well.

[Binchen]

Strangely both plugins do not run with Oracles JRE on my mac. On my Mac i have to use oracles JDK. On Windows the JRE is sufficient.
Since I work mainly on Mac I have now installed OpenJDK without getting problems with the plugins.

[KevinH]

This is a long time bug in the Oracle macOS JRE installer as it does *not* update the system paths properly. The Oracle JDK installer does do it properly. So I always install the JDK if I am using Oracle java on macOS.

Originally Posted by Binchen

Strangely both plugins do not run with Oracles JRE on my mac. On my Mac i have to use oracles JDK. On Windows the JRE is sufficient.
Since I work mainly on Mac I have now installed OpenJDK without getting problems with the plugins.

[mietek81]

I'm on Windows 11. For me 'java -version' works but plugin still gives error.
My java binary path is: D:\Programy\Java\bin\javaw.exe
If I try to change java_path in CSSValidator.json to above value then after using plugin in sigil the java_path returns to 'java' and still doesn't work.
What should I do?

[Doitsu]

The plugin works fine on my Windows 11 machine.
Here's the output from java -version.

java version "1.8.0_391"
Java(TM) SE Runtime Environment (build 1.8.0_391-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.391-b13, mixed mode)

As you can see, I'm still using Java 8.
Please post the complete error message from the Plugin Runner window.

BTW, if you want to specify the path on a Windows machine, you'll need to specify the path to java.exe not javaw.exe.

For example:

  "java_path": "C:\\Program Files\\Java\\jre-1.8\\bin\\java.exe",

or

  "java_path": "C:/Program Files/Java/jre-1.8/bin/java.exe",

[mietek81]

Originally Posted by Doitsu

  "java_path": "C:\\Program Files\\Java\\jre-1.8\\bin\\java.exe",

or

  "java_path": "C:/Program Files/Java/jre-1.8/bin/java.exe",

Thank you, that helped

[hayaku]

Hello. Wonderful plugin

Quick question: Is this still being updated/supported?

Reason I ask is, it keeps throwing up errors when I use "rem" in my CSS.

IE, unit : “rem” is an incorrect unit : padding: 0.25rem; when I have a CSS entry like "padding: 0.25rem;".

As best as I can tell, rem is a totally valid CSS entry, and more to the point, is too damn useful to go without.

Can this be updated to allow rem?

[KevinH]

It is valid in css3, but epub2 is limited to css2 or css2.1
Is your epub an epub3 or epub2?

[JSWolf]

Originally Posted by hayaku

Hello. Wonderful plugin

Quick question: Is this still being updated/supported?

Reason I ask is, it keeps throwing up errors when I use "rem" in my CSS.

IE, unit : “rem” is an incorrect unit : padding: 0.25rem; when I have a CSS entry like "padding: 0.25rem;".

As best as I can tell, rem is a totally valid CSS entry, and more to the point, is too damn useful to go without.

Can this be updated to allow rem?

Why do you need rem when em works in all cases be it ePub 3 or ePub 2? rem is not actually needed. em does exactly the same thing in ePub 3 and works in ePub 2.