branch: externals/cm-mode
commit 3b44c2ca71484bcb5b1a4ef29bd9b7dd79b5f70b
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Update README.
---
README.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 6e15fed6f7..eff2217007 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ The commands for adding and deleting text combine
additions/deletions that are a
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 ##
`cm-mode` also provides a simple 'follow changes' mode. When activated,
changes you make to the buffer are automatically marked as insertions or
deletions. Substitutions cannot be made automatically (that is, if you mark a
word, delete it and then type a replacement, it will still be marked as a
sequence of deletion+insertion, not as a substitution), but they can still be
made manually with `C-c * s`. You can activate and deactivate follow changes
mode with `C-c * F`. When it's active, t [...]
@@ -30,14 +31,15 @@ Note: the [CriticMarkup
spec](http://criticmarkup.com/spec.php) says you should
## 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, 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.
+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`. 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:/ [...]
+The variable `cm-author` can be set 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://johnmacfar [...]
-If `cm-author` is set, a new addition or deletion that is adjacent to an
existing one is not combined with it if it has a different author tag. This way
you can add changes to a text that already has changes from another author and
still keep track of who did what. Note that this *only* works for changes that
have a comment with an author tag. If the existing addition/deletion does not
have an author tag, any addition/deletion made adjacent to it is simply
combined with it.
+If `cm-author` is set, a new addition or deletion that is adjacent to an
existing one is not combined with it if it has a different author tag. This way
you can add changes to a text that already has changes from another author and
still keep track of who did what. This *only* works for changes that have a
comment with an author tag, however. If the existing addition/deletion does not
have an author tag, any addition/deletion made adjacent to it is simply
combined with it.
Note that the modeline shows the buffer's author tag: if `cm-author` is set,
the lighter for `cm-mode` takes the form `cm@<tag>`.
+
## Navigating changes ##
You can jump to the previous/next change with the commands `C-c * b` and `C-c
* f`, respectively. If point is inside a change, you can jump out of it with
`C-c * *`.
@@ -49,7 +51,7 @@ You can interactively accept or reject a change by putting
the cursor inside it
For comments and highlights, the choices are different: `d` to delete the
comment or highlight (whereby the latter of course retains the highlighted
text, but the comment and the markup are removed), or `k` to keep the comment
or highlight. Again `q` quits and is essentially identical to `k`. (Note that
you can also use `s` instead of `k`, in case you get used to skipping changes
that way.)
-You can interactively accept or reject all changes with `C-c * I` (that is a
capital `i`). This will go through each change asking you whether you want to
accept, reject or skip it, or delete or keep it. Typing `q` quits the
accept/reject session.
+You can interactively accept or reject all changes with `C-c * I` (that is a
capital `i`). This will go through each change asking you what you want to do
with it. Here, `s` skips the current change and moves on to the next one, while
typing `q` leaves the current change alone and quits the accept/reject session.
## Font lock ##
