This package has been superseded by the package casual. Please install the package casual from either MELPA or MELPA stable.
Upon installation and upgrade of casual, this package will be uninstalled from your Emacs configuration. Please revisit your configuration of Casual Agenda in your initialization file(s) accordingly.
This repository should be treated as an archive. All future development on Casual Agenda will be done in the Casual repository.
An opinionated Transient-based user interface for Org Agenda, a feature of Emacs Org mode to help plan your day.
While highly functional, Org Agenda has a steep learning curve as it has a very diverse command set. Menus are a user interface (UI) affordance that offer users discoverability and recognition that can lower Org Agenda’s learning curve. While menus are commonly associated with mouse-driven UI, the inclusion of Transient in Emacs core allows for a menu UI that is keyboard-driven. Casual Agenda endeavors to offer this as many Emacs users prefer keyboard-driven workflows.
- To provide a keyboard-driven menu UI for Org Agenda.
- To provide casual access to the Org Agenda command set.
- Full coverage of all Org Agenda commands. Casual Agenda is not intended to be a power user tool.
- Strict adherence to Org Agenda command naming. While Casual Agenda is mostly in alignment with Org Agenda’s command naming, there are cases where it will make an opinionated change if the name is deemed too vague or idiomatic.
- UX Stability (for now). Given that Casual Agenda is early in its life-cycle, expect changes to its user experience in terms of menu hierarchy and keybinding choices in future releases.
Casual Agenda requires usage of
- Emacs ≥ 29.1
- Org ≥ 9.7.1
Casual Agenda has been verified with the following configuration.
- Emacs 29.4 (macOS 14.6, Ubuntu Linux 22.04.4 LTS)
- Org 9.7.9
As Casual Agenda is new, we are looking for early adopters! Your feedback is welcome as it will likely impact Casual Agenda’s evolution, particularly with regards to UI.
If installed via MELPA then add these lines to your Emacs initialization file with your binding of preference.
(require 'casual-agenda) ; optional
(keymap-set org-agenda-mode-map "C-o" #'casual-agenda-tmenu)If you use use-package, here is the recipe for installing it.
(use-package casual-agenda
:ensure nil
:bind (:map
org-agenda-mode-map
("C-o" . casual-agenda-tmenu))
:after (org-agenda))Casual Agenda requires a recent installation of both Org (9.7.1+ from GNU ELPA) and Transient (0.6.0+ from either MELPA or ELPA). As both these packages are built-in, the package manager package.el will not update either of these packages unless the customizable variable package-install-upgrade-built-in is set to t. If your setup does not have the latest Transient update, you will see the following error when trying to run casual-agenda-tmenu:
Loading casual-agenda.el
casual-agenda.el:Error: Emacs 29.4:
(invalid-slot-name "#<transient-prefix transient-prefix-157ade83abb6>" :refresh-suffixes)Again, set the variable package-install-upgrade-built-in to t to upgrade both Org and Transient. Alternately, invoke package-install with a prefix argument which will override the default setting of package-install-upgrade-built-in and upgrade a built-in package. (example: C-u M-x package-install casual-agenda)
As Transient is closely tied to Magit, installing the latest version of Magit (via non-GNU ELPA or MELPA) can also pick up the latest version of Transient.
Use these bindings to configure Org Agenda to be consistent with bindings used by Casual Agenda. This is optional.
; bindings to make jumping consistent between Org Agenda and Casual Agenda
(keymap-set org-agenda-mode-map "M-j" #'org-agenda-clock-goto) ; optional
(keymap-set org-agenda-mode-map "J" #'bookmark-jump) ; optionalIf you use use-package, modify your configuration as follows:
(use-package casual-agenda
:ensure nil
:bind (:map
org-agenda-mode-map
("C-o" . casual-agenda-tmenu)
("M-j" . org-agenda-clock-goto) ; optional
("J" . bookmark-jump))) ; optionalThe main menu is divided into five sections:
- Agenda - Modify the view duration (day, week, 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 - move the point to where you want it to be.
- Utils - Set a timer, get almanac info.
By enabling “(u) Use Unicode Symbols” from the Settings menu, Casual Agenda will use Unicode symbols as appropriate in its menus.
Use the Operations menu to alter attributes about it such as TODO state, scheduling, tags, and priority. To use it, move the point to the line of a heading you wish to change and from the main menu select “(o) Operations”. The following menu will be displayed.
User the Mark menu to mark different headlines and perform a bulk action on them. From the main menu, select “(m) Mark” to display the following menu:
Agenda views have different display modes and behavior that can be modified from the Settings menu. From the main menu, select “(,) Settings” to display the following menu:
Get sunrise/sunset times, lunar cycle dates, and holidays with respect to a date via the Almanac menu. From the main menu, select “(l) Almanac” to display the following menu.
Casual Agenda is built using Transient menus and as such adopts much of its default behavior.
Each menu item has a key and a label. The key is what is typed by the user to select the menu item. A key can be prefixed with a meta (M-) or control (C-) key.
Dismissing a menu regardless of how deep you are in sub-menus can be done by entering C-q. A menu can also be dismissed by entering C-g, which will return you to the previous menu.
If a mouse is available, a menu item can be selected by moving the mouse cursor over its label and pressing down button 1.
Pressing the ? key will toggle help for all the menu items. Press the key of interest to get help for it.
Menu items can also take a prefix argument if supported. Enter C-u and optionally a value before selecting a menu item.
For users who wish to help contribute to Casual Agenda or personally customize it for their own usage, please read the developer documentation.
If you enjoy using Casual Agenda, consider making a modest financial contribution to help support its development and maintenance.
Casual Agenda is part of a suite of user interfaces for different Emacs packages.
To get all current and future Casual user interfaces, please install Casual Suite from MELPA.
User Interfaces currently supported by Casual are listed below:
- Casual Dired - a Transient user interface for the Dired file manager.
- Casual Calc - a Transient user interface for Calc.
- Casual I-Search - a Transient menu for I-Search.
- Casual Bookmarks - a Transient user interface for the bookmark list.
- Casual Info - a Transient user interface for the Info reader.
- Casual IBuffer - a Transient user interface for IBuffer.
- Casual RE-Builder - a Transient user interface for RE-Builder.
- Casual Avy - a Transient user interface for Avy.
Users who prefer finer grained control over package installation can install each user interface above individually.
A heartfelt thanks to all the contributors to Org Mode and Transient. Casual Agenda would not be possible without your efforts.