[elpa] externals/bnf-mode 3f8062e 01/36: Amended documentation

[Stefan Monnier]

branch: externals/bnf-mode
commit 3f8062e36797d98282893836c5caff8c0723c71f
Author: Serghei Iakovlev <egrep@protonmail.ch>
Commit: Serghei Iakovlev <egrep@protonmail.ch>

    Amended documentation
---
 bnf-mode.el   |  6 ++--
 bnf-mode.info | 94 ++++++++++++++++++++++++++++-------------------------------
 bnf-mode.texi | 60 ++++++++++++++++++++++----------------
 3 files changed, 83 insertions(+), 77 deletions(-)

diff --git a/bnf-mode.el b/bnf-mode.el
index feb00fa..f9e3a6a 100644
--- a/bnf-mode.el
+++ b/bnf-mode.el
@@ -63,8 +63,8 @@ following \"comment\" conventions will hold:
   | begin comment <any sequence not containing ;>; | begin            |
   :------------------------------------------------:------------------:
 
-Note: Enabling this feature will disable comments recognition which use
-semicolon only (\";\")."
+Note: enabling this feature will disable comments recognition, which
+start with semicolons only (\";\")."
   :type 'boolean)
 
 
@@ -189,7 +189,7 @@ See `rx' documentation for more information about REGEXPS 
param."
    ("\\(?:begin\\s-+\\|;\\s-*\\)\\(comment\\)\\(;\\|\\s-+[^;]*;\\)" (1 "<")))
   "Apply syntax table properties to special constructs.
 Provide a macro to apply syntax table properties to comments in ALGOL 60
-style.  Will be used only if `bnf-mode-algol-comments-style' is set to t")
+style.  Will be used only if `bnf-mode-algol-comments-style' is set to t.")
 
 
 ;;; Initialization
diff --git a/bnf-mode.info b/bnf-mode.info
index 7a2ec14..1ef1be8 100644
--- a/bnf-mode.info
+++ b/bnf-mode.info
@@ -1,7 +1,14 @@
 This is bnf-mode.info, produced by makeinfo version 6.5 from
 bnf-mode.texi.
 
-     Copyright © 2019, 2020 Free Software Foundation, Inc.
+BNF Mode is a GNU Emacs major mode for editing BNF grammars.  Currently
+this mode provides basic syntax and font-locking for BNF files.  BNF
+notation is supported exactly form as it was first announced in the
+ALGOL 60 report.
+
+This manual is for BNF Mode version 0.4.4.
+
+   Copyright © 2019, 2020 Free Software Foundation, Inc.
 
      You can redistribute this document and/or modify it under the terms
      of the GNU General Public License as published by the Free Software
@@ -23,25 +30,6 @@ File: bnf-mode.info,  Node: Top,  Next: Introduction,  Up: 
(dir)
 BNF Mode User Manual
 ********************
 
-BNF Mode is a GNU Emacs major mode for editing BNF grammars.  Currently
-this mode provides basic syntax and font-locking for BNF files.  BNF
-notation is supported exactly form as it was first announced in the
-ALGOL 60 report.
-
-This manual is for BNF Mode version 0.4.4.
-
-     Copyright © 2019, 2020 Free Software Foundation, Inc.
-
-     You can redistribute this document and/or modify it under the terms
-     of the GNU General Public License as published by the Free Software
-     Foundation, either version 3 of the License, or (at your option)
-     any later version.
-
-     This document is distributed in the hope that it will be useful,
-     but WITHOUT ANY WARRANTY; without even the implied warranty of
-     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
-
 * Menu:
 
 * Introduction::     The mode description and concepts.
@@ -112,22 +100,20 @@ yourself with it by reading the documentation in the 
Emacs manual, see
    • To use Elpa:
 
      (require 'package)
-     (add-to-list 'package-archives
-                  '("gnu" . "https://elpa.gnu.org/packages/";) t)
      (package-initialize)
 
    • For those who want only formal, tagged releases use Melpa Stable:
 
      (require 'package)
      (add-to-list 'package-archives
-                  '("melpa-stable" . "http://stable.melpa.org/packages/";) t)
+                  '("melpa-stable" . "https://stable.melpa.org/packages/";) t)
      (package-initialize)
 
    • For those who want rolling releases as they happen use Melpa:
 
      (require 'package)
      (add-to-list 'package-archives
-                  '("melpa" . "http://melpa.org/packages/";) t)
+                  '("melpa" . "https://melpa.org/packages/";) t)
      (package-initialize)
 
    Melpa tracks BNF Mode’s Git repository and updates relatively soon
@@ -229,24 +215,34 @@ File: bnf-mode.info,  Node: Customizing,  Next: Project 
Links,  Prev: Usage,  Up
 4 Customizing
 *************
 
-There are not so much customize options yet.  The most interested option
-is ‘bnf-mode-algol-comments-style’.  Setting it to non-nil means use for
-BNF comments style introduced in ALGOL 60.  The following "comment"
-conventions will hold:
+There are not so much customization options yet.  The most interested
+option is ‘bnf-mode-algol-comments-style’.  This variable can be changed
+to control comments style used in grammars.  Setting it to non-nil means
+use for BNF comments style introduced in ALGOL 60.  In this case the
+following "comment" conventions will hold:
 
 The sequence of basic symbols                      Is equivalent to
 --------------------------------------------------------------------------
 ‘; comment <any sequence not containing ;>;’       ‘;’
 ‘begin comment <any sequence not containing ;>;’   ‘begin’
 
+   Note: enabling this feature will disable comments recognition, which
+start with semicolons only (‘;’).
 
-   Enabling this feature will disable comments recognition which use
-semicolon only (‘;’).
-
+   To customize ‘abbrev-mode’ for ‘bnf-mode’, simple add a hook to
+‘bnf-mode-hook’.  The code may looks as follows:
 
-   To customize BNF Mode options, use command as follows:
+     (add-hook 'bnf-mode-hook
+         '(lambda () (define-abbrev
+                       bnf-mode-abbrev-table
+                       "lng" "language")))
 
-     M-x customize-group bnf RET
+   If you want, you can go without any customizations at all.  The above
+settings are the most bang for the buck in terms of customization.  So
+users that typically don’t like customize a lot are advised to look at
+these settings first.  To customize BNF Mode options using textual GUI
+system, use the following command: ‘M-x’ ‘customize-group’ ‘RET’ ‘bnf’
+‘RET’.
 
 
 File: bnf-mode.info,  Node: Project Links,  Next: Bibliography,  Prev: 
Customizing,  Up: Top
@@ -332,13 +328,13 @@ Index
 * Menu:
 
 * Cask, installation:                    Installing from Elpa or Melpa.
-                                                               (line 52)
+                                                               (line 50)
 * Customizing:                           Customizing.          (line  6)
 * Elpa, installation:                    Installing from Elpa or Melpa.
                                                                (line 12)
 * Installation:                          Installation.         (line  6)
 * Melpa, installation:                   Installing from Elpa or Melpa.
-                                                               (line 19)
+                                                               (line 17)
 
 
 File: bnf-mode.info,  Node: Variable Index,  Prev: Index,  Up: Top
@@ -354,20 +350,20 @@ Variable Index
 
 
 Tag Table:
-Node: Top767
-Node: Introduction2295
-Node: Installation2640
-Node: Installing from Elpa or Melpa3162
-Node: Installing using El-get5478
-Node: Installing from the Git Repository6157
-Node: Usage7058
-Node: Customizing7343
-Node: Project Links8168
-Node: Bugs Tracker8339
-Node: Change Log8572
-Node: Bibliography8821
-Node: Index9979
-Node: Variable Index10686
+Node: Top1036
+Node: Introduction1735
+Node: Installation2080
+Node: Installing from Elpa or Melpa2602
+Node: Installing using El-get4819
+Node: Installing from the Git Repository5498
+Node: Usage6399
+Node: Customizing6684
+Node: Project Links8160
+Node: Bugs Tracker8331
+Node: Change Log8564
+Node: Bibliography8813
+Node: Index9971
+Node: Variable Index10678
 
 End Tag Table
 
diff --git a/bnf-mode.texi b/bnf-mode.texi
index e4a10a4..ab1f2b8 100644
--- a/bnf-mode.texi
+++ b/bnf-mode.texi
@@ -8,9 +8,19 @@
 @c %**end of header
 
 @copying
-@quotation
+@ifnottex
+BNF Mode is a GNU Emacs major mode for editing BNF grammars.
+Currently this mode provides basic syntax and font-locking for BNF
+files.  BNF notation is supported exactly form as it was first
+announced in the ALGOL 60 report.
+
+@noindent
+This manual is for BNF Mode version 0.4.4.
+@end ifnottex
+
 Copyright @copyright{} 2019, 2020 Free Software Foundation, Inc.
 
+@quotation
 You can redistribute this document and/or modify it under the terms of
 the GNU General Public License as published by the Free Software
 Foundation, either version 3 of the License, or (at your option) any
@@ -43,16 +53,6 @@ General Public License for more details.
 @ifnottex
 @node Top
 @top BNF Mode User Manual
-
-BNF Mode is a GNU Emacs major mode for editing BNF grammars.
-Currently this mode provides basic syntax and font-locking for BNF
-files.  BNF notation is supported exactly form as it was first
-announced in the ALGOL 60 report.
-
-@noindent
-This manual is for BNF Mode version 0.4.4.
-
-@insertcopying
 @end ifnottex
 
 @menu
@@ -126,8 +126,6 @@ To use Elpa:
 
 @lisp
 (require 'package)
-(add-to-list 'package-archives
-             '("gnu" . "https://elpa.gnu.org/packages/";) t)
 (package-initialize)
 @end lisp
 
@@ -140,7 +138,7 @@ For those who want only formal, tagged releases use Melpa 
Stable:
 @lisp
 (require 'package)
 (add-to-list 'package-archives
-             '("melpa-stable" . "http://stable.melpa.org/packages/";) t)
+             '("melpa-stable" . "https://stable.melpa.org/packages/";) t)
 (package-initialize)
 @end lisp
 
@@ -152,7 +150,7 @@ For those who want rolling releases as they happen use 
Melpa:
 @lisp
 (require 'package)
 (add-to-list 'package-archives
-             '("melpa" . "http://melpa.org/packages/";) t)
+             '("melpa" . "https://melpa.org/packages/";) t)
 (package-initialize)
 @end lisp
 
@@ -273,10 +271,11 @@ current buffer use @kbd{M-x} @code{bnf-mode} @kbd{RET}.
 @cindex Customizing
 @vindex bnf-mode-algol-comments-style
 
-There are not so much customize options yet.  The most interested
-option is @code{bnf-mode-algol-comments-style}.  Setting it to non-nil
-means use for BNF comments style introduced in ALGOL 60.  The
-following "comment" conventions will hold:
+There are not so much customization options yet.  The most interested
+option is @code{bnf-mode-algol-comments-style}.  This variable can be
+changed to control comments style used in grammars.  Setting it to
+non-nil means use for BNF comments style introduced in ALGOL 60.  In
+this case the following "comment" conventions will hold:
 
 @multitable @columnfractions .7 .3
 @headitem The sequence of basic symbols @tab Is equivalent to
@@ -286,14 +285,25 @@ following "comment" conventions will hold:
 @tab @code{begin}
 @end multitable
 
-@*Enabling this feature will disable comments recognition which use
-semicolon only (@code{;}).
+Note: enabling this feature will disable comments recognition, which
+start with semicolons only (@code{;}).
 
-@*To customize BNF Mode options, use command as follows:
+To customize @code{abbrev-mode} for @code{bnf-mode}, simple add a hook
+to @code{bnf-mode-hook}.  The code may looks as follows:
 
-@example
-M-x customize-group bnf RET
-@end example
+@lisp
+(add-hook 'bnf-mode-hook
+         '(lambda () (define-abbrev
+                       bnf-mode-abbrev-table
+                       "lng" "language")))
+@end lisp
+
+If you want, you can go without any customizations at all. The above
+settings are the most bang for the buck in terms of customization.  So
+users that typically don't like customize a lot are advised to look at
+these settings first.  To customize BNF Mode options using textual GUI
+system, use the following command: @kbd{M-x} @code{customize-group}
+@kbd{RET} @code{bnf} @kbd{RET}.
 
 @node Project Links
 @chapter Project Links