branch: externals/cm-mode
commit 64913b0107a5ccf3ba4a3569ee03c020c45a3566
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Add note about cm-read-only-annotations to README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 6beef27d87..ccb60f52a0 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ Note: the [CriticMarkup
spec](http://criticmarkup.com/spec.php) says you should
## Font lock ##
-`cm-mode` also adds the markup tags defined by CriticMarkup to
`font-lock-keywords` and provides customisable faces to highlight them. The
customisation group is called `criticmarkup-faces`. Note that `cm-mode` also
makes the markup tags read-only so that you cannot inadvertently modify them.
+`cm-mode` also adds the markup tags defined by CriticMarkup to
`font-lock-keywords` and provides customisable faces to highlight them. The
customisation group is called `criticmarkup-faces`. Note that `cm-mode` also
makes the markup tags read-only so that you cannot inadvertently modify them.
(Though you can disable the read-only property by setting
`cm-read-only-annotations` to `nil`.)
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. Besides,
one is advised not to include newlines inside CriticMarkup tags anyway.
