branch: externals/cm-mode
commit 4d3ed3707d2e601eabf09d5603ed62e6cd52163c
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Update to the README.
---
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 493a8925a4..80231c1e40 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ CriticMarkup is a way for authors and editors to track
changes to documents in p
- Comment {>> <<}
- Highlight {{ }}{>> <<}
-Activating `cm-mode` provides key{--s--} {++bindings ++}to insert these
{~~patterns~>markup codes~~} above and thus mark one's changes to the text. The
provided {{key bindings}}{>>Should you mention that these are nicely
mnemonic?<<} are:
+Activating `cm-mode` provides key{--s--} {++bindings ++}to insert these
{~~patterns~>markup tags~~} above and thus mark one's changes to the text. The
provided {{key bindings}}{>>Should you mention that these are nicely
mnemonic?<<} are:
- `C-c * a`: add text
- `C-c * d`: delete text
@@ -19,6 +19,7 @@ Activating `cm-mode` provides key{--s--} {++bindings ++}to
insert these {~~patte
The commands to delete or substitute text operate on the region. The command
to insert a comment can be used with an active region, in which case the text
in the region will be highlighted. It can also be used inside an existing
markup to add a comment to it. If it is used anywhere else, it just adds a lone
comment. The commands for inserting and substituting text and for inserting a
comment {++all ++}put {~~the cursor~>point~~} at the correct position, so you
can start typing right away.
+Note: the [CriticMarkup spec](http://criticmarkup.com/spec.php) says you
should avoid putting newlines in CriticMarkup tags and you should always wrap
Markdown tags completely. These are wise precautions for `cm-mode` as well.
## Follow changes mode ##
@@ -27,7 +28,7 @@ The commands to delete or substitute text operate on the
region. The command to
## Keeping track of the author ##
-Comments can be used to keep track of who made a particular change. If you
want to do this automatically, you can set the variable `cm-author` to an
identifier. When this variable is set, its value is automatically added as a
comment to every change you make. If you explicitly make a comment with `C-c *
c`, the value of `cm-author` is inserted at the beginning of the comment,
followed by `:: ` (double colon space).
+Comments can be used to keep track of who made a particular change. If you
want to do this automatically, you can set the variable `cm-author` to an
identifier. When this variable is set, its value is automatically added as a
comment to every change you make, preceded by `@` (). If you explicitly make a
comment with `C-c * c`, the value of `cm-author` is inserted at the beginning
of the comment.
The variable `cm-author` can be set globally through Customize (or with
`setq-default` in your init file). This sets the global value. You can override
this global value in a particular buffer by setting a buffer-local value. There
are two ways to do this: you can use `C-c * C`, which will only set the value
for the current session, or you can use a file-local (or directory-local)
variable, which makes sure the value is set every time the file is loaded.
(Note: if you use [Pandoc](http:/ [...]
