Re: [gnugo-devel] gnugo-db.el updated

[Paul Pogonyshev]

Dan wrote:
> > If you still don't use the file, here is an ad ;)
> >
> > Full list of features:
> >
> > - highlighting of keywords and comments;
> >
> > - paragraphs are equal to patterns;
> >
> > - commands for pattern creation with automatic name selection (C-c
> >   C-p) and copying main diagram to constraint diagram (C-c C-c);
> >
> > - automatic indentation of constraints and side comments.
>
> How about putting this blurb and a word or two somewhere in doc/*texi?

Is this patch ok?

Paul


--- patterns.texi.~1.16.~       2003-07-11 23:26:00.000000000 +0000
+++ patterns.texi       2003-11-18 22:46:20.000000000 +0000
@@ -13,10 +13,11 @@
 * PM Implementation::             Implementation.
 * Symmetry & transformations::    Symmetry and transformations.
 * Details::                       Details of implementation.
-* grid optimization::             The ``grid'' optimization.
+* Grid optimization::             The ``grid'' optimization.
 * Joseki Compiler::               The joseki compiler.
 * Ladders in Joseki::             Example: ladders in joseki.
 * Corner Matcher::                A special matcher for joseki patterns.
+* Editing Patterns::              Emacs major mode for pattern files.
 @end menu
 
 @node Patterns Overview
@@ -1520,7 +1521,7 @@ bit 0 is not set.
 
 @end enumerate
 
address@hidden grid optimization
address@hidden Grid optimization
 @section The ``Grid'' Optimization
 
 The comparisons between pattern and board are performed as 2-bit
@@ -1877,3 +1878,47 @@ Tree-like database for corner matcher is
 Database generator consists of several functions, most important are:
 @code{corner_best_element()}, @code{corner_variation_new()},
 @code{corner_follow_variation()} and @code{corner_add_pattern()}.
+
address@hidden Editing Patterns
address@hidden Emacs Mode for Editing Patterns
+
address@hidden editing patterns
address@hidden editing pattern database
+
+If you use GNU Emacs (XEmacs might work too), you can try a special
+mode for editing GNU Go pattern databases.  The mode resides in
address@hidden/gnugo-db.el}.
+
+Copy the file to @file{emacs/site-lisp} directory.  You can then load
+the mode with @code{(require 'gnugo-db)}.  It makes sense to put this
+line into your configuration file (@file{~/.emacs}).  You can either
+use @command{gnugo-db-mode} command to switch to pattern editing mode,
+or use the following code snippet to make Emacs do this automatically
+upon opening a file with @file{.db} suffix:
+
address@hidden
+       (setq auto-mode-alist
+             (append
+              auto-mode-alist
+              '(("\\.db\\'" . gnugo-db-mode))))
address@hidden example
+
+Pattern editing mode provides the following features:
+
address@hidden @minus
address@hidden
+highlighting of keywords (@code{Pattern}, @code{goal_elements} and
address@hidden) and comments,
+
address@hidden
+making paragraphs equal to patterns (@kbd{M-h}, @address@hidden, 
@address@hidden
+and others operate on patterns),
+
address@hidden
+commands for pattern creation with automatic name selection (@kbd{C-c
+C-p}) and copying main diagram to constraint diagram (@kbd{C-c C-c}),
+
address@hidden
+automated indentation of constraints and side comments (pattern
+descriptions).
address@hidden itemize