branch: externals/cm-mode
commit b95dca29176b1ea726d681fef84f718001ce0193
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Update README with key binding C-c * a and a section on font lock.
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 9f45d1c6af..9045fda198 100644
--- a/README.md
+++ b/README.md
@@ -23,11 +23,17 @@ Activating `cm-mode` provides key{--s--} {++bindings++}to
insert the {~~patterns
The commands to delete, substitute and highlight text all operate on the
region. The commands for inserting and substituting text and for inserting a
comment {{(which includes the command to highlight text)}}{>>really!<<} all put
the cursor at the correct position, so you can start typing right away.
+
+## Font lock ##
+
`cm-mode` also adds the markup patterns defined by CriticMarkup to
`font-lock-keywords` and provides customisable faces to highlight them. The
customisation group is called `criticmarkup`.
+You may notice that changes that span multiple lines are not highlighted. The
reason for this is that multiline font lock in Emacs is not straightforward.
There are ways to deal with this, but since `cm-mode` is a minor mode, it could
interfere with the major mode's font locking mechanism if it did that.
+
+To mitigate this problem, you can use soft wrap (with `visual-line-mode`).
Since each paragraph is then essentially a single line, font lock works even
across multiple (visual) lines.
+
-TODO:
+## TODO ##
-- Commands to accept or reject the change at point (`C-c * a` and `C-c * r`)
- Command to accept or reject all changes interactively (`C-c * A`)
- Mouse support
