[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.
- [nongnu] elpa/visual-fill-column a2657f20f6 128/137: Add note about centring text., (continued)
- [nongnu] elpa/visual-fill-column a2657f20f6 128/137: Add note about centring text., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column a44fe8d78c 135/137: Point URL header to Codeberg., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 2df643827a 134/137: Add adaptive-wrap screen shots., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column dde0aa6535 061/137: Update README, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 5f5928fd7f 045/137: Merge pull request #19 from cpitclaudel/master, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 34ce0d22da 072/137: Guard against non-existing mouse events, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 0044394939 054/137: Make some changes to the README.md, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 982606896e 077/137: Change :group parameter of defgroup to `text`., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column d97017e9bc 058/137: Use correct option `visual-fill-column-fringes-outside-margins' in README., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column d05a7e9c62 004/137: Allow `visual-fill-column-width` to be set to an integer., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column b63174ec24 006/137: Update README,
ELPA Syncer <=
- [nongnu] elpa/visual-fill-column d3ebba9e60 009/137: Update version number in header block., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 7bf332089a 012/137: Fix typo., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 261e27c062 024/137: Update version number to 1.5, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 043485d16a 026/137: Rename ::window-body-width to ::window-max-text-width, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 96ac324638 031/137: Remove spurious empty line., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 4329831dd0 030/137: Add alternative function for `split-window-preferred-function'., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 9cae9dbfd9 041/137: Set window-parameter `split-window' only in Emacs 25 and up., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 98438fa2b8 048/137: Update version number., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 57c2a72d46 053/137: Merge pull request #26 from sten0/master, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 8d1326de10 090/137: Update the README., ELPA Syncer, 2022/01/02