[nongnu] elpa/visual-fill-column 8aee572de5 062/137: Merge branch 'master' of https://github.com/joostkremers/visual-fill-column

[ELPA Syncer]

branch: elpa/visual-fill-column
commit 8aee572de50d50f4d181692f745e9dc2bc36dc22
Merge: dde0aa6535 d97017e9bc
Author: Joost Kremers <joostkremers@fastmail.fm>
Commit: Joost Kremers <joostkremers@fastmail.fm>

    Merge branch 'master' of https://github.com/joostkremers/visual-fill-column
---
 README.md | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4d2a817def..3c390bdde4 100644
--- a/README.md
+++ b/README.md
@@ -5,30 +5,42 @@
 
 ## Installation ##
 
-Install `visual-fill-column` via [Melpa](http://melpa.org), or put 
`visual-fill-column-mode.el` in your load path, (optionally) byte-compile it, 
and add `(require ’visual-fill-column)` to your `init.el`.
+`visual-fill-column` can be installed via [Melpa](http://melpa.org).
 
 
-## Usage ##
+## Activation ##
 
-`visual-fill-column-mode` is primarily intended to be used alongside 
`visual-line-mode`. If you’ve set the option `global-visual-line-mode`, or if 
you activate `visual-line-mode` in major mode hooks, you can customise the 
option `global-visual-fill-column-mode` or add the command 
`(global-visual-fill-column-mode)` to your init file. `visual-fill-column-mode` 
will then be activated in every buffer that uses `visual-line-mode`.
+`visual-fill-column-mode` is primarily intended to be used alongside 
`visual-line-mode`. If this is your desired use-case , the way to activate 
`visual-fill-column-mode` depends on how you activate `visual-line-mode`.
 
-If you don’t use either of these methods to start `visual-line-mode`, and 
instead prefer to call `visual-line-mode` interactively (i.e., `M-x 
visual-line-mode`), you can add `visual-fill-column-mode` to 
`visual-line-mode-hook` in order to activate it automatically when you call 
`visual-line-mode`. 
+If you activate `visual-line-mode` by using `global-visual-line-mode`, you can 
use `global-visual-fill-column-mode` (either set the user option through 
Customize, or call it as a function in your init file).
 
-Note that `visual-fill-column-mode` is not tied to `visual-line-mode`: it is 
perfectly possible to use it on its own, in buffers that use some other 
word-wrapping method (e.g., `auto-fill-mode`), or in buffers that do not wrap 
at all. You can activate it interactively with `visual-fill-column-mode` or you 
can add the command `visual-fill-column-mode` in mode hooks.
+`visual-fill-column-mode` can also be turned on in hooks. For example, if you 
don't use `global-visual-line-mode` but still prefer to activate 
`visual-fill-column-mode` in every buffer that uses `visual-line-mode`, you can 
add `visual-fill-column-mode` to `visual-line-mode-hook`:
+
+    (add-hook 'visual-line-mode-hook #'visual-fill-column-mode)
+
+Both these methods have the effect that `visual-fill-column-mode` is used in 
every buffer that uses `visual-line-mode`. If that's not what you want, you can 
also use the reverse method: add `visual-line-mode` to 
`visual-fill-column-mode-hook`:
+
+    (add-hook 'visual-fill-column-mode-hook #'visual-line-mode)
+
+This way, whenever you activate `visual-fill-column-mode` (e.g., interactively 
with `M-x visual-fill-column-mode` or in a major mode hook), `visual-line-mode` 
is also activated, but you can still activate `visual-line-mode` without using 
`visual-fill-column-mode`.
+
+Note that `visual-fill-column-mode` is not tied to `visual-line-mode`: it is 
perfectly possible to use it on its own.
 
 `visual-fill-column-mode` works by widening the right window margin. This 
reduces the area that is available for text display, creating the appearance 
that the text is wrapped at `fill-column`. The amount by which the right margin 
is widened depends on the window width and is automatically adjusted when the 
window’s width changes (e.g., when the window is split in two side-by-side 
windows).
 
 In buffers that are explicitly right-to-left (i.e., those where 
`bidi-paragraph-direction` is set to `right-to-left`), the left margin is 
expanded, so that the text appears at the window’s right side.
 
-Widening the margin causes the fringe to be pushed inward. For this reason, 
the fringes are placed outside the margins by setting the variable 
`fringes-outside-margins` to `t`.
+Widening the margin normally causes the fringes to be pushed inward. Since 
this is visually less appealing, the fringes are placed outside the margins. 
You can undo this by setting the variable 
`visual-fill-column-fringes-outside-margins` to `nil`.
+
 
 ## Splitting a Window ##
 
 Emacs won’t vertically split a window (i.e., into two side-by-side windows) 
that has wide margins. As a result, displaying buffers such as `*Help*` 
buffers, `*Completion*` buffers, etc., won’t split a window vertically, even if 
there appears to be enough space for a vertical split. This is not problematic, 
but it may be undesirable. To remedy this, you can set the option 
`split-window-preferred-function` to 
`visual-fill-column-split-window-sensibly`. This function first unsets the 
margin [...]
 
+
 ## Adjusting Text Size ##
 
-The width of the margins is adjusted for the text size. However, interactive 
adjustments (e.g., with `text-size-adjust`) cannot be detected by 
`visual-fill-column-mode`, therefore if you adjust the text size while 
`visual-fill-column-mode` is active, the margins won't be adjusted. To remedy 
this, you can force a redisplay, e.g., by switching buffers, splitting and 
unsplitting the window or calling `redraw-display`.
+The width of the margins is adjusted for the text size: larger text size means 
smaller margins. However, interactive adjustments to the text size (e.g., with 
`text-size-adjust`) cannot be detected by `visual-fill-column-mode`, therefore 
if you adjust the text size while `visual-fill-column-mode` is active, the 
margins won't be adjusted. To remedy this, you can force a redisplay, e.g., by 
switching buffers, by splitting and unsplitting the window or by calling 
`redraw-display`.
 
 Alternatively, you can advise the function `text-size-adjust` (or whatever 
function you use to adjust the text size) with the function 
`visual-fill-column-adjust`: