From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 2 Jan 2022 12:07:19 +0000 (+0100)
Subject: doc: not everyone may like hyphenation or smart quotes.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=10183040d32733ec674ba6205490f9360c8402ab;p=blog.git

doc: not everyone may like hyphenation or smart quotes.

Plus hyphenation requires extra packages, so don't suggest it by default
-- but clarify that those actually *are* the defaults and so the user
can omit them.
---

diff --git a/doc/plugins/htmlsanity.rst b/doc/plugins/htmlsanity.rst
index c112fb35..d338bd0e 100644
--- a/doc/plugins/htmlsanity.rst
+++ b/doc/plugins/htmlsanity.rst
@@ -57,13 +57,16 @@ the current century.
 
 Download the `m/htmlsanity.py <{filename}/plugins.rst>`_ file, put it
 including the ``m/`` directory into one of your :py:`PLUGIN_PATHS` and add
-:py:`m.htmlsanity` package to your :py:`PLUGINS` in ``pelicanconf.py``.
+:py:`m.htmlsanity` package to your :py:`PLUGINS` in ``pelicanconf.py``. The
+following shows the minimal configuration together with default values of all
+available options. Not specifying the option is equivalent to setting it to a
+default value.
 
 .. code:: python
 
     PLUGINS += ['m.htmlsanity']
-    M_HTMLSANITY_SMART_QUOTES = True
-    M_HTMLSANITY_HYPHENATION = True
+    M_HTMLSANITY_SMART_QUOTES = False
+    M_HTMLSANITY_HYPHENATION = False
 
 Hyphenation (see below) requires the `Pyphen <https://pyphen.org/>`_ library,
 either install it via ``pip`` or your distribution package manager or disable
@@ -78,12 +81,14 @@ it with the above setting.
 
 The ``m.htmlsanity`` plugin is available always, no need to mention it
 explicitly. However, the options aren't, so you might want to supply them.
-The same dependencies as for `Pelican`_ apply here.
+The same dependencies as for `Pelican`_ apply here. The following shows the
+minimal configuration together with default values of all available options.
+Not specifying the option is equivalent to setting it to a default value.
 
 .. code:: py
 
-    M_HTMLSANITY_SMART_QUOTES = True
-    M_HTMLSANITY_HYPHENATION = True
+    M_HTMLSANITY_SMART_QUOTES = False
+    M_HTMLSANITY_HYPHENATION = False
 
 `Doxygen theme`_
 ----------------