[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/visual-fill-column 0044394939 054/137: Make some changes t
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/visual-fill-column 0044394939 054/137: Make some changes to the README.md |
Date: |
Sun, 2 Jan 2022 22:59:11 -0500 (EST) |
branch: elpa/visual-fill-column
commit 00443949394217cdaf57fa41d739d277f77b6869
Author: Joost Kremers <joostkremers@fastmail.fm>
Commit: Joost Kremers <joostkremers@fastmail.fm>
Make some changes to the README.md
---
README.md | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index f05978c794..289716ccf5 100644
--- a/README.md
+++ b/README.md
@@ -5,26 +5,30 @@
## 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 ##
-`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)
+
+Note that `visual-fill-column-mode` is not tied to `visual-line-mode`: it is
perfectly possible to use it on its own. 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` 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 by
setting the variable `fringes-outside-margins` to `t`. You can set this option
to `nil' if you prefer to have the fringes close to the text.
-Note that 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 [...]
+Note that 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 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`:
- [nongnu] elpa/visual-fill-column c1f6accd9e 121/137: Update version number to 2.3, (continued)
- [nongnu] elpa/visual-fill-column c1f6accd9e 121/137: Update version number to 2.3, ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column ceb2c74827 133/137: Update the README., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column 84638e9ff4 130/137: Add a note about writeroom-mode to the README., ELPA Syncer, 2022/01/02
- [nongnu] elpa/visual-fill-column bd78372bd3 131/137: Fix link to writeroom-mode., ELPA Syncer, 2022/01/02
- [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 <=
- [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, 2022/01/02
- [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