[mcclim-cvs] CVS mcclim/Doc

[thenriksen]

Update of /project/mcclim/cvsroot/mcclim/Doc
In directory clnet:/tmp/cvs-serv7960/Doc

Modified Files:
	drei.texi 
Log Message:
Added mention of new Drei functions to the documentation.


--- /project/mcclim/cvsroot/mcclim/Doc/drei.texi	2007/08/20 17:52:44	1.8
+++ /project/mcclim/cvsroot/mcclim/Doc/drei.texi	2007/11/19 20:38:10	1.9
@@ -75,52 +75,35 @@
 malfunction.
 
 @menu
-* Special Variables::           
+* Special Variables::
+* Access Functions::
 @end menu
 
 @node Special Variables
 @subsection Special Variables
 
-Drei commands are meant to work by using the values of a number of
-special variables bound by Drei during its pseudo command loop.  Here is
-a list of them:
-
- at defvar *current-window*
- at vindex *current-window*
-Somewhat counter-intuitively, the Drei instance. Not necessarily the
-same as the editor pane.
- at end defvar
- at defvar *current-buffer*
- at vindex *current-buffer*
-The buffer of the Drei instance the command is being executed for.
- at end defvar
- at defvar *current-mark*
- at vindex *current-mark*
-The mark of the Drei instance.
- at end defvar
- at defvar *current-point*
- at vindex *current-point*
-The point of the Drei instance.
- at end defvar
- at defvar *current-syntax*
- at vindex *current-syntax*
-The syntax of @cl{*current-buffer*}.
- at end defvar
- at defvar *kill-ring*
- at vindex *kill-ring*
-The kill-ring object of the Drei instance.
- at end defvar
- at defvar *minibuffer*
- at vindex *minibuffer*
-The minibuffer of the Drei instance, which is where commands should
-print information and other interesting things (using
- at cl{display-message} or @cl{with-minibuffer-stream}). This may be
- at cl{NIL} if no minibuffer is associated with the Drei instance.
- at end defvar
- at defvar *previous-command*
- at vindex *previous-command*
-The previous CLIM command that was executed by the Drei instance.
- at end defvar
+Drei uses a number of special variables to provide access to data
+structures. These are described below.
+
+ at include var-drei-star-drei-instance-star.texi
+ at include var-drei-kill-ring-star-kill-ring-star.texi
+
+Additionally, a number of ESA special variables are used in Drei.
+
+ at include var-esa-star-minibuffer-star.texi
+ at include var-esa-star-previous-command-star.texi
+
+ at node Access Functions
+ at subsection Access Functions
+
+The special variables essentially provide all that is needed to access
+all parts of the Drei state, but for convenience, a number of utility
+functions providing access to commonly used objects have been defined.
+
+ at include fun-esa-current-buffer.texi
+ at include fun-drei-point.texi
+ at include fun-drei-mark.texi
+ at include fun-drei-current-syntax.texi
 
 @node External API
 @section External API
@@ -1189,13 +1172,12 @@
 (define-command (com-repeat-word :name t
                                  :command-table editing-table)
     ()
-  (let ((mark (clone-mark *current-point*)))
-    (backward-word mark *current-syntax* 1)
-    (insert-sequence mark (region-to-sequence mark *current-point*))))
+  (let ((mark (clone-mark (point)))
+    (backward-word mark (current-syntax 1)
+    (insert-sequence mark (region-to-sequence mark (point))))
 @end lisp
 
-For @cl{*current-point*} and @cl{*current-syntax*}, see @ref{Special
-Variables}.
+For @cl{(point)} and @cl{(current-syntax)}, see @ref{Access Functions}.
 
 This command facilitates the single repeat of a word, but that's
 it. This is not very useful - instead, we would like a command that
@@ -1208,9 +1190,9 @@
 (define-command (com-repeat-word :name t
                                  :command-table editing-table)
     ((count 'integer :prompt "Number of repeats"))
-  (let ((mark (clone-mark *current-point*)))
-    (backward-word mark *current-syntax* 1)
-    (let ((word (region-to-sequence mark *current-point*)))
+  (let ((mark (clone-mark (point)))
+    (backward-word mark (current-syntax 1)
+    (let ((word (region-to-sequence mark (point)))
       (dotimes (i count)
         (insert-sequence mark word)))))
 @end lisp