emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/visual-fill-column b63174ec24 006/137: Update README


From: ELPA Syncer
Subject: [nongnu] elpa/visual-fill-column b63174ec24 006/137: Update README
Date: Sun, 2 Jan 2022 22:59:07 -0500 (EST)

branch: elpa/visual-fill-column
commit b63174ec242e5c892fa4c864311606edb9a630f0
Author: Joost Kremers <joostkremers@fastmail.fm>
Commit: Joost Kremers <joostkremers@fastmail.fm>

    Update README
---
 README.md | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index e471ea7244..d83549ab81 100644
--- a/README.md
+++ b/README.md
@@ -5,23 +5,18 @@
 
 ## Installation ##
 
-To install `visual-fill-column-mode`, simply put `visual-fill-column-mode.el` 
in your load path and add the following lines to your `init.el`:
-
-```lisp
-(require 'visual-fill-column)
-(global-visual-fill-column-mode)
-```
-
-The command `global-visual-fill-column-mode` turns on 
`visual-fill-column-mode` in all buffers that use `visual-line-mode`.
+To install `visual-fill-column-mode`, simply put `visual-fill-column-mode.el` 
in your load path, (optionally) byte-compile it, and add `(require 
’visual-fill-column)` to your `init.el`.
 
 
 ## Usage ##
 
-To use `visual-fill-column-mode` with `visual-line-mode`, use the command 
`global-visual-fill-column-mode`. Alternatively, you can use the command 
`visual-fill-column-mode` in mode hooks. Note that it is perfectly possible to 
use `visual-fill-column-mode` independently from `visual-line-mode`.
+`visual-fill-column-mode` was conceived of to wrap lines in buffers that use  
`visual-line-mode`. To activate this globally, add the command 
`global-visual-fill-column-mode` to your `init.el`.
 
-`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`. 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 margin.
+However, `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.
 
-Widening the margin causes the fringe to be pushed inward. Since the fringe is 
visible, this has a somewhat disturbing effect, because it looks like there’s 
another window to the left. For this reason, the left fringe is disabled by 
default.
+`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`. 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. Since the fringe is 
visible, this has a somewhat disturbing effect, because it looks like there’s 
another window to the left, even though there isn’t. For this reason, the left 
fringe is disabled by default.
 
 
 ## Options ##
@@ -31,3 +26,5 @@ Widening the margin causes the fringe to be pushed inward. 
Since the fringe is v
 `visual-fill-column-center-text`: if set to `t`, centre the text area in the 
window. By default, the text is displayed at the window’s (left) edge, 
mimicking the effect of `fill-column`.
 
 `visual-fill-column-disable-fringe`: if set to `t`, the left fringe is 
disabled. Note that if `visual-fill-column-center-text` is set to `t`, both the 
left and right fringes are disabled.
+
+All three options are buffer-local, so the values you set through Customize 
are default values. They can also be set in mode hooks of directory or file 
local variables in order to customise particular files or file types.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]