branch: elpa/treeview
commit 09c8c1d045c7c8eace61b10b6df9d2f9079de78e
Author: Tilman Rassy <tilman.ra...@googlemail.com>
Commit: Tilman Rassy <tilman.ra...@googlemail.com>
Additions to documentation
---
README.md | 15 +++++++++++++--
treeview.el | 6 +++++-
2 files changed, 18 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index c18ac88665..14bf76310a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
-# emacs-treeview
+emacs-treeview
+==============
+
Abstract Emacs Lisp framework for tree navigation. Based on this framework,
specific libraries for particular
hierarchical data can be implemented, for example, file systems.
+This document describes v1.1.0 of emacs-treeview. Consider [this
notes](#updating-from-v100) for upgrading from v1.0.0.
+
A typical tree could look like the following:
<pre>
@@ -92,7 +96,14 @@ variables:
* treeview-get-icon-mouse-face-function
* treeview-suggest-point-pos-in-control-function
-A description of each variable can be found in the repsetive documentation
strings. All
+A description of each variable can be found in the respective documentation
strings. All
variables are buffer-local. Libraries using this framework should create a
new buffer and
set the variables to particular functions in that buffer. Then, the root node
should be
created and rendered in the buffer by a call to treeview-display-node.
+
+
+### Updating from v1.0.0
+
+Note that v1.1.0 defines another buffer-local function variable
+`treeview-get-root-node-function` which didn't exist in v1.0.0. It must be set
to a
+function which returns the root node of the tree.
diff --git a/treeview.el b/treeview.el
index beeaedc528..52ed5ae0fc 100644
--- a/treeview.el
+++ b/treeview.el
@@ -140,6 +140,10 @@
;; created and rendered in the buffer by a call to treeview-display-node.
;;
;; See library "dir-treeview" for an example where this framework is used.
+;;
+;; If you upgrade from v1.0.0: Note that v1.1.0 (this version) defines another
buffer-local
+;; function variable treeview-get-root-node-function which didn't exist in
v1.0.0. It must be
+;; set to a function which returns the root node of the tree.
;;; Code:
@@ -639,7 +643,7 @@ node exists, return nil."
(defun treeview-make-node-component-overlay (node content &optional keymap
face mouse-face)
"Create an overlay representing a specific component of a node.
-This function is used to create the imdemtation, control, icon, and label
+This function is used to create the indentation, control, icon, and label
overlays of nodes. NODE is the node to which the overlay belongs. The
`treeview-node' property of the overlay is set to NODE. CONTENT is a string.
It is inserted as the content of the overlay. If non-nil, KEYMAP, FACE, and
