branch: elpa/casual
commit bb7ed76098a55283ff0dea88f920277b194a4490
Merge: 7edd521112 f0b6970d21
Author: Charles Choi <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #376 from kickingvegas/373-cleanup-info-documentation
Update Info Documentation
---
docs/agenda.org | 12 ++++++++----
docs/bibtex.org | 11 +++++++----
docs/bookmarks.org | 22 ++++++++--------------
docs/calendar.org | 53 +++++++++++++++++++++++++++++++++++------------------
docs/casual.org | 16 +++++++++++++---
docs/compile.org | 4 ++++
docs/css.org | 5 +++--
docs/csv.org | 6 ++++--
docs/dired.org | 21 ++++++++++++++++++---
docs/ediff.org | 8 ++++++++
docs/editkit.org | 49 +++++++++++++++++++++++++++----------------------
docs/elisp.org | 10 ++++++++++
docs/eshell.org | 16 ++++++++++++++++
docs/eww.org | 6 ++++--
docs/help.org | 10 +++++++++-
docs/html.org | 4 +++-
docs/ibuffer.org | 15 +++++----------
docs/image.org | 12 +++++++++++-
docs/info.org | 1 +
docs/isearch.org | 17 +++++++++++++++++
docs/make-mode.org | 4 ++++
docs/man.org | 4 ++++
docs/re-builder.org | 17 ++++++++++-------
docs/timezone.org | 12 +++++++++++-
24 files changed, 240 insertions(+), 95 deletions(-)
diff --git a/docs/agenda.org b/docs/agenda.org
index bf00099adb..00b7715094 100644
--- a/docs/agenda.org
+++ b/docs/agenda.org
@@ -40,24 +40,28 @@ The main menu for Casual Agenda is ~casual-agenda-tmenu~.
It is divided into fiv
- Utils :: Set a timer, get almanac info.
-#+TEXINFO: @subheading Operating on Headlines
+#+TEXINFO: @subheading Operating on Headlines (casual-agenda-operations-tmenu)
+#+VINDEX: casual-agenda-operations-tmenu
Use “{{{kbd(o)}}} Operations›” from ~casual-agenda-tmenu~ to change a
headline's attributes such as TODO state, scheduling, tags, and priority. The
following menu will be displayed.
[[file:images/casual-agenda-operations-screenshot.png]]
-#+TEXINFO: @subheading Marking Headlines
+#+TEXINFO: @subheading Marking Headlines (casual-agenda-mark-tmenu)
+#+VINDEX: casual-agenda-mark-tmenu
Use “{{{kbd(M)}}} Mark›” menu from ~casual-agenda-tmenu~ to mark different
headlines and perform a bulk action on them.
[[file:images/casual-agenda-mark-screenshot.png]]
-#+TEXINFO: @subheading Almanac
+#+TEXINFO: @subheading Almanac (casual-agenda-almanac-tmenu)
+#+VINDEX: casual-agenda-almanac-tmenu
Get sunrise/sunset times, lunar cycle dates, and holidays with respect to a
date via the “{{{kbd(l)}}} Almanac›” menu from ~casual-agenda-tmenu~.
[[file:images/casual-agenda-almanac-screenshot.png]]
#+TEXINFO: @subheading Changing Modes and Settings
+#+VINDEX: casual-agenda-settings-tmenu
Agenda views have different display modes and behavior that can be modified
from the “{{{kbd(\,)}}} Settings›” menu from ~casual-agenda-tmenu~.
[[file:images/casual-agenda-settings-screenshot.png]]
@@ -67,4 +71,4 @@ By enabling “{{{kbd(u)}}} Use Unicode Settings” from the
Settings menu, Casu
[[file:images/casual-agenda-unicode-screenshot.png]]
-
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/bibtex.org b/docs/bibtex.org
index 49f9f086d8..61bcaa8223 100644
--- a/docs/bibtex.org
+++ b/docs/bibtex.org
@@ -65,7 +65,7 @@ In your initialization file, bind the Transient
~casual-bibtex-tmenu~ to your ke
[[file:images/casual-bibtex-screenshot.png]]
-The main menu for Casual BibTeX is organized into the following sections:
+The main menu for Casual BibTeX (~casual-bibtex-tmenu~) is organized into the
following sections:
- Field :: Commands to edit or navigate fields within an entry.
- Entry :: Commands to edit or navigate entries within a BibTeX file.
@@ -144,11 +144,12 @@ The ability to search and jump to a position in a BibTeX
database are offered by
:CUSTOM_ID: bibtex-settings
:END:
#+CINDEX: BibTeX Settings
+#+VINDEX: casual-bibtex-settings-tmenu
[[file:images/casual-bibtex-settings-screenshot.png]]
-This menu offers access to commonly configured BibTeX mode settings.
+The menu ~casual-bibtex-settings-tmenu~ offers access to commonly configured
BibTeX mode settings.
Settings are organized into the following sections:
@@ -162,9 +163,11 @@ Settings are organized into the following sections:
By default BibTeX mode does not format (or "fill") an entry upon cleaning. To
support filling an entry upon clean, add the command ~bibtex-fill-entry~ to
~bibtex-clean-entry-hook~ using the “{{{kbd(C)}}} Clean” command as shown below:
[[file:images/casual-bibtex-clean-entry-hook.png]]
-
-#+TEXINFO: @subsubheading BibTeX Mode Unicode Symbol Support
+*** BibTeX Mode Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
BibTeX will use Unicode symbols as appropriate in its menus.
[[file:images/casual-bibtex-unicode-screenshot.png]]
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
diff --git a/docs/bookmarks.org b/docs/bookmarks.org
index 24e32827ab..0444c8ef04 100644
--- a/docs/bookmarks.org
+++ b/docs/bookmarks.org
@@ -47,7 +47,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]].
** Bookmarks Usage
#+CINDEX: Bookmarks Usage
@@ -70,21 +70,15 @@ Casual Bookmarks organizes its main menu into the following
sections:
- Column :: Commands to navigate and control the display of the table layout
for bookmarks.
+#+TEXINFO: @subheading Sorting
+#+VINDEX: casual-bookmarks-sortby-tmenu
+
+Support for sorting the bookmarks list is provided by the menu
~casual-bookmarks-sortby-tmenu~.
+
#+TEXINFO: @subheading Unicode Symbol Support
[[file:images/casual-bookmarks-unicode-screenshot.png]]
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Bookmarks will use Unicode symbols as appropriate in its menus. The following
mapping is shown in the table below:
-
-| Name | Plain | Unicode |
-|----------------------+-----------+---------|
-| :previous | Previous | ↑ |
-| :next | Next | ↓ |
-| :jump | Jump | 🚀 |
-| :beginning-of-buffer | Beginning | ⤒ |
-| :end-of-buffer | End | ⤓ |
-| :backward | Backward | ← |
-| :forward | Forward | → |
-| :narrow | Narrow | →← |
-| :widen | Widen | ←→ |
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Bookmarks will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/calendar.org b/docs/calendar.org
index cacc735f66..e9f44f5cb2 100644
--- a/docs/calendar.org
+++ b/docs/calendar.org
@@ -24,7 +24,7 @@ The main menu for Casual Calendar (~casual-calendar-tmenu)~
is invoked by the co
[[file:images/casual-calendar-screenshot.png]]
-Whenever the ~calendar~ window (showing three months) is raised, the Casual
user interface is invoked via the command ~casual-calendar~. This command is
typically bound to a keybinding (e.g. {{{kbd(C-o)}}}).
+Whenever the ~calendar~ window (showing three months) is raised, the Casual
user interface is invoked via the command ~casual-calendar~. This command is
typically bound to a keybinding (e.g. {{{kbd(C-o)}}}).
Casual Calendar organizes its main menu into the following sections:
@@ -39,34 +39,48 @@ Casual Calendar organizes its main menu into the following
sections:
- 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.
-
+
Also made available is access to a Settings menu (more below) and to the Info
documentation for ~calendar~.
*** Diary & Goto Menu
+#+VINDEX: casual-calendar-diary-and-goto-tmenu
From the main menu, choosing “(D) Diary & Goto›” will present choices for
diary event insertion and to “goto” a particular date via different
specifications.
-[[file:images/casual-calendar-diary-menu.png]]
+[[file:images/casual-calendar-diary-menu.png]]
*** Calendar System Date Conversion
+#+VINDEX: casual-calendar-conversions-tmenu
+#+VINDEX: casual-calendar-lunar-tmenu
+#+VINDEX: casual-calendar-astro-tmenu
+#+VINDEX: casual-calendar-islamic-tmenu
+#+VINDEX: casual-calendar-hebrew-tmenu
+#+VINDEX: casual-calendar-bahai-tmenu
+#+VINDEX: casual-calendar-ethiopic-tmenu
+#+VINDEX: casual-calendar-french-tmenu
+#+VINDEX: casual-calendar-julian-tmenu
+#+VINDEX: casual-calendar-coptic-tmenu
+#+VINDEX: casual-calendar-persian-tmenu
+#+VINDEX: casual-calendar-mayan-tmenu
+
Calendar supports conversion of dates from Gregorian (default) to a number of
different calendar systems. Choose "(c) Conversions›" from the main menu to
select from a list of such calendars.
[[file:images/casual-calendar-calendars-menu.png]]
Supported calendar systems:
-- Astronomical
-- Bahá’í
-- Ethiopic
-- French Revolutionary
-- Hebrew
-- Islamic
-- Julian
-- Lunar (Chinese)
-- Mayan
-- Persian
+- Astronomical (~casual-calendar-astro-tmenu~)
+- Bahá’í (~casual-calendar-bahai-tmenu~)
+- Ethiopic (~casual-calendar-ethiopic-tmenu~)
+- French Revolutionary (~casual-calendar-french-tmenu~)
+- Hebrew (~casual-calendar-hebrew-tmenu~)
+- Islamic (~casual-calendar-islamic-tmenu~)
+- Julian (~casual-calendar-julian-tmenu~)
+- Lunar (Chinese) (~casual-calendar-lunar-tmenu~)
+- Mayan (~casual-calendar-mayan-tmenu~)
+- Persian (~casual-calendar-persian-tmenu~)
-Selecting a calendar system will raise a menu that offers date conversion
commands between it and the Gregorian system. In the screenshot below, the
Lunar (Chinese) calendar system menu is shown.
+Selecting a calendar system will raise a menu that offers date conversion
commands between it and the Gregorian system. In the screenshot below, the
Lunar (Chinese) calendar system menu is shown.
To convert a Gregorian date to Lunar (Chinese):
@@ -78,7 +92,7 @@ To convert a Lunar (Chinese) date to Gregorian:
1. Choose “(G) Goto…” and follow the prompts.
-[[file:images/casual-calendar-lunar-menu.png]]
+[[file:images/casual-calendar-lunar-menu.png]]
Certain non-Gregorian calendar systems are supported by the diary (Bahá’í,
Hebrew, Islamic, Lunar (Chinese)). For such systems, their menus will offer
choices to insert diary events.
@@ -87,10 +101,13 @@ Note that inserting non-Gregorian diary events require
configuration of the vari
Both of these variables can be configured from the Calendar Settings menu.
*** Calendar Settings Menu
-From the main menu, choosing “{{{kbd(\,)}}} Settings›” will provide a menu of
frequently configured calendar and diary-related variables.
+#+VINDEX: casual-calendar-settings-tmenu
+
+From the main menu, choosing “{{{kbd(\,)}}} Settings›” will provide a menu
(~casual-calendar-settings-tmenu~) of frequently configured calendar and
diary-related variables.
-[[file:images/casual-calendar-settings-menu.png]]
+[[file:images/casual-calendar-settings-menu.png]]
*** Calendar Unicode Symbol Support
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Calendar will use Unicode symbols as appropriate in its menus.
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Calendar will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/casual.org b/docs/casual.org
index d46fb8cbc4..ddf2e4b434 100644
--- a/docs/casual.org
+++ b/docs/casual.org
@@ -195,16 +195,20 @@ For version 2.x going forward, I (Charles Choi) have
decided to not offer any do
That said, if you have used ~:ensure t~ to install a superseded package, you
/must/ remove that configuration. After doing so, please follow the above
instructions for installing ~casual~.
* UX Conventions
+:PROPERTIES:
+:CUSTOM_ID: ux-conventions
+:END:
#+CINDEX: UX Conventions
The Casual menus share common user experience (UX) conventions to facilitate
usability. This section details this.
#+TEXINFO: @subheading Common Menu Navigation
-Casual organizes a mode's command set into a menu hierarchy. As the user
descends down different menu levels, the user is given the option to dismiss
the current menu or to dismiss completely all menu levels descended. Transient
provides a standard convention for menu dismissal via the {{{kbd(C-g)}}}
(~transient-quit-one~) and {{{kbd(C-q)}}} (~transient-quit-all~) commands. By
default Transient does not display these commands in the menu though, rather
they make the assumption that the u [...]
+Casual organizes a mode's command set into a menu hierarchy. As the user
descends down different menu levels, the user is given the option to dismiss
the current menu or to dismiss completely all menu levels descended. Transient
provides a standard convention for menu dismissal via the {{{kbd(C-g)}}}
(~transient-quit-one~) and {{{kbd(C-q)}}} (~transient-quit-all~) commands.
+Casual makes explicit the display of {{{kbd(C-g)}}} and {{{kbd(C-q)}}} at the
bottom of its menus, which differs from the default behavior of Transient.
#+VINDEX: casual-lib-hide-navigation
-In contrast, Casual makes these bindings explicitly known to user by
displaying them at the bottom of the menu. Users who wish to have them hidden
can set the customizable variable ~casual-lib-hide-navigation~ to a non-nil
value. This can be changed from a Casual mode-specific settings menu.
+Users who wish to have them hidden can set the customizable variable
~casual-lib-hide-navigation~ to a non-nil value. This can be changed from a
Casual mode-specific settings menu.
#+TEXINFO: @subheading Settings Menu
@@ -248,7 +252,13 @@ Casual annotates menu labels with the following
conventions:
- ‘…’ :: If the label ends with an ellipsis, then the command will prompt the
user for input.
- ‘›’ :: If the label ends with a right-pointing arrow, then the item will
raise a sub-menu.
-- ‘✦’ :: If the label ends with the glyph ✦ (BLACK FOUR POINTED STAR), then
the command supports a prefix {{{kbd(C-u)}}}.
+- ‘✦’ :: If the label ends with the glyph ✦ (BLACK FOUR POINTED STAR), then
the command supports a prefix {{{kbd(C-u)}}}.
+- ‘ⓘ’ :: If the label starts with the glyph ⓘ (CIRCLED LATIN SMALL LETTER I),
then the command will invoke the Info reader.
+
+
+#+TEXINFO: @subheading Menu Naming Conventions
+
+To distinguish Transient menu (prefix) definitions from existing Emacs menu
definitions using keymaps ([[info:elisp#Menu Keymaps][elisp#Menu Keymaps]]),
Casual uses the naming suffix ~-tmenu~.
* Casual Modes
#+CINDEX: Casual Modes
diff --git a/docs/compile.org b/docs/compile.org
index 44cfce36bb..a327ce7a9e 100644
--- a/docs/compile.org
+++ b/docs/compile.org
@@ -77,9 +77,13 @@ The following sections are offered in the menu:
If the output window is from a Grep command, ~casual-compile-tmenu~ will
adjust its labels accordingly as shown below.
[[file:images/casual-compile-grep-screenshot.png]]
+#+TEXINFO: @subheading Compile Settings
+#+VINDEX: casual-compile-settings-tmenu
+The menu ~casual-compile-settings-tmenu~ provides access to different
~compilation-mode~ settings.
#+TEXINFO: @subheading Compile Mode Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Compile will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/css.org b/docs/css.org
index 6de3c72ee1..8d77f0fb06 100644
--- a/docs/css.org
+++ b/docs/css.org
@@ -46,8 +46,7 @@ The following sections are offered in the menu:
#+TEXINFO: @subheading CSS Settings
#+VINDEX: casual-css-settings-tmenu
-Settings menu for Casual CSS.
-
+The menu ~casual-css-settings-tmenu~ provides access to different ~css-mode~
settings.
[[file:images/casual-css-settings-screenshot.png]]
@@ -55,3 +54,5 @@ Settings menu for Casual CSS.
#+TEXINFO: @subheading CSS Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
CSS will use Unicode symbols as appropriate in its menus.
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/csv.org b/docs/csv.org
index 26dcc84688..fa62f56d07 100644
--- a/docs/csv.org
+++ b/docs/csv.org
@@ -60,7 +60,7 @@ If the buffer is editable, a common to desire to instead work
on a copy of the C
#+TEXINFO: @subheading CSV Align
#+VINDEX: casual-csv-align-tmenu
-The display of the CSV buffer can be controlled with this menu.
+The display of the CSV buffer can be controlled with the menu
~casual-csv-align-tmenu~.
[[file:images/casual-csv-align-screenshot.png]]
@@ -68,6 +68,8 @@ The display of the CSV buffer can be controlled with this
menu.
#+TEXINFO: @subheading CSV Settings
#+VINDEX: casual-csv-settings-tmenu
+The menu ~casual-csv-settings-tmenu~ provides access to different ~csv-mode~
settings.
+
[[file:images/casual-csv-settings-screenshot.png]]
@@ -77,4 +79,4 @@ By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the
Settings menu, Casua
[[file:images/casual-csv-view-unicode-screenshot.png]]
-
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/dired.org b/docs/dired.org
index c70b4f1f50..c39c3df619 100644
--- a/docs/dired.org
+++ b/docs/dired.org
@@ -146,7 +146,7 @@ With the *Sort By* menu raised, one can save the switch
settings for future use
#+CINDEX: Dired Search & Replace
#+VINDEX: casual-dired-search-replace-tmenu
-Search and replace in multiple marked files using the “{{{kbd(/)}}} Search &
Replace›” menu item in ~casual-dired-tmenu~. This will raise a menu of Dired
commands that will work on marked files.
+Search and replace in multiple marked files using the “{{{kbd(/)}}} Search &
Replace›” menu (~casual-dired-search-replace-tmenu~) in ~casual-dired-tmenu~.
This will raise a menu of Dired commands that will work on marked files.
[[file:images/casual-dired-search-replace.png]]
@@ -158,15 +158,28 @@ While most Dired commands use Emacs-style regular
expression syntax ([[info:elis
The *grep*-style syntax is dependent on the ~grep~ implementation that is
installed and used by Emacs.
*** Bulk Dired Operations
-Casual Dired organizes a number of Dired commands that work on a set of marked
files. These commands are presented in the “{{{kbd(#)}}} Utils›” menu in
~casual-dired-tmenu~.
+#+VINDEX: casual-dired-utils-tmenu
+
+Casual Dired organizes a number of Dired commands that work on a set of marked
files. These commands are presented in the “{{{kbd(#)}}} Utils›” menu
(~casual-dired-utils-tmenu~) in ~casual-dired-tmenu~.
[[file:images/casual-dired-utils-screenshot.png]]
*** Dired Link
-Create symbolic and hard links via the “{{{kbd(l)}}} Link›” menu in
~casual-dired-tmenu~. Both absolute and relative symbolic links (symlinks) are
supported.
+#+VINDEX: casual-dired-link-tmenu
+
+Create symbolic and hard links via the “{{{kbd(l)}}} Link›” menu
(~casual-dired-link-tmenu~) in ~casual-dired-tmenu~. Both absolute and relative
symbolic links (symlinks) are supported.
[[file:images/casual-dired-link.png]]
+
+*** Dired Elisp
+#+VINDEX: casual-dired-elisp-tmenu
+
+Support for running bulk commands for Elisp development are provided by the
menu ~casual-dired-elisp-tmenu~.
+
+# TODO: Insert screenshot
+
+
*** Dired Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Dired will use Unicode symbols as appropriate in its menus. An example is shown
below.
@@ -175,3 +188,5 @@ By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the
Settings menu, Casua
To ensure proper layout and spacing, your default typeface should be
fixed-width or monospace and *must* support the Unicode symbols used.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
diff --git a/docs/ediff.org b/docs/ediff.org
index 19b9ae9c24..f864630ed8 100644
--- a/docs/ediff.org
+++ b/docs/ediff.org
@@ -108,6 +108,14 @@ Magit offers a means of invoking Ediff to resolve a merge
conflict via the {{{kb
Calling ~casual-ediff-tmenu~ will show the menu shown above. Note that in the
C section, there are commands to merge both the variant A and variant B diffs
using the bindings {{{kbd(mab)}}} or {{{kbd(mba)}}}, depending on the desired
order the diffs are to be merged.
+*** Ediff Settings
+#+VINDEX: casual-ediff-settings-tmenu
+
+The menu ~casual-ediff-settings-tmenu~ provides access to different
~ediff-mode~ settings.
+
+# TODO: Insert screenshot
+
*** Ediff Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Ediff will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/editkit.org b/docs/editkit.org
index fd52d55983..61ae5fe162 100644
--- a/docs/editkit.org
+++ b/docs/editkit.org
@@ -68,13 +68,13 @@ Register commands for saving and recalling text, point,
window configuration, an
#+CINDEX: Edit Commands
#+VINDEX: casual-editkit-edit-tmenu
-This menu contains commands and sub-menus related to editing text.
+The menu ~casual-editkit-edit-tmenu~ contains commands and sub-menus related
to editing text.
[[file:images/casual-editkit-edit-screenshot.png]]
Depending on the buffer mode, text can be operated on with different
granularity as words, sentences, paragraphs, balanced expressions, functions
(defuns). The following sub-menus illustrate what operations can be done on the
different text granularity.
-#+TEXINFO: @subheading Mark›
+#+TEXINFO: @subheading Mark› (casual-editkit-mark-tmenu)
#+CINDEX: Mark commands
#+VINDEX: casual-editkit-mark-tmenu
@@ -82,14 +82,14 @@ Text can be marked with different granularity with this
menu. Note that marking
[[file:images/casual-editkit-mark-screenshot.png]]
-#+TEXINFO: @subheading Copy›
+#+TEXINFO: @subheading Copy› (casual-editkit-copy-tmenu)
#+CINDEX: Copy commands
#+VINDEX: casual-editkit-copy-tmenu
Text can be copied with different granularity with this menu.
[[file:images/casual-editkit-copy-screenshot.png]]
-#+TEXINFO: @subheading Kill (Cut)›
+#+TEXINFO: @subheading Kill (Cut)› (casual-editkit-kill-tmenu)
#+CINDEX: Kill commands
#+CINDEX: Cut commands
#+VINDEX: casual-editkit-kill-tmenu
@@ -97,42 +97,42 @@ Text can be cut (killed) with different granularity with
this menu.
[[file:images/casual-editkit-kill-screenshot.png]]
-#+TEXINFO: @subheading Move›
+#+TEXINFO: @subheading Move› (casual-editkit-move-tmenu)
#+CINDEX: Move commands
#+VINDEX: casual-editkit-move-tmenu
Text can be moved forwards or backwards with different granularity with this
menu. Note that selecting a granularity will raise another menu to allow
selection of direction (forward, backward) the text is to be moved. To enable
repeat operation, that menu is persisted and must be dismissed either with
either ~C-q~ (dismiss all) or ~C-g~ (dismiss to previous menu).
[[file:images/casual-editkit-move-screenshot.png]]
-#+TEXINFO: @subheading Transpose›
+#+TEXINFO: @subheading Transpose› (casual-editkit-transpose-tmenu)
#+CINDEX: Transpose commands
#+VINDEX: casual-editkit-transpose-tmenu
Text can be transposed with different granularity with this menu.
[[file:images/casual-editkit-transpose-screenshot.png]]
-#+TEXINFO: @subheading Transform›
+#+TEXINFO: @subheading Transform› (casual-editkit-transform-tmenu)
#+CINDEX: Transform commands
#+VINDEX: casual-editkit-transform-tmenu
Text can be transformed with different granularity with this menu. Supported
transformations are capitalization, lower and upper casing of text.
[[file:images/casual-editkit-transform-screenshot.png]]
-#+TEXINFO: @subheading Delete›
+#+TEXINFO: @subheading Delete› (casual-editkit-delete-tmenu)
#+CINDEX: Delete commands
#+VINDEX: casual-editkit-delete-tmenu
Operations involving text deletion are included in this menu, including
joining lines and zapping to a character.
[[file:images/casual-editkit-delete-screenshot.png]]
-#+TEXINFO: @subheading Sort›
+#+TEXINFO: @subheading Sort› (casual-editkit-sort-tmenu)
#+CINDEX: Sort commands
#+VINDEX: casual-editkit-sort-tmenu
Sorting operations on different sections of text are supported, as well as
support for sorting off a field. Press ~?~ or ~C-h~ to get help for a specific
command.
[[file:images/casual-editkit-sort-screenshot.png]]
-#+TEXINFO: @subheading Reformat›
+#+TEXINFO: @subheading Reformat› (casual-editkit-reformat-tmenu)
#+CINDEX: Reformat commands
#+VINDEX: casual-editkit-reformat-tmenu
Commands to reformat text such as filling, centering, and repunctuating
sentences are provided here. Press ~?~ or ~C-h~ to get help for a specific
command.
@@ -140,7 +140,7 @@ Commands to reformat text such as filling, centering, and
repunctuating sentence
[[file:images/casual-editkit-reformat-screenshot.png]]
-#+TEXINFO: @subheading Rectangle›
+#+TEXINFO: @subheading Rectangle› (casual-editkit-rectangle-tmenu)
#+CINDEX: Rectangle commands
#+VINDEX: casual-editkit-rectangle-tmenu
@@ -153,17 +153,22 @@ Users wishing more direct access to this menu can bind
~casual-editkit-rectangle
*** Window management
#+CINDEX: Window management
-#+VINDEX: casual-editkit-window-tmenu
-This menu provides support for different Emacs window management commands.
Note that in Emacs, a window ([[info:elisp#Basic Windows]]) is defined
differently than its usage in contemporary graphical user interfaces.
+#+VINDEX: casual-editkit-windows-tmenu
+The menu ~casual-editkit-windows-tmenu~ provides support for different Emacs
window management commands. Note that in Emacs, a window ([[info:elisp#Basic
Windows]]) is defined differently than its usage in contemporary graphical user
interfaces.
[[file:images/casual-editkit-window-screenshot.png]]
Note that the section “Transpose” is only available if the package
[[https://melpa.org/#/transpose-frame][transpose-frame]] is installed.
+Users wishing more direct access to this menu can bind
~casual-editkit-windows-tmenu~ as shown in the [[#editkit-install][install
section]].
+
+
If the variable ~casual-lib-use-unicode~ is set to ~t~, then Unicode symbols
are used in the labels.
[[file:images/casual-editkit-window-unicode-screenshot.png]]
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
#+TEXINFO: @subheading Window Deletion
#+CINDEX: Window deletion
#+VINDEX: casual-editkit-window-delete-tmenu
@@ -175,28 +180,28 @@ This menu provides support for deleting windows. Note the
commands apply to othe
*** Search & Replace commands
#+CINDEX: Search & Replace commands
#+VINDEX: casual-editkit-search-tmenu
-Operations related to search and replace are captured by this menu. Note that
this menu uses Transient prefix arguments (~--backward~ and ~--regexp~). This
is because some commands have variants involving direction and whether to
search using a regexp. Commands that support direction will by default operate
forward of the current point if ~--backward~ is not enabled.
+Operations related to search and replace are captured by the menu
~casual-editkit-search-tmenu~. Note that this menu uses Transient prefix
arguments (~--backward~ and ~--regexp~). This is because some commands have
variants involving direction and whether to search using a regexp. Commands
that support direction will by default operate forward of the current point if
~--backward~ is not enabled.
[[file:images/casual-editkit-search-screenshot.png]]
*** Open commands
#+CINDEX: Open commands
#+VINDEX: casual-editkit-open-tmenu
-Commands related to opening a file (either for writing or read-only) are
supported here. Included are commands for visiting and renaming a file or
buffer. The *Project* sub-menu is also offered here.
+Commands related to opening a file (either for writing or read-only) are
supported by the menu ~casual-editkit-open-tmenu~. Included are commands for
visiting and renaming a file or buffer. The *Project* sub-menu is also offered
here.
[[file:images/casual-editkit-open-screenshot.png]]
*** Project commands
#+CINDEX: Project commands
#+VINDEX: casual-editkit-project-tmenu
-Project-related commands are listed in this menu.
+Project-related commands are listed in the menu ~casual-editkit-project-tmenu~.
[[file:images/casual-editkit-project-screenshot.png]]
*** Bookmark commands
#+CINDEX: Bookmark commands
#+VINDEX: casual-editkit-bookmarks-tmenu
-Commands edit, add, or jump to a bookmark are captured in this menu.
+Commands edit, add, or jump to a bookmark are captured in the menu
~casual-editkit-bookmarks-tmenu~.
[[file:images/casual-editkit-bookmarks-screenshot.png]]
@@ -204,21 +209,21 @@ Commands edit, add, or jump to a bookmark are captured in
this menu.
#+CINDEX: Emoji & Symbols
#+VINDEX: casual-editkit-emoji-symbol-tmenu
-Insert emoji and symbol characters with this menu. Smart quotes are also
supported by this menu and can be applied to a text region. This menu also
offers the command ~electric-quote-mode~ which is bound to {{{kbd(Q)}}}.
+Insert emoji and symbol characters with the menu
~casual-editkit-emoji-symbol-tmenu~. Smart quotes are also supported by this
menu and can be applied to a text region. This menu also offers the command
~electric-quote-mode~ which is bound to {{{kbd(Q)}}}.
[[file:images/casual-editkit-emoji-symbols-screenshot.png]]
*** Tool commands
#+CINDEX: Tool commands
#+VINDEX: casual-editkit-tools-tmenu
-This menu holds an assorted collection of different tools/utilities provided
by Emacs. Motivated users can use this Transient prefix as starting point to
create a menu customized to their needs.
+The menu ~casual-editkit-tools-tmenu~ holds an assorted collection of
different tools/utilities provided by Emacs. Motivated users can use this
Transient prefix as starting point to create a menu customized to their needs.
[[file:images/casual-editkit-tools-screenshot.png]]
*** Narrow/Widen Commands
#+CINDEX: Narrow/Widen Commands
#+VINDEX: casual-editkit-narrow-tmenu
-Support for narrowing and widening ([[info:emacs#Narrowing]]) a buffer is
supported. Mode specific narrowing behavior is supported for Org and
~prog-mode~ derived buffers.
+Support for narrowing and widening ([[info:emacs#Narrowing]]) a buffer is
supported by the menu ~casual-editkit-narrow-tmenu~. Mode specific narrowing
behavior is supported for Org and ~prog-mode~ derived buffers.
[[file:images/casual-editkit-narrow-screenshot.png]]
@@ -236,14 +241,14 @@ This menu can be modified ([[info:transient#Modifying
Existing Transients]]) to
*** Macro
#+CINDEX: Macro commands
#+VINDEX: casual-editkit-macro-tmenu
-Commands for managing macros are provided for by this menu. Note that macro
creation commands are /not/ supported as they are tightly-bound to keybindings.
+Commands for managing macros are provided for by the menu
~casual-editkit-macro-tmenu~. Note that macro creation commands are /not/
supported as they are tightly-bound to keybindings.
[[file:images/casual-editkit-macro-screenshot.png]]
*** EditKit Settings
#+CINDEX: EditKit Settings
#+VINDEX: casual-editkit-settings-tmenu
-Configuration of common editing-related settings are provided here. Most all
settings are set via the ~customize-variable~ interface with the following
exceptions for:
+Configuration of common editing-related settings are provided by the menu
~casual-editkit-settings-tmenu~. Most all settings are set via the
~customize-variable~ interface with the following exceptions for:
- “Auto-fill Mode (~auto-fill-mode~)”
- “Indent Tabs Mode (~indent-tabs-mode~)”
diff --git a/docs/elisp.org b/docs/elisp.org
index 943b808121..2c86e37551 100644
--- a/docs/elisp.org
+++ b/docs/elisp.org
@@ -49,8 +49,18 @@ Using the command prefix {{{kbd(C-u)}}} when
~casual-elisp-tmenu~ is raised will
[[file:images/casual-elisp-edebug-screenshot.png]]
+
+#+TEXINFO: @subheading Elisp Settings
+#+VINDEX: casual-elisp-settings-tmenu
+
+The menu ~casual-elisp-settings-tmenu~ provides access to different
~emacs-lisp-mode~ settings.
+
+# TODO: Insert screenshot
+
#+TEXINFO: @subheading Elisp Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Elisp will use Unicode symbols as appropriate in its menus.
[[file:images/casual-elisp-unicode-screenshot.png]]
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/eshell.org b/docs/eshell.org
index 9b28f51c86..b677b9d01b 100644
--- a/docs/eshell.org
+++ b/docs/eshell.org
@@ -37,6 +37,21 @@ The following sections are offered in the menu:
[[file:images/casual-eshell-process-screenshot.png]]
+
+#+TEXINFO: @subheading Eshell Settings
+#+VINDEX: casual-eshell-settings-tmenu
+
+The menu ~casual-eshell-settings-tmenu~ provides access to different
~eshell-mode~ settings.
+
+# TODO: Insert screenshot
+
+#+TEXINFO: @subheading Eshell Info
+#+VINDEX: casual-eshell-info-tmenu
+
+The menu ~casual-eshell-info-tmenu~ provides access to different ~eshell-mode~
documentation in its Info manual.
+
+# TODO: Insert screenshot
+
#+TEXINFO: @subheading Eshell Unicode Symbol Support
@@ -46,3 +61,4 @@ By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the
Settings menu, Casua
[[file:images/casual-eshell-unicode-screenshot.png]]
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/eww.org b/docs/eww.org
index f152ae9f4e..6eddffa2ab 100644
--- a/docs/eww.org
+++ b/docs/eww.org
@@ -83,7 +83,7 @@ Customize common EWW settings from this menu. These settings
can be persisted to
#+TEXINFO: @subheading EWW Display
#+VINDEX: casual-eww-display-tmenu
-This menu (~casual-eww-display-tmenu~) provides commands to toggle different
display attributes of a web page.
+The menu ~casual-eww-display-tmenu~ provides commands to toggle different
display attributes of a web page.
[[file:images/casual-eww-display-screenshot.png]]
@@ -91,7 +91,7 @@ This menu (~casual-eww-display-tmenu~) provides commands to
toggle different dis
#+TEXINFO: @subheading EWW Bookmarks
#+VINDEX: casual-eww-bookmarks-tmenu
-This menu (~casual-eww-bookmarks-tmenu~) provides commands for managing the
EWW bookmark list.
+The menu ~casual-eww-bookmarks-tmenu~ provides commands for managing the EWW
bookmark list.
[[file:images/casual-eww-bookmarks-screenshot.png]]
@@ -102,3 +102,5 @@ Note that the EWW bookmarks list has a very limited feature
set.
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
EWW will use Unicode symbols as appropriate in its menus.
[[file:images/casual-eww-unicode-screenshot.png]]
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/help.org b/docs/help.org
index e950ba7206..a73ec6075a 100644
--- a/docs/help.org
+++ b/docs/help.org
@@ -56,8 +56,16 @@ The following sections are offered in the menu:
- Describe :: Get help for different Elisp types.
- Info :: If available, then open this help topic in [[file:info.org][Info]].
- Source :: Show the Elisp source. If the help displayed is for a customizable
variable, then show a customize menu item.
+
+#+TEXINFO: @subheading Help Mode Settings
+#+VINDEX: casual-help-settings-tmenu
+
+The menu ~casual-help-settings-tmenu~ provides access to different ~help-mode~
settings.
+
+# TODO: Insert screenshot
#+TEXINFO: @subheading Help Mode Unicode Symbol Support
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Man will use Unicode symbols as appropriate in its menus.
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Help will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/html.org b/docs/html.org
index 1188573f1f..642ff5d7ac 100644
--- a/docs/html.org
+++ b/docs/html.org
@@ -59,7 +59,7 @@ This menu provides support for HTML tag-related commands
provided by ~html-mode~
#+TEXINFO: @subheading HTML Settings
#+VINDEX: casual-html-settings-tmenu
-SGML/HTML mode related settings can be customized here.
+SGML/HTML mode related settings can be customized using the menu
~casual-html-settings-tmenu~.
[[file:images/casual-html-settings-screenshot.png]]
@@ -67,3 +67,5 @@ SGML/HTML mode related settings can be customized here.
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
html will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
diff --git a/docs/ibuffer.org b/docs/ibuffer.org
index c7acf7f46f..f6f5b9930a 100644
--- a/docs/ibuffer.org
+++ b/docs/ibuffer.org
@@ -83,6 +83,8 @@ Note that the menu item “{{{kbd(RET)}}} Visit/Toggle” has "do
what I mean"
As with other Casual user interfaces, the ability to jump to a bookmark is
available.
+# TODO: Need to add operations, mark, mark-regexp tmenus
+
*** IBuffer Filtering
#+VINDEX: casual-ibuffer-filter-tmenu
@@ -168,18 +170,11 @@ Out of the box, it is best to think of the IBuffer
commands for editing buffer f
[[file:images/casual-ibuffer-sortby-screenshot.png]]
-The buffer list can be sorted using different criteria as shown in the
screenshot above.
+The buffer list can be sorted using different criteria using the menu
~casual-ibuffer-sortby-tmenu~.
Sort ordering can be reversed via the /Invert/ command.
*** IBuffer Unicode Symbol Support
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
IBuffer will use Unicode symbols as appropriate in its menus. The following
mapping is shown in the table below:
-
-| Name | Plain | Unicode |
-|-----------+----------+---------|
-| :previous | Previous | ↑ |
-| :next | Next | ↓ |
-| :marked | Marked | ❯ |
-| :group | Group | [] |
-| :jump | Jump | 🚀 |
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
IBuffer will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/image.org b/docs/image.org
index 5e8d405c91..ca227a5d65 100644
--- a/docs/image.org
+++ b/docs/image.org
@@ -45,6 +45,7 @@ The main menu for Casual Image (~casual-image-tmenu~) is
organized into the foll
*** Image Resize
#+CINDEX: Image Resize
+#+VINDEX: casual-image-resize-tmenu
If ImageMagick (version 6 or 7) is installed, Casual Image can resize an image
using it. The Transient ~casual-image-resize-tmenu~ is a streamlined interface
to the ImageMagick ~-resize~ function.
@@ -57,9 +58,18 @@ Note that if the image file has been modified, the resize
interface will be disa
- (o) Output to another file - If enabled, then the user will be prompted for
a different output file, else it will /irreversibly/ update the current image
file.
- (t) Type - Specify if /adaptive/ or /interpolative/ resizing should be used.
If nothing is specified then /standard/ resizing is used.
+*** Image Settings
+#+VINDEX: casual-image-settings-tmenu
+
+The menu ~casual-image-settings-tmenu~ provides access to different
~image-mode~ settings.
+
+# TODO: Insert screenshot
+
*** Image Unicode Symbol Support
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Image will use Unicode symbols as appropriate in its menus.
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Image will use Unicode symbols as appropriate in its menus.
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
*** Image Mode Command Naming
diff --git a/docs/info.org b/docs/info.org
index 71580bc1f6..b5cbf1fd1b 100644
--- a/docs/info.org
+++ b/docs/info.org
@@ -70,3 +70,4 @@ The main menu for Casual Info is organized into the following
sections:
#+TEXINFO: @subheading Info Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Info will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/isearch.org b/docs/isearch.org
index d67fe87344..65c910252d 100644
--- a/docs/isearch.org
+++ b/docs/isearch.org
@@ -40,3 +40,20 @@ The main menu for Casual I-Search is organized into the
following sections:
When in search mode (typically via the keybinding {{{kbd(C-s)}}} or
{{{kbd(C-r)}}}), pressing the keybinding {{{kbd(C-o)}}} (or binding of your
preference) will raise the Transient menu ~casual-isearch-tmenu~. Once raised,
only the /I-Search/ commands in the *Toggle*, *Replace*, and *Misc* sections
will automatically dismiss the menu when selected. All other /I-Search/
commands will /not/ dismiss the menu.
Use {{{kbd(C-g)}}} to dismiss this Transient menu.
+
+
+#+TEXINFO: @subheading I-Search Settings
+#+VINDEX: casual-isearch-settings-tmenu
+
+The menu ~casual-isearch-settings-tmenu~ provides access to different I-Search
settings.
+
+# TODO: Insert screenshot
+
+#+TEXINFO: @subheading I-Search Unicode Symbol Support
+
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
I-Search will use Unicode symbols as appropriate in its menus.
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
+
+
diff --git a/docs/make-mode.org b/docs/make-mode.org
index 7107ddb0d0..0c1de07a37 100644
--- a/docs/make-mode.org
+++ b/docs/make-mode.org
@@ -45,6 +45,7 @@ As there are different variants of *make* and makefile
formats, you can configur
[[file:images/casual-make-mode-select-screenshot.png]]
+The symbol for this menu is ~casual-make-mode-select-tmenu~.
*** Automatic Variables
#+CINDEX: Automatic Variables
@@ -54,7 +55,10 @@ Casual Make provides a menu to enter GNU Make-style
[[info:make#Automatic Variab
[[file:images/casual-make-automatic-variables-screenshot.png]]
+The symbol for this menu is ~casual-make-automatic-variables-tmenu~.
*** Make Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Make will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
diff --git a/docs/man.org b/docs/man.org
index 08fc4583b0..bcc125baf9 100644
--- a/docs/man.org
+++ b/docs/man.org
@@ -60,10 +60,12 @@ The following sections are offered in the menu:
- Page :: If the Man page reader is configured to display all manual pages for
a given search key, navigation commands for multiple pages is provided.
#+TEXINFO: @subheading Options Navigation
+#+VINDEX: casual-man-occur-options
~casual-man-tmenu~ provides the menu item {{{kbd(o)}}} which runs the command
~casual-man-occur-options~. This will invoke ~occur~ with a regexp that
searches for command line options (for example, "--foo", "-a") that can be
navigated via the ~occur~ interface.
#+TEXINFO: @subheading Man Settings
+#+VINDEX: casual-man-settings-tmenu
By default, the Man page reader will /not/ display all manual pages for given
search key. This can be changed in the Settings menu
~casual-man-settings-tmenu~ that can be invoked by pressing {{{kbd(\,)}}} in
~casual-man-tmenu~.
@@ -75,3 +77,5 @@ Press ‘s’ and configure ~Man-switches~ to have the value "-a"
to get all man
#+TEXINFO: @subheading Man Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Man will use Unicode symbols as appropriate in its menus.
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/re-builder.org b/docs/re-builder.org
index 558b72c878..8b70460291 100644
--- a/docs/re-builder.org
+++ b/docs/re-builder.org
@@ -52,13 +52,16 @@ Once a desired regexp pattern is defined, there are two
menu items that can be u
The menu item {{{kbd(i)}}} will invoke the Info page for regexp syntax with
respect to the current syntax type.
#+TEXINFO: @subheading Quitting RE-Builder
-Select “{{{kbd(q)}}} Quit” to exit the RE-Builder tool.
+Select “{{{kbd(q)}}} Quit” to exit the RE-Builder tool.
-#+TEXINFO: @subheading RE-Builder Unicode Symbol Support
-By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
RE-Builder will use Unicode symbols as appropriate in its menus. The following
mapping is shown in the table below:
+#+TEXINFO: @subheading RE-Builder Settings
+#+VINDEX: casual-re-builder-settings-tmenu
+
+The menu ~casual-re-builder-settings-tmenu~ provides access to different
RE-Builder settings.
-| Name | Plain | Unicode |
-|-----------+----------+---------|
-| :previous | Previous | ↑ |
-| :next | Next | ↓ |
+# TODO: Insert screenshot
+
+#+TEXINFO: @subheading RE-Builder Unicode Symbol Support
+By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
RE-Builder will use Unicode symbols as appropriate in its menus.
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
diff --git a/docs/timezone.org b/docs/timezone.org
index d4a8eb0dcd..64e4a4dfba 100644
--- a/docs/timezone.org
+++ b/docs/timezone.org
@@ -35,6 +35,7 @@ The main menu for Casual Timezone (~casual-timezone-tmenu~)
offers the following
#+TEXINFO: @subheading Timezone Planner
+#+VINDEX: casual-timezone-planner
[[file:images/casual-timezone-planner-screenshot.png]]
@@ -44,7 +45,6 @@ In this table, the point can be navigated using the
{{{kbd(p)}}}, {{{kbd(n)}}},
Use the {{{kbd(T)}}} binding to copy the timestamp under the current point to
the ~kill-ring~. The {{{kbd(t)}}} binding will copy all timestamps on the
current line to the ~kill-ring~.
-
*** Timezone Formatting
#+VINDEX: casual-timezone-datestamp-format
#+VINDEX: casual-timezone-convert-datestamp-format
@@ -84,5 +84,15 @@ These variables can be customized via the Transient menu
~casual-timezone-settin
The variable ~casual-timezone-zone-info-database~ is default set to the path
"/usr/share/zoneinfo/tzdata.zi". Customize this variable if the zoneinfo
database is located at a different path.
+*** Timezone Settings
+#+VINDEX: casual-timezone-settings-tmenu
+
+The menu ~casual-timezone-settings-tmenu~ provides access to different Casual
Timezone settings.
+
+# TODO: Insert screenshot
+
*** Timezone Unicode Symbol Support
By enabling “{{{kbd(u)}}} Use Unicode Symbols” from the Settings menu, Casual
Timezone will use Unicode symbols as appropriate in its menus.
+
+For more info on using Unicode symbols, please refer to [[#ux-conventions][UX
Conventions]].
+
