branch: elpa/casual
commit bb47aee94e068845259e3daf9a6ddce3e91b541b
Merge: bafcc52ade f75307879c
Author: Charles Choi <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #186 from kickingvegas/185-fix-documentation-bugs-in-240
Fix 2.4.0 documentation bugs
---
README.org | 4 +-
docs/casual.info | 24 +++----
docs/casual.org | 190 ++++++++++++++++++++++++++---------------------------
docs/ibuffer.org | 2 +-
docs/make-mode.org | 26 ++++----
5 files changed, 123 insertions(+), 123 deletions(-)
diff --git a/README.org b/README.org
index 5ff910a845..f92bd3e53a 100644
--- a/README.org
+++ b/README.org
@@ -91,7 +91,7 @@ An interface for
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Cal
[[file:docs/editkit.org][file:docs/images/casual-editkit-main-screenshot.png]]
** [[file:docs/ibuffer.org][IBuffer]] (Elisp library: ~casual-ibuffer~)
- An interface for the Info documentation system.
+ An interface for
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Buffer-Menus.html][IBuffer]],
a tool for managing buffers in Emacs. If one was to fancifully consider Emacs
as an OS, consider this to be its task manager.
[[file:docs/info.org][file:docs/images/casual-ibuffer-screenshot.png]]
@@ -113,7 +113,7 @@ An interface for the many commands supported by I-Search.
[[file:docs/isearch.org][file:docs/images/casual-isearch-tmenu.png]]
** [[file:docs/make-mode.org][Make]] (Elisp library: ~casual-make~)
-An interface to ~make-mode~, a mode tailored for editing a Makefile.
+An interface for ~make-mode~, a mode tailored for editing a Makefile.
[[file:docs/make-mode.org][file:docs/images/casual-make-screenshot.png]]
diff --git a/docs/casual.info b/docs/casual.info
index 96416eb874..3cb201b4eb 100644
--- a/docs/casual.info
+++ b/docs/casual.info
@@ -11,7 +11,7 @@ File: casual.info, Node: Top, Next: Motivations, Up: (dir)
Casual User Guide
*****************
-Version: 2.4.0
+Version: 2.4.1
Casual is a project to re-imagine the primary user interface for Emacs
using keyboard-driven menus.
@@ -984,7 +984,7 @@ Makefile Type Selection
As there are different variants of *make* and makefile formats, you can
configure the mode for different specific makefile types. This can be
-done by selecting 'm' keybinding in ‘casual-make-tmenu’.
+done by selecting the ‘t’ keybinding in ‘casual-make-tmenu’.
Automatic Variables
-------------------
@@ -992,7 +992,7 @@ Automatic Variables
Casual Make provides a menu to enter GNU Make-style automatic variables.
Note that each keybinding is identical to the automatic variable it
represents to both reinforce its declaration and to avoid making another
-mapping. This menu is available from the 'i' keybinding in
+mapping. This menu is available from the ‘a’ keybinding in
‘casual-make-tmenu’.
Unless you edit makefiles frequently, it is very unlikely to be able to
@@ -1328,15 +1328,15 @@ Node: Image21735
Node: Info22976
Node: I-Search24442
Node: Make25603
-Node: RE-Builder27975
-Node: UX Conventions31382
-Node: Customization34083
-Node: Feedback & Discussion34457
-Node: Sponsorship34875
-Node: About35169
-Node: Acknowledgments35446
-Node: Index35828
-Node: Variable Index39730
+Node: RE-Builder27987
+Node: UX Conventions31394
+Node: Customization34095
+Node: Feedback & Discussion34469
+Node: Sponsorship34887
+Node: About35181
+Node: Acknowledgments35458
+Node: Index35840
+Node: Variable Index39742
End Tag Table
diff --git a/docs/casual.org b/docs/casual.org
index ed0d06815e..a980dfaaec 100644
--- a/docs/casual.org
+++ b/docs/casual.org
@@ -6,7 +6,7 @@
#+OPTIONS: ':t toc:t author:t email:t compact-itemx:t
#+LANGUAGE: en
-#+MACRO: version 2.4.0
+#+MACRO: version 2.4.1
#+TEXINFO_FILENAME: casual.info
#+TEXINFO_HEADER: @syncodeindex pg cp
@@ -60,7 +60,7 @@ Casual requires Emacs 29.1+.
Certain menus require more:
-- Casual Dired: GNU Coreutils
+- Casual Dired: GNU Coreutils
- Casual Image: ImageMagick 6+
* Transient Conventions
@@ -138,27 +138,27 @@ Casual Agenda organizes its main menu into the following
sections:
- *Agenda*
Modify the view duration (day, week, fortnight, month, year).
-
+
- *Filter*
-
+
Filter displayed headlines with different criteria.
-
+
- *Actions*
-
+
Perform an activity on a headline, create/capture a headline or even
generate a different agenda view.
-
+
- *Navigation*
-
+
Navigate to different agenda items by line, heading, or date. Move the point
to where you want it to be.
- *Utils*
-
+
Miscellaneous commands such as setting a time, showing the calendar, and
getting almanac information (sunrise/sunset, lunar cycle).
-
+
#+TEXINFO: @unnumberedsec References
- [[info:org#Agenda Views][Org Agenda]]
-
+
** Bookmarks
#+CINDEX: Bookmarks
@@ -199,7 +199,7 @@ While not necessary, having the current bookmark
highlighted is convenient. Enab
Finally, customize the variable ~bookmark-save-flag~ to the value ~1~ to
ensure that your bookmark changes are always saved.
-The above guidance largely extends the work done in the blog post
[[http://yummymelon.com/devnull/using-bookmarks-in-emacs-like-you-do-in-web-browsers.html][Using
Bookmarks in Emacs like you do in Web Browsers]].
+The above guidance largely extends the work done in the blog post
[[http://yummymelon.com/devnull/using-bookmarks-in-emacs-like-you-do-in-web-browsers.html][Using
Bookmarks in Emacs like you do in Web Browsers]].
#+TEXINFO: @unnumberedsec Usage
#+CINDEX: Bookmarks Usage
@@ -209,27 +209,27 @@ Casual Bookmarks organizes its main menu into the
following sections:
- *Operations*
Commands that can operate on a bookmark such as editing or opening them.
-
+
- *Mark*
Commands that allow for bulk operation on multiple bookmarks.
-
+
- *Display*
Control how bookmarks are displayed and filtered.
-
+
- *Annotation*
Commands for annotating a bookmark.
-
+
- *Navigation*
-
+
Commands for navigating to a bookmark.
- *Column*
Commands to navigate and control the display of the table layout for
bookmarks.
-
+
#+TEXINFO: @unnumberedsec References
- [[info:emacs#Bookmarks][Bookmarks]]
@@ -258,23 +258,23 @@ Casual Calc organizes its main menu into the following
sections:
- *Calc*
Commands for common calculator functions.
-
+
- *Constants*
Common math constants.
-
+
- *Operators*
Common math operators.
-
+
- *Stack*
Commands for stack operations.
-
+
- *Arithmetic*
Entry point for sub-menus of commands classified as arithmetic operations.
-
+
- *Functions*
Entry point for sub-menus of commands organized into different classes of
functionality.
@@ -282,7 +282,7 @@ Casual Calc organizes its main menu into the following
sections:
- *Settings*
Entry point for sub-menus of commands to configure Calc settings.
-
+
To see the main menu in action do the following:
1. Invoke ~M-x calc~ to launch Calc.
@@ -324,7 +324,7 @@ Casual Calendar is a user interface for Emacs
Calendar/Diary. Its top-level libr
The main menu for Casual Calendar is ~casual-calendar-tmenu~ that is wrapped
by the command ~casual-calendar~. Bind this command in the keymap
~calendar-mode-map~ as follows in your initialization file.
-#+begin_src elisp :lexical no
+#+begin_src elisp :lexical no
(keymap-set calendar-mode-map "C-o" #'casual-calendar)
#+end_src
@@ -337,28 +337,28 @@ Casual Calendar organizes its main menu into the
following sections:
- *Navigation*
Commands to move the point to a desired date, adjusting the view as
necessary.
-
+
- *Conversions*
Commands to convert a date across different calendar systems.
-
+
- *Holidays*
Holiday related commands.
-
+
- *Misc*
Commands related to the Diary and Org Agenda are placed here.
-
+
- *Almanac*
Almanac-related commands such the lunar phase, sunrise/sunset times are
found here.
-
+
- *Region*
Support for counting days defined in a region is offered here.
-
+
#+TEXINFO: @unnumberedsec References
- [[info:emacs#Calendar/Diary][Calendar/Diary]]
@@ -366,7 +366,7 @@ Casual Calendar organizes its main menu into the following
sections:
** Dired
#+CINDEX: Dired
-Casual Dired provides a user interface for Dired, the Emacs file manager. Its
top-level library is ~casual-dired~.
+Casual Dired provides a user interface for Dired, the Emacs file manager. Its
top-level library is ~casual-dired~.
#+TEXINFO: @unnumberedsec Requirements
#+CINDEX: Dired Requirements
@@ -411,33 +411,33 @@ Casual Dired organizes its main menu into the following
sections:
- *File*
File-related commands are placed here. Most of the commands will also
operate on marked files (see *Mark* item below).
-
+
- *Directory*
- Directory-related commands. Subdir view commands are also made available in
this section. To remove a subdir view, use the prefix ~C-u~ before pressing the
binding ~k~ to kill a subdir view.
-
+ Directory-related commands. Subdir view commands are also made available in
this section. To remove a subdir view, use the prefix ~C-u~ before pressing the
binding ~k~ to kill a subdir view.
+
- *Mark*
Marking operations are available here. Commands in the /Utils/ sub-menu can
be used to operate on marked items. In addition, many commands from the *Files*
section can be operate on marked items.
- The /Regexp/ sub-menu provides commands to mark via [[info:elisp#Regular
Expressions][regular expression]].
-
+ The /Regexp/ sub-menu provides commands to mark via [[info:elisp#Regular
Expressions][regular expression]].
+
- *Navigation*
- Navigation commands to move the point in Dired are offered here.
-
+ Navigation commands to move the point in Dired are offered here.
+
- *Quick*
Convenience commands for bookmarks and listing buffers are made available in
this section.
-
+
- *Search*
-
+
Commands to find a filename via I-Search or to recursively search for
pattern inside files contained in a directory tree (~rgrep~) are made available
here.
-
+
- *New*
Create a new file or directory with the commands in this section.
-
+
#+TEXINFO: @unnumberedsec References
- [[info:emacs#Dired][Dired]]
@@ -464,20 +464,20 @@ The main menu of Casual EditKit
(~casual-editkit-main-tmenu~) is organized into
- *File*
Commands related to opening files or buffers are provided here.
-
+
- *Edit*
Text editing commands are provided here.
From this section, rectangle commands are made available via the ~(e) Edit →
(R) Rectangle~ binding combination.
-
+
- *Sexp*
Text editing commands specific for a balanced expression (Sexp) are provided
here.
- *Tools*
- Commands for invoking different tools are provided here.
+ Commands for invoking different tools are provided here.
- *Miscellaneous* (unlabeled)
@@ -493,7 +493,7 @@ Casual EditKit has support for Register commands by
providing a sub-menu for it
Casual IBuffer provides a user interface to Emacs IBuffer, a mode designed for
managing buffers. Its top-level library is ~casual-ibuffer~.
-IBuffer is a powerful tool for managing Emacs workflows. As Emacs is often
compared to an operating system, through that lens one could compare IBuffer to
being a task manager interface, managing instantiated buffers as opposed to
processes.
+IBuffer is a powerful tool for managing Emacs workflows. As Emacs is often
compared to an operating system, through that lens one could compare IBuffer to
being a task manager interface, managing instantiated buffers as opposed to
processes.
#+TEXINFO: @unnumberedsec Configuration
#+CINDEX: IBuffer Configuration
@@ -520,26 +520,26 @@ The main menu of Casual IBuffer (~casual-ibuffer-tmenu~)
is organized into the f
- *Operations*
Commands to operate either on the buffer at point or on marked buffers.
-
+
- *Mark*
- Commands to support the marking of buffers.
-
+ Commands to support the marking of buffers.
+
- *Display*
Commands to control the display of buffers. Buffers can be sorted by
different criteria.
-
+
- *Navigation*
Commands to navigate the buffer list.
-
+
- *Filter*
Commands related to filtering/organizing buffers. Support for defining
/Filter Groups/ is provided here.
-
+
- *Find/Replace in Marked*
- Commands to search & replace text in marked buffers are provided here. Note
that commands in this section that modify buffers do /not/ save said buffers.
+ Commands to search & replace text in marked buffers are provided here. Note
that commands in this section that modify buffers do /not/ save said buffers.
- *Quick*
@@ -570,33 +570,33 @@ The main menu for Casual Image is ~casual-image-tmenu~.
Bind this menu in the ke
The main menu for Casual Image (~casual-image-tmenu~) is organized into the
following sections:
- *View*
-
+
Commands to control the display of the image. None of these commands will
mutate the image file.
-
+
- *Edit*
-
+
Commands to edit the image file.
-
+
- *Scroll*
-
+
Commands to scroll an image view that is larger than its window size.
-
+
- *Edge*
Commands to navigate to the edges of an image view that is larger than its
window size.
-
+
- *Traverse*
-
+
Commands to navigate to other image files in the same directory as the
current image.
-
+
- *Mark*
-
+
Commands to mark in Dired the current image.
-
+
- *Misc*
-
+
Miscellaneous commands.
-
+
#+TEXINFO: @unnumberedsec References
- [[info:emacs#Image Mode][Image Mode]]
@@ -622,14 +622,14 @@ The main menu for Casual Info is ~casual-info-tmenu~.
Bind this menu in the keym
The main menu for Casual Info is organized into the following sections:
- *Overview*
-
+
Commands that navigate you to a starting point in the info documentation.
-
+
- *Goto*
Commands that have you specify where to goto in the structure of an Info
document.
-
+
- *Search*
Commands for searching Info.
@@ -641,11 +641,11 @@ The main menu for Casual Info is organized into the
following sections:
- *Scroll*
Commands to scroll down or up the current Info page.
-
+
- *Navigation*
Command related to structurally navigating an Info document. Note that these
commands should not be confused with historical navigation.
-
+
- *Quick*
Miscellaneous commands for working with an Info document. Included are
commands for bookmarks, copying the current node name, and cloning the buffer.
@@ -676,19 +676,19 @@ The main menu for Casual I-Search is organized into the
following sections:
- *Edit Search String*
Commands to edit the search string. The type/extent of the string (word,
symbol, line, thing) can be specified here.
-
+
- *Replace*
Invoke ~query-replace~ or ~query-replace-regexp~ on matched strings.
-
+
- *Toggle*
Commands to configure the type of search.
-
+
- *Misc*
Miscellaneous commands. From here the search string can be fed into ~occur~
or be highlighted.
-
+
- *Navigation*
Navigation commands for matched strings.
@@ -723,27 +723,27 @@ When in a Makefile buffer, use ~M-m~ (or your binding of
choice) to raise the me
- Edit
Commands for editing the makefile. Note that the backslash and comment
commands require a region to be selected.
-
+
- Pickup as targets
-
+
Commands for synchronizing ~make-mode~ with the target definitions in the
makefile. Use these commands if trying to insert a target (via the ':' binding)
does not include a target you have recently entered.
-
+
- Misc
-
- Miscellaneous commands related to working with a makefile.
-
+
+ Miscellaneous commands related to working with a makefile.
+
- Navigate
-
+
Commands to support navigation within the makefile.
-
+
#+TEXINFO: @unnumberedsubsec Makefile Type Selection
-As there are different variants of *make* and makefile formats, you can
configure the mode for different specific makefile types. This can be done by
selecting 'm' keybinding in ~casual-make-tmenu~.
+As there are different variants of *make* and makefile formats, you can
configure the mode for different specific makefile types. This can be done by
selecting the ~t~ keybinding in ~casual-make-tmenu~.
#+TEXINFO: @unnumberedsubsec Automatic Variables
-Casual Make provides a menu to enter GNU Make-style automatic variables. Note
that each keybinding is identical to the automatic variable it represents to
both reinforce its declaration and to avoid making another mapping. This menu
is available from the 'i' keybinding in ~casual-make-tmenu~.
+Casual Make provides a menu to enter GNU Make-style automatic variables. Note
that each keybinding is identical to the automatic variable it represents to
both reinforce its declaration and to avoid making another mapping. This menu
is available from the ~a~ keybinding in ~casual-make-tmenu~.
Unless you edit makefiles frequently, it is very unlikely to be able to recall
what an automatic variable declaration means. Casual Make provides the command
~casual-make-identify-autovar-region~ to identify a selected automatic variable
via the binding '.' in ~casual-make-tmenu~. A short description of the
automatic variable is shown in the mini-buffer.
@@ -771,7 +771,7 @@ The main menu for Casual RE-Builder is
~casual-re-builder-tmenu~. Bind this menu
#+CINDEX: RE-Builder Usage
#+TEXINFO: @unnumberedsubsec Basic Usage
-When the command ~re-builder~ is invoked, a buffer named "✳︎RE-Builder✳︎" is
created. Activate Casual RE-Builder with the binding ~C-o~ (or one of your
preference).
+When the command ~re-builder~ is invoked, a buffer named "✳︎RE-Builder✳︎" is
created. Activate Casual RE-Builder with the binding ~C-o~ (or one of your
preference).
At the top of the menu shows the title "RE-Builder" with the target buffer
enclosed in parenthesis. The regexp pattern will be applied to the target
buffer. The target buffer can be changed with the (b) *Target buffer* menu item.
@@ -792,13 +792,13 @@ Once a desired regexp pattern is defined, there are two
menu items that can be u
- Example commands that do this are ~dired-do-find-regexp~ and
~dired-do-find-regexp-and-replace~.
- This command presumes that you have GNU grep installed and configured for
use by Emacs.
- ❗️At current this is an experimental feature. The regexp exported from
RE-Builder may not work. If so please report an
[[https://github.com/kickingvegas/casual-re-builder/issues][issue]] describing
the desired regexp and the target text.
- - This can only be used when the regexp syntax is set to ~string~.
+ - This can only be used when the regexp syntax is set to ~string~.
#+TEXINFO: @unnumberedsubsec Regexp Syntax Help
The menu item (i) will invoke the Info page for regexp syntax with respect to
the current syntax type.
#+TEXINFO: @unnumberedsubsec Quitting RE-Builder
-Select (q) *Quit* to exit the RE-Builder tool.
+Select (q) *Quit* to exit the RE-Builder tool.
#+TEXINFO: @unnumberedsec References
- [[info:elisp#Regular Expressions][Regular Expressions]]
@@ -818,33 +818,33 @@ In contrast, Casual makes these bindings explicitly known
to user by displaying
#+TEXINFO: @unnumberedsec Settings Menu
-Most all Casual main menus support invoking a mode-specific settings menu via
the binding ','.
+Most all Casual main menus support invoking a mode-specific settings menu via
the binding ','.
#+TEXINFO: @unnumberedsec Unicode Symbol Support
#+VINDEX: casual-lib-use-unicode
The customizable variable named ~casual-lib-use-unicode~ which when non-nil
will inform Casual menus to use Unicode symbol labels whenever supported. This
can be changed from Casual mode-specific settings menu.
-If ~casual-lib-use-unicode~ is set to ~t~, it is also recommended that the
variable ~transient-align-variable-pitch~ also be set to ~t~.
+If ~casual-lib-use-unicode~ is set to ~t~, it is also recommended that the
variable ~transient-align-variable-pitch~ also be set to ~t~.
#+TEXINFO: @unnumberedsec Common Key Bindings
- (J) ~Jump to Bookmark…~
Casual places great emphasis on using Emacs Bookmarks to track different
places of note. The binding ~J~ is used in many main menus to support this.
-
+
- (,) ~Settings›~
Many modes have settings specific to them. The binding ~,~ is used in many
main menus to support the configuration of mode-specific settings.
- (j) ~Goto…~ (mode specific)
- Many modes provide a list of items. The binding ~j~ is used to map to the
command to move the point to an item that the user explicitly specifies.
+ Many modes provide a list of items. The binding ~j~ is used to map to the
command to move the point to an item that the user explicitly specifies.
- (n), (p) ~Next~, ~Previous~
For modes that provide a list of items, navigation to a next or previous
item is bound to ~n~ and ~p~ respectively.
-
+
- ([), (]) ~Next Section~, ~Previous Section~
For modes that organize items into sections, navigation to a next or
previous section is bound to ~[~ and ~]~ respectively.
@@ -852,7 +852,7 @@ If ~casual-lib-use-unicode~ is set to ~t~, it is also
recommended that the varia
* Customization
#+CINDEX: Customization
-Users who wish to extend or alter existing Casual menus can do so via the
mechanisms offered by the Transient package.
+Users who wish to extend or alter existing Casual menus can do so via the
mechanisms offered by the Transient package.
#+TEXINFO: @unnumberedsec References
- [[info:transient#Modifying Existing Transients][Modifying Existing
Transients]]
diff --git a/docs/ibuffer.org b/docs/ibuffer.org
index 10a881244e..0420f57e64 100644
--- a/docs/ibuffer.org
+++ b/docs/ibuffer.org
@@ -1,7 +1,7 @@
[[../README.org][❮ Back to Casual]]
* Casual IBuffer
-An opinionated [[https://github.com/magit/transient][Transient]]-based user
interface for
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Buffer-Menus.html][IBuffer]],
a buffer management tool for Emacs.
+An interface for
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Buffer-Menus.html][IBuffer]],
a tool for managing buffers in Emacs. If one was to fancifully consider Emacs
as an OS, consider this to be its task manager.
[[file:images/casual-ibuffer-screenshot.png]]
diff --git a/docs/make-mode.org b/docs/make-mode.org
index fb16580779..8c9227968a 100644
--- a/docs/make-mode.org
+++ b/docs/make-mode.org
@@ -2,7 +2,7 @@
* Casual Make
-Casual Make is a user interface to ~make-mode~, a mode tailored for editing a
Makefile.
+Casual Make is a user interface for ~make-mode~, a mode tailored for editing a
Makefile.
[[file:images/casual-make-screenshot.png]]
@@ -24,24 +24,24 @@ It is recommended that some basic knowledge of the *make*
command is known befor
When in a Makefile buffer, use ~M-m~ (or your binding of choice) to raise the
menu ~casual-make-tmenu~. You will be presented with a menu with the following
sections:
- Edit
-
+
Commands for editing the makefile. Note that the backslash and comment
commands require a region to be selected.
-
+
- Pickup as targets
-
+
Commands for synchronizing ~make-mode~ with the target definitions in the
makefile. Use these commands if trying to insert a target (via the ':' binding)
does not include a target you have recently entered.
-
+
- Misc
-
- Miscellaneous commands related to working with a makefile.
-
+
+ Miscellaneous commands related to working with a makefile.
+
- Navigate
-
+
Commands to support navigation within the makefile.
-
+
** Makefile Type Selection
-As there are different variants of *make* and makefile formats, you can
configure the mode for different specific makefile types. This can be done by
selecting 'm' keybinding in ~casual-make-tmenu~.
+As there are different variants of *make* and makefile formats, you can
configure the mode for different specific makefile types. This can be done by
selecting the ~t~ keybinding in ~casual-make-tmenu~.
[[file:images/casual-make-mode-select-screenshot.png]]
@@ -52,10 +52,10 @@ Casual Make provides a menu to enter GNU Make-style
[[https://www.gnu.org/softwa
[[file:images/casual-make-automatic-variables-screenshot.png]]
-Unless you edit makefiles frequently, it is very unlikely to be able to recall
what an automatic variable declaration means. Casual Make provides the command
~casual-make-identify-autovar-region~ to identify a selected automatic variable
via the binding '.' in ~casual-make-tmenu~. A short description of the
automatic variable is shown in the mini-buffer.
+Unless you edit makefiles frequently, it is very unlikely to be able to recall
what an automatic variable declaration means. Casual Make provides the command
~casual-make-identify-autovar-region~ to identify a selected automatic variable
via the binding ~i~ in ~casual-make-tmenu~. A short description of the
automatic variable is shown in the mini-buffer.
** Unicode Symbol Support
-By enabling “Use Unicode Symbols” from the Settings menu, Casual Make will use
Unicode symbols as appropriate in its menus.
+By enabling “Use Unicode Symbols” from the Settings menu, Casual Make will use
Unicode symbols as appropriate in its menus.
* Sponsorship
If you enjoy using Casual Make, consider making a modest financial
contribution to help support its development and maintenance.
