[elpa] externals/latex-table-wizard a3509e7572 60/70: Updated documentation

[ELPA Syncer]

branch: externals/latex-table-wizard
commit a3509e75724328593b0c34111983ecf86ad3b5d1
Author: Enrico Flor <enrico@eflor.net>
Commit: Enrico Flor <enrico@eflor.net>

    Updated documentation
---
 latex-table-wizard.el   |  7 ++--
 latex-table-wizard.info | 98 ++++++++++++++++++++++++++++++++++---------------
 latex-table-wizard.org  | 52 ++++++++++++++++++++------
 latex-table-wizard.texi | 68 ++++++++++++++++++++++++++++------
 4 files changed, 169 insertions(+), 56 deletions(-)

diff --git a/latex-table-wizard.el b/latex-table-wizard.el
index 84fad56f23..57dc6bbd1b 100644
--- a/latex-table-wizard.el
+++ b/latex-table-wizard.el
@@ -751,7 +751,7 @@ having CELL shifted in direction DIR (whose value is either
 \\='next\\=', \\='previous\\=', \\='forward\\=' or
 \\='backward\\=').  If no such cell is found in TABLE, return
 nil."
-  (let (target                       ; cons cell column . row
+  (let (target                          ; a cons cell of (column . row)
         output)
     (cond ((eq dir 'next)
            (setq target (cons (plist-get cell :column)
@@ -1429,8 +1429,7 @@ modifies the structure of the table (it comments out a 
delimiter
 for each cells too)."
   (interactive)
   (latex-table-wizard--setup)
-  (let* ((table (latex-table-wizard--parse-table))
-         (cells (or latex-table-wizard--selection
+  (let* ((cells (or latex-table-wizard--selection
                     (list (latex-table-wizard--get-thing 'cell))))
          (re (regexp-opt latex-table-wizard--current-col-delims))
          (fun (lambda (c ind)
@@ -1451,7 +1450,7 @@ for each cells too)."
                       (funcall fun c ind)
                     (plist-get c :end))))
         (latex-table-wizard--comment-thing start end)))
-    (message "%s cells commmented out" (length sels))))
+    (message "%s cells commented out" (length cells))))
 
 (defun latex-table-wizard-swap ()
   "Swap selection and thing at point.
diff --git a/latex-table-wizard.info b/latex-table-wizard.info
index db1db89a70..4e9a63e16c 100644
--- a/latex-table-wizard.info
+++ b/latex-table-wizard.info
@@ -15,7 +15,7 @@ LaTeX table wizard - Magic editing of LaTeX tables
 file:https://melpa.org/packages/latex-table-wizard-badge.svg
 (https://melpa.org/#/latex-table-wizard)
 
-   Copyright (C) 2022 Enrico Flor.
+   Copyright (C) 2022, 2023 Enrico Flor.
 
    Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -44,6 +44,7 @@ Available commands
 * Mark, kill and insert commands: Mark kill and insert commands.
 * Swap adjacent fields::
 * Swap arbitrary fields::
+* Comment out cells::
 * Format the table::
 * Extra commands in the transient prefix::
 
@@ -132,6 +133,7 @@ additional environments).
 * Mark, kill and insert commands: Mark kill and insert commands.
 * Swap adjacent fields::
 * Swap arbitrary fields::
+* Comment out cells::
 * Format the table::
 * Extra commands in the transient prefix::
 
@@ -190,6 +192,15 @@ movement will consist of.  By default, you can pass this 
argument from
 the transient interface of ‘latex-table-wizard’ with the key ‘u’ (bound
 to ‘universal-argument’).
 
+   These four commands also accept a second optional argument which, if
+non-nil, prevents the Do What You Mean behavior.  This is useful if you
+want to use these functions to write your own functions to edit tables.
+Given the table above, if point is on ‘A2’, both of the following
+expressions will return nil and won’t move point:
+
+     (latex-table-wizard-left 1 t)
+     (latex-table-wizard-down 1 t)
+
 
 File: latex-table-wizard.info,  Node: Absolute motion commands,  Next: Mark 
kill and insert commands,  Prev: Relative motion commands,  Up: Available 
commands
 
@@ -211,14 +222,21 @@ File: latex-table-wizard.info,  Node: Mark kill and 
insert commands,  Next: Swap
 2.4 Mark, kill and insert commands
 ==================================
 
-Command                              Default key
-------------------------------------------------------------------------------------------------
-‘latex-table-wizard-mark-cell’       ‘m c’         mark current cell
-‘latex-table-wizard-insert-column’   ‘i c’         insert empty column to the 
right
-‘latex-table-wizard-insert-row’      ‘i r’         insert row below
-‘latex-table-wizard-kill-column’     ‘k c’         add content of current 
column to kill ring
-‘latex-table-wizard-kill-row’        ‘k r’         add content of current row 
to kill ring
-‘exchange-point-and-mark’            ‘x’
+Command                                    Default key
+--------------------------------------------------------------------------------------------
+‘latex-table-wizard-mark-cell’             ‘m c’         mark current cell
+‘latex-table-wizard-insert-column’         ‘i c’         insert empty column 
to the right
+‘latex-table-wizard-insert-row’            ‘i r’         insert row below
+‘latex-table-wizard-kill-column-content’   ‘k c’         kill content of 
current column
+‘latex-table-wizard-kill-row-content’      ‘k r’         kill content of 
current row
+‘latex-table-wizard-delete-column’         ‘D c’         delete current column
+‘latex-table-wizard-delete-row’            ‘D r’         delete current row
+‘exchange-point-and-mark’                  ‘x’
+
+   ‘latex-table-wizard-delete-column’ and
+‘latex-table-wizard-delete-row’ modify the structure of the table (they
+actually remove the column/table, not just the content of the cells in
+them).
 
 
 File: latex-table-wizard.info,  Node: Swap adjacent fields,  Next: Swap 
arbitrary fields,  Prev: Mark kill and insert commands,  Up: Available commands
@@ -272,7 +290,7 @@ suitable cell to move to:
      \end{tabular}
 
 
-File: latex-table-wizard.info,  Node: Swap arbitrary fields,  Next: Format the 
table,  Prev: Swap adjacent fields,  Up: Available commands
+File: latex-table-wizard.info,  Node: Swap arbitrary fields,  Next: Comment 
out cells,  Prev: Swap adjacent fields,  Up: Available commands
 
 2.6 Swap arbitrary fields
 =========================
@@ -313,9 +331,28 @@ same column or row, the swap won’t happen 
(LaTeX-table-wizard doesn’t
 know what you want it to do in that case).
 
 
-File: latex-table-wizard.info,  Node: Format the table,  Next: Extra commands 
in the transient prefix,  Prev: Swap arbitrary fields,  Up: Available commands
+File: latex-table-wizard.info,  Node: Comment out cells,  Next: Format the 
table,  Prev: Swap arbitrary fields,  Up: Available commands
+
+2.7 Comment out cells
+=====================
+
+These two commands act on all the selected cells, if any is; otherwise,
+on the current cell point is on.
+
+Command                                    Default key   Select current...
+-------------------------------------------------------------------------------
+‘latex-table-wizard-comment-out-content’   ‘; c’         comment out content
+‘latex-table-wizard-comment-out’           ‘; ;’         comment out
+
+   The difference between the two is that one only comments out the
+content, preserving both delimiters around the cell; the other one
+actually modifies the structure of the table because for any cell that
+is commented out, one delimiter around it is commented out too.
+
+
+File: latex-table-wizard.info,  Node: Format the table,  Next: Extra commands 
in the transient prefix,  Prev: Comment out cells,  Up: Available commands
 
-2.7 Format the table
+2.8 Format the table
 ====================
 
 The only command to format the table is ‘latex-table-wizard-align’.  The
@@ -390,7 +427,7 @@ of which just performs one of these transformations.  These 
are:
 
 File: latex-table-wizard.info,  Node: Extra commands in the transient prefix,  
Prev: Format the table,  Up: Available commands
 
-2.8 Extra commands in the transient prefix
+2.9 Extra commands in the transient prefix
 ==========================================
 
 The transient interfaces invoked by ‘latex-table-wizard’ also exposes
@@ -635,23 +672,24 @@ of ‘latex-table-wizard-warn-about-detached-args’ to t.
 
 Tag Table:
 Node: Top97
-Node: Introduction1533
-Node: Available commands3674
-Node: Start editing4386
-Node: Relative motion commands4901
-Node: Absolute motion commands6437
-Node: Mark kill and insert commands7353
-Node: Swap adjacent fields8224
-Node: Swap arbitrary fields10280
-Node: Format the table12366
-Node: Extra commands in the transient prefix15056
-Node: Known issues15733
-Node: Empty cells in single-column tables15927
-Node: Customization16707
-Node: Customize transient prefix17094
-Node: Define rules for new environments17883
-Node: Customizing faces21735
-Node: Detached arguments23103
+Node: Introduction1561
+Node: Available commands3702
+Node: Start editing4436
+Node: Relative motion commands4951
+Node: Absolute motion commands6897
+Node: Mark kill and insert commands7813
+Node: Swap adjacent fields9070
+Node: Swap arbitrary fields11126
+Node: Comment out cells13213
+Node: Format the table14092
+Node: Extra commands in the transient prefix16778
+Node: Known issues17455
+Node: Empty cells in single-column tables17649
+Node: Customization18429
+Node: Customize transient prefix18816
+Node: Define rules for new environments19605
+Node: Customizing faces23457
+Node: Detached arguments24825
 
 End Tag Table
 
diff --git a/latex-table-wizard.org b/latex-table-wizard.org
index 73e67249c8..b69cf894c6 100644
--- a/latex-table-wizard.org
+++ b/latex-table-wizard.org
@@ -4,12 +4,12 @@
 #+EMAIL: enrico@eflor.net
 
 #+OPTIONS: ':t toc:t author:t email:t
-#+MACRO: version 1.0.0
+#+MACRO: version 1.3.0
 #+MACRO: updated last updated 18 December 2022
 
     
[[https://melpa.org/#/latex-table-wizard][file:https://melpa.org/packages/latex-table-wizard-badge.svg]]
 
-Copyright (C) 2022 Enrico Flor.
+Copyright (C) 2022, 2023 Enrico Flor.
 
      Permission is granted to copy, distribute and/or modify this
      document under the terms of the GNU Free Documentation License,
@@ -123,6 +123,17 @@ argument that determines how many steps (i.e. how many 
cells) the
 movement will consist of.  By default, you can pass this argument
 from the transient interface of ~latex-table-wizard~ with the key ~u~
 (bound to ~universal-argument~).
+
+These four commands also accept a second optional argument which, if
+non-nil, prevents the Do What You Mean behavior.  This is useful if
+you want to use these functions to write your own functions to edit
+tables.  Given the table above, if point is on ~A2~, both of the
+following expressions will return nil and won't move point:
+
+#+begin_src emacs-lisp
+(latex-table-wizard-left 1 t)
+(latex-table-wizard-down 1 t)
+#+end_src
 ** Absolute motion commands
 
 | Command                              | Default key | Move to...              
      |
@@ -134,14 +145,21 @@ from the transient interface of ~latex-table-wizard~ with 
the key ~u~
 | ~latex-table-wizard-bottom~            | ~N~           | bottom cell in 
current column |
 | ~latex-table-wizard-top~               | ~P~           | top cell in current 
column    |
 ** Mark, kill and insert commands
-| Command                          | Default key |                             
               |
-|----------------------------------+-------------+--------------------------------------------|
-| ~latex-table-wizard-mark-cell~     | ~m c~         | mark current cell       
                   |
-| ~latex-table-wizard-insert-column~ | ~i c~         | insert empty column to 
the right           |
-| ~latex-table-wizard-insert-row~    | ~i r~         | insert row below        
                   |
-| ~latex-table-wizard-kill-column~   | ~k c~         | add content of current 
column to kill ring |
-| ~latex-table-wizard-kill-row~      | ~k r~         | add content of current 
row to kill ring    |
-| ~exchange-point-and-mark~          | ~x~           |                         
                   |
+| Command                                | Default key |                       
           |
+|----------------------------------------+-------------+----------------------------------|
+| ~latex-table-wizard-mark-cell~           | ~m c~         | mark current cell 
               |
+| ~latex-table-wizard-insert-column~       | ~i c~         | insert empty 
column to the right |
+| ~latex-table-wizard-insert-row~          | ~i r~         | insert row below  
               |
+| ~latex-table-wizard-kill-column-content~ | ~k c~         | kill content of 
current column   |
+| ~latex-table-wizard-kill-row-content~    | ~k r~         | kill content of 
current row      |
+| ~latex-table-wizard-delete-column~       | ~D c~         | delete current 
column            |
+| ~latex-table-wizard-delete-row~          | ~D r~         | delete current 
row               |
+| ~exchange-point-and-mark~                | ~x~           |                   
               |
+
+~latex-table-wizard-delete-column~ and ~latex-table-wizard-delete-row~
+modify the structure of the table (they actually remove the
+column/table, not just the content of the cells in them).
+
 ** Swap adjacent fields
 
 | Command                              | Default key | Swap current...         
         |
@@ -236,6 +254,19 @@ corresponding portion thereof.  If you selected multiple 
cell that are
 not part of the same column or row, the swap won't happen
 (LaTeX-table-wizard doesn't know what you want it to do in that case).
 
+** Comment out cells
+These two commands act on all the selected cells, if any is;
+otherwise, on the current cell point is on.
+
+| Command                                | Default key | Select current...   |
+|----------------------------------------+-------------+---------------------|
+| ~latex-table-wizard-comment-out-content~ | ~; c~         | comment out 
content |
+| ~latex-table-wizard-comment-out~         | ~; ;~         | comment out       
  |
+
+The difference between the two is that one only comments out the
+content, preserving both delimiters around the cell; the other one
+actually modifies the structure of the table because for any cell that
+is commented out, one delimiter around it is commented out too.
 ** Format the table
 
 The only command to format the table is ~latex-table-wizard-align~.  The
@@ -330,7 +361,6 @@ useful for its usage.  These are:
 | ~universal-argument~      | ~u~           |
 | ~transient-quit-one~      | ~RET~         |
 
-
 * Known issues
 
 ** Empty cells in single-column tables
diff --git a/latex-table-wizard.texi b/latex-table-wizard.texi
index 62c6ecd726..7a062281ff 100644
--- a/latex-table-wizard.texi
+++ b/latex-table-wizard.texi
@@ -9,7 +9,7 @@
 @finalout
 @titlepage
 @title @LaTeX{} table wizard - Magic editing of @LaTeX{} tables
-@subtitle for version 1.0.0
+@subtitle for version 1.3.0
 @author Enrico Flor (@email{enrico@@eflor.net})
 @end titlepage
 
@@ -21,7 +21,7 @@
 
 @uref{https://melpa.org/#/latex-table-wizard, 
file:https://melpa.org/packages/latex-table-wizard-badge.svg}
 
-Copyright (C) 2022 Enrico Flor.
+Copyright (C) 2022, 2023 Enrico Flor.
 
 Permission is granted to copy, distribute and/or modify this
 document under the terms of the GNU Free Documentation License,
@@ -49,9 +49,10 @@ Available commands
 * Start editing::
 * Relative motion commands::
 * Absolute motion commands::
-* Mark, kill and insert commands: Mark kill and insert commands.
+* Mark, kill and insert commands: Mark kill and insert commands. 
 * Swap adjacent fields::
 * Swap arbitrary fields::
+* Comment out cells::
 * Format the table::
 * Extra commands in the transient prefix::
 
@@ -132,9 +133,10 @@ Whenever we say ``current'' we mean ``at point''.
 * Start editing::
 * Relative motion commands::
 * Absolute motion commands::
-* Mark, kill and insert commands: Mark kill and insert commands.
+* Mark, kill and insert commands: Mark kill and insert commands. 
 * Swap adjacent fields::
 * Swap arbitrary fields::
+* Comment out cells::
 * Format the table::
 * Extra commands in the transient prefix::
 @end menu
@@ -202,6 +204,17 @@ movement will consist of.  By default, you can pass this 
argument
 from the transient interface of @code{latex-table-wizard} with the key @code{u}
 (bound to @code{universal-argument}).
 
+These four commands also accept a second optional argument which, if
+non-nil, prevents the Do What You Mean behavior.  This is useful if
+you want to use these functions to write your own functions to edit
+tables.  Given the table above, if point is on @code{A2}, both of the
+following expressions will return nil and won't move point:
+
+@lisp
+(latex-table-wizard-left 1 t)
+(latex-table-wizard-down 1 t)
+@end lisp
+
 @node Absolute motion commands
 @section Absolute motion commands
 
@@ -232,10 +245,10 @@ from the transient interface of @code{latex-table-wizard} 
with the key @code{u}
 @node Mark kill and insert commands
 @section Mark, kill and insert commands
 
-@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaa} 
{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
+@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaa} 
{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
 @headitem Command
 @tab Default key
-@tab
+@tab 
 @item @code{latex-table-wizard-mark-cell}
 @tab @code{m c}
 @tab mark current cell
@@ -245,17 +258,27 @@ from the transient interface of @code{latex-table-wizard} 
with the key @code{u}
 @item @code{latex-table-wizard-insert-row}
 @tab @code{i r}
 @tab insert row below
-@item @code{latex-table-wizard-kill-column}
+@item @code{latex-table-wizard-kill-column-content}
 @tab @code{k c}
-@tab add content of current column to kill ring
-@item @code{latex-table-wizard-kill-row}
+@tab kill content of current column
+@item @code{latex-table-wizard-kill-row-content}
 @tab @code{k r}
-@tab add content of current row to kill ring
+@tab kill content of current row
+@item @code{latex-table-wizard-delete-column}
+@tab @code{D c}
+@tab delete current column
+@item @code{latex-table-wizard-delete-row}
+@tab @code{D r}
+@tab delete current row
 @item @code{exchange-point-and-mark}
 @tab @code{x}
-@tab
+@tab 
 @end multitable
 
+@code{latex-table-wizard-delete-column} and 
@code{latex-table-wizard-delete-row}
+modify the structure of the table (they actually remove the
+column/table, not just the content of the cells in them).
+
 @node Swap adjacent fields
 @section Swap adjacent fields
 
@@ -387,6 +410,29 @@ corresponding portion thereof.  If you selected multiple 
cell that are
 not part of the same column or row, the swap won't happen
 (@LaTeX{}-table-wizard doesn't know what you want it to do in that case).
 
+@node Comment out cells
+@section Comment out cells
+
+These two commands act on all the selected cells, if any is;
+otherwise, on the current cell point is on.
+
+@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaa} 
{aaaaaaaaaaaaaaaaaaa}
+@headitem Command
+@tab Default key
+@tab Select current@dots{}
+@item @code{latex-table-wizard-comment-out-content}
+@tab @code{; c}
+@tab comment out content
+@item @code{latex-table-wizard-comment-out}
+@tab @code{; ;}
+@tab comment out
+@end multitable
+
+The difference between the two is that one only comments out the
+content, preserving both delimiters around the cell; the other one
+actually modifies the structure of the table because for any cell that
+is commented out, one delimiter around it is commented out too.
+
 @node Format the table
 @section Format the table