[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/annotate 7893fb3060 261/372: - updated README.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/annotate 7893fb3060 261/372: - updated README. |
Date: |
Fri, 4 Feb 2022 16:59:05 -0500 (EST) |
branch: elpa/annotate
commit 7893fb3060dd644b7588125df3d78c548bc7d128
Author: cage <cage-invalid@invalid>
Commit: cage <cage-invalid@invalid>
- updated README.
- increased version.
---
README.org | 42 +++++++++++++++++++++++++++++++++++++++++-
annotate.el | 4 ++--
2 files changed, 43 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index 6657e2a419..615ede331d 100644
--- a/README.org
+++ b/README.org
@@ -109,6 +109,46 @@ as comments into the current buffer, like this:
- ~annotate-integrate-highlight~
- ~annotate-fallback-comment~
+* Alternative visualization of annotations
+
+For typographically difficult scenarios (or just because you prefer
+it), such as variable-width fonts or overlay-heavy modes, the default
+visualization system that renders the annotation into the buffer could
+not properly works.
+
+In this case the users can switch to a "pop-up" style annotation
+setting to a non-nil value the variable ~annotate-use-echo-area~.
+
+When such variable's value is not null, moving the mouse pointer over
+the annotated text will temporary show the annotation.
+
+The actual visuals of this "pop-up" can be different depending of your
+system's setup (see
+[[https://github.com/bastibe/annotate.el/pull/81][this pull request]]
+for a couple of examples.
+
+Another alternative way to show annotations is provided by the command:
+~annotate-summary-of-file-from-current-pos~.
+
+Calling this command will show a summary window that prints all the
+annotations related to annotated text that appears (in the active
+buffer) beyond the current cursor position.
+
+**** related customizable variable
+ - ~annotate-use-echo-area~
+
+* Other commands
+
+** annotate-switch-db
+
+This command will ask the user for a new annotation database files,
+load it and refresh all the annotations contained in each buffer where
+annotate minor mode is active.
+
+See the docstring for more information and
+[[https://github.com/bastibe/annotate.el/issues/68][this thread]]
+for a possible workflow where this command could be useful.
+
* More documentation
Please check ~M-x customize-group RET annotate~ as there is
@@ -125,7 +165,7 @@ as comments into the current buffer, like this:
- Because of a limitation in the Emacs display routines
~scroll-down-line~ could get stuck on a annotated line. So no fix
- can be provided by the autors of ~annotate.el~, a possible
+ can be provided by the authors of ~annotate.el~, a possible
workaround is to call the command with a numeric prefix equals to
one plus the number of annotation text lines below the annotated
text.
diff --git a/annotate.el b/annotate.el
index 83fbd87d71..17ac590901 100644
--- a/annotate.el
+++ b/annotate.el
@@ -7,7 +7,7 @@
;; Maintainer: Bastian Bechtold
;; URL: https://github.com/bastibe/annotate.el
;; Created: 2015-06-10
-;; Version: 0.8.3
+;; Version: 0.9.0
;; This file is NOT part of GNU Emacs.
@@ -58,7 +58,7 @@
;;;###autoload
(defgroup annotate nil
"Annotate files without changing them."
- :version "0.8.3"
+ :version "0.9.0"
:group 'text)
;;;###autoload
- [nongnu] elpa/annotate 4972c555c6 171/372: - fixed version number., (continued)
- [nongnu] elpa/annotate 4972c555c6 171/372: - fixed version number., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 004aea92ea 179/372: - updated documentation;, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 490a935b18 186/372: Merge branch 'master' into org-mode-fix, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 947e93a067 204/372: Merge branch 'master' into org-mode-fix, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate df704cc033 205/372: Merge branch 'master' into rethink-multiline-annotations, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 9a9227f154 208/372: - changed function names:, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 6cc6ac8872 210/372: Merge pull request #61 from cage2/org-mode-fix, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 754db391fd 230/372: - updated section 'known bugs' of README., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 553116dc61 239/372: - added missing unquote in macro 'annotate-with-restore-modified-bit'., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 5fd0923df1 232/372: Merge pull request #71 from cage2/master, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 7893fb3060 261/372: - updated README.,
ELPA Syncer <=
- [nongnu] elpa/annotate c103381862 280/372: - moved 'save-match-data' from the function that calls, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 3b871f10f9 290/372: - prevented side effects of 'split-string', ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate f3ace011a2 286/372: - changed customizable variable related to exporting., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate d4eff870d9 292/372: Merge pull request #93 from cage2/master, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 58525eb73a 307/372: - changed function calls from 'cl' package to the 'cl-lib' equivalents., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 4abf492f05 297/372: - updated NEWS and CHANGELOG;, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate faa9245414 329/372: - increased version number and updated documentations., ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 7eee85f7f9 070/372: - made the character under the annotated text (when exporting or integrating), ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 6d74f53074 015/372: improve documentation and add license, ELPA Syncer, 2022/02/04
- [nongnu] elpa/annotate 6b4b2b69d7 023/372: can now annotate long lines, ELPA Syncer, 2022/02/04