Skip to content

Commit

Permalink
Rename org-gtd-agenda.el to org-gtd-engage.el
Browse files Browse the repository at this point in the history
This renaming aligns it with the name for step 5 of the GTD methodology.
Command org-gtd-show-all-next renamed to org-gtd-engage-next as well.

Resolves: Trevoke#165
  • Loading branch information
doolio committed May 22, 2023
1 parent ef97879 commit 5083df7
Show file tree
Hide file tree
Showing 11 changed files with 95 additions and 85 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.org
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
* Unreleased
** Changed
- Command org-gtd-show-all-next renamed to org-gtd-engage-next
- File org-gtd-agenda.el renamed to org-gtd-engage.el
* 3.0.0
** Functions exist to create your own hooks
Make GTD truly a part of your emacs experience.
Expand Down
8 changes: 4 additions & 4 deletions doc/org-gtd.org
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ My org-gtd config for 1.x was as follows:
(("C-c d c" . org-gtd-capture)
("C-c d a" . org-agenda-list)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -357,7 +357,7 @@ And my config for 2.0 is:
(("C-c d c" . org-gtd-capture)
("C-c d e" . org-gtd-engage)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -523,7 +523,7 @@ If you are a Doom Emacs user, then your configuration may look something like th
:desc "Capture" "c" #'org-gtd-capture
:desc "Engage" "e" #'org-gtd-engage
:desc "Process inbox" "p" #'org-gtd-process-inbox
:desc "Show all next" "n" #'org-gtd-show-all-next
:desc "Show all next" "n" #'org-gtd-engage-next
:desc "Stuck projects" "s" #'org-gtd-review-stuck-projects))
(map! :map org-gtd-clarify-map
:desc "Organize this item" "C-c c" #'org-gtd-organize))
Expand Down Expand Up @@ -676,7 +676,7 @@ Here is an example:

You can see a list of all NEXT actions, and scheduled actions, with ~M-x org-gtd-engage~ .

You can call ~org-gtd-show-all-next~ to only see NEXT actions, nothing scheduled.
You can call ~org-gtd-engage-next~ to only see NEXT actions, nothing scheduled.

You can use ~org-gtd-oops~ to see all the appointments you missed, and act on them accordingly.

Expand Down
8 changes: 4 additions & 4 deletions doc/org-gtd.texi
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ My org-gtd config for 1.x was as follows:
(("C-c d c" . org-gtd-capture)
("C-c d a" . org-agenda-list)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -651,7 +651,7 @@ And my config for 2.0 is:
(("C-c d c" . org-gtd-capture)
("C-c d e" . org-gtd-engage)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -906,7 +906,7 @@ If you are a Doom Emacs user, then your configuration may look something like th
:desc "Capture" "c" #'org-gtd-capture
:desc "Engage" "e" #'org-gtd-engage
:desc "Process inbox" "p" #'org-gtd-process-inbox
:desc "Show all next" "n" #'org-gtd-show-all-next
:desc "Show all next" "n" #'org-gtd-engage-next
:desc "Stuck projects" "s" #'org-gtd-review-stuck-projects))
(map! :map org-gtd-clarify-map
:desc "Organize this item" "C-c c" #'org-gtd-organize))
Expand Down Expand Up @@ -1147,7 +1147,7 @@ Here is an example:

You can see a list of all NEXT actions, and scheduled actions, with @code{M-x org-gtd-engage} .

You can call @code{org-gtd-show-all-next} to only see NEXT actions, nothing scheduled.
You can call @code{org-gtd-engage-next} to only see NEXT actions, nothing scheduled.

You can use @code{org-gtd-oops} to see all the appointments you missed, and act on them accordingly.

Expand Down
2 changes: 1 addition & 1 deletion org-gtd-archive.el
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
(require 'org-element)

(require 'org-gtd-core)
(require 'org-gtd-agenda)
(require 'org-gtd-engage)

;;;; Customization

Expand Down
38 changes: 20 additions & 18 deletions org-gtd-autoloads.el
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,6 @@

(register-definition-prefixes "org-gtd" '("org-gtd-"))

;;;***

;;;### (autoloads nil "org-gtd-agenda" "org-gtd-agenda.el" (0 0 0
;;;;;; 0))
;;; Generated autoloads from org-gtd-agenda.el

(autoload 'org-gtd-engage "org-gtd-agenda" "\
Display `org-agenda' customized by org-gtd." t nil)

(autoload 'org-gtd-show-all-next "org-gtd-agenda" "\
Show all next actions from all agenda files in a single list.
This assumes all GTD files are also agenda files." t nil)

(autoload 'org-gtd-engage-grouped-by-context "org-gtd-agenda" "\
Show all `org-gtd-next' actions grouped by context (tag prefixed with @)." t nil)

(register-definition-prefixes "org-gtd-agenda" '("org-gtd-agenda--prefix-format"))

;;;***

;;;### (autoloads nil "org-gtd-archive" "org-gtd-archive.el" (0 0
Expand Down Expand Up @@ -159,6 +141,26 @@ Delegate item at point on agenda view." t nil)

(register-definition-prefixes "org-gtd-delegate" '("org-gtd-delegate"))

;;;***

;;;### (autoloads nil "org-gtd-engage" "org-gtd-engage.el" (0 0 0
;;;;;; 0))
;;; Generated autoloads from org-gtd-engage.el

(autoload 'org-gtd-engage "org-gtd-engage" "\
Display `org-agenda' customized by org-gtd." t nil)

(autoload 'org-gtd-engage-grouped-by-context "org-gtd-engage" "\
Show all `org-gtd-next' actions grouped by context (tag prefixed with @)." t nil)

(autoload 'org-gtd-engage-next "org-gtd-engage" "\
Show all next actions from all agenda files in a single list.
This assumes all GTD files are also agenda files." t nil)

(defalias 'org-gtd-show-all-next 'org-gtd-engage-next)

(if (fboundp 'register-definition-prefixes) (register-definition-prefixes "org-gtd-engage" '("org-gtd-agenda--prefix-format")))

;;;***

;;;### (autoloads nil "org-gtd-files" "org-gtd-files.el" (0 0 0 0))
Expand Down
12 changes: 8 additions & 4 deletions org-gtd-agenda.el → org-gtd-engage.el
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;;; org-gtd-agenda.el --- Manage the agenda view -*- lexical-binding: t; coding: utf-8 -*-
;;; org-gtd-engage.el --- Engage actionable tasks -*- lexical-binding: t; coding: utf-8 -*-
;;
;; Copyright © 2019-2023 Aldric Giacomoni

Expand Down Expand Up @@ -80,14 +80,18 @@
(org-agenda nil "g"))))

;;;###autoload
(defun org-gtd-show-all-next ()
(defun org-gtd-engage-next ()
"Show all next actions from all agenda files in a single list.
This assumes all GTD files are also agenda files."
(interactive)
(org-gtd-core-prepare-agenda-buffers)
(with-org-gtd-context
(org-todo-list org-gtd-next)))

;;;###autoload
(defalias 'org-gtd-show-all-next 'org-gtd-engage-next)
(make-obsolete 'org-gtd-show-all-next "use `org-gtd-engage-next' instead." "3.0.0")

;;;; Functions

;;;;; Private
Expand All @@ -114,6 +118,6 @@ This assumes all GTD files are also agenda files."

;;;; Footer

(provide 'org-gtd-agenda)
(provide 'org-gtd-engage)

;;; org-gtd-agenda.el ends here
;;; org-gtd-engage.el ends here
2 changes: 1 addition & 1 deletion org-gtd-organize.el
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
(require 'org-gtd-single-action)
(require 'org-gtd-trash)
(require 'org-gtd-delegate)
(require 'org-gtd-agenda)
(require 'org-gtd-engage)
(require 'org-gtd-projects)
(require 'org-gtd-refile)
(require 'org-gtd-process)
Expand Down
2 changes: 1 addition & 1 deletion org-gtd-process.el
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

(require 'org-gtd-core)
(require 'org-gtd-capture)
(require 'org-gtd-agenda)
(require 'org-gtd-engage)
(require 'org-gtd-projects)
(require 'org-gtd-refile)
(require 'org-gtd-clarify)
Expand Down
2 changes: 1 addition & 1 deletion org-gtd-review.el
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
(require 'org-gtd-core)
(require 'org-gtd-areas-of-focus)
(require 'org-gtd-skip)
(require 'org-gtd-agenda)
(require 'org-gtd-engage)
(require 'org-gtd-projects)

;;;; Commands
Expand Down
2 changes: 1 addition & 1 deletion org-gtd.el
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
(require 'org-gtd-capture)
(require 'org-gtd-refile)
(require 'org-gtd-projects)
(require 'org-gtd-agenda)
(require 'org-gtd-engage)
(require 'org-gtd-organize)
(require 'org-gtd-process)
(require 'org-gtd-mode)
Expand Down
100 changes: 50 additions & 50 deletions org-gtd.info
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ File: org-gtd.info, Node: 200 <- 11x, Prev: 210 <- 200, Up: Upgrading
(("C-c d c" . org-gtd-capture)
("C-c d a" . org-agenda-list)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -645,7 +645,7 @@ File: org-gtd.info, Node: 200 <- 11x, Prev: 210 <- 200, Up: Upgrading
(("C-c d c" . org-gtd-capture)
("C-c d e" . org-gtd-engage)
("C-c d p" . org-gtd-process-inbox)
("C-c d n" . org-gtd-show-all-next)
("C-c d n" . org-gtd-engage-next)
("C-c d s" . org-gtd-show-stuck-projects)
:map org-gtd-process-map
("C-c c" . org-gtd-choose)))
Expand Down Expand Up @@ -952,7 +952,7 @@ like this:
:desc "Capture" "c" #'org-gtd-capture
:desc "Engage" "e" #'org-gtd-engage
:desc "Process inbox" "p" #'org-gtd-process-inbox
:desc "Show all next" "n" #'org-gtd-show-all-next
:desc "Show all next" "n" #'org-gtd-engage-next
:desc "Stuck projects" "s" #'org-gtd-review-stuck-projects))
(map! :map org-gtd-clarify-map
:desc "Organize this item" "C-c c" #'org-gtd-organize))
Expand Down Expand Up @@ -1241,8 +1241,8 @@ File: org-gtd.info, Node: Engaging with your GTD items, Next: Working with the
You can see a list of all NEXT actions, and scheduled actions, with ‘M-x
org-gtd-engage’ .

You can call ‘org-gtd-show-all-next’ to only see NEXT actions,
nothing scheduled.
You can call ‘org-gtd-engage-next’ to only see NEXT actions, nothing
scheduled.

You can use ‘org-gtd-oops’ to see all the appointments you missed,
and act on them accordingly.
Expand Down Expand Up @@ -1528,51 +1528,51 @@ Ref: Update org-edna trigger20001
Node: 200 <- 11x20770
Ref: Configuration20896
Ref: Example upgrade22288
Ref: Relevant commands with new names25228
Ref: heading states (TODO etc)25445
Ref: Differentiating GTD types of items25604
Ref: Multiple refile targets26971
Ref: Key bindings27823
Node: Installing28100
Node: use-package28395
Node: Manually28607
Node: Configuring28973
Node: The easy way29258
Node: Required configuration of sub-packages29827
Ref: Configuring org-edna30075
Node: configuration options for org-gtd30505
Ref: I don't care just let me start using it30755
Ref: Tell me all the levers I can pull31344
Node: Recommended key bindings35328
Node: Sample Doom Emacs Config36093
Node: Using Org GTD36967
Node: Org-mode building blocks for Org GTD37202
Node: The GTD flow38512
Node: Adding things to the inbox39098
Node: Processing the inbox40318
Node: Clarifying each item40844
Ref: How to start clarifying41360
Ref: data shape requirements41865
Ref: Options and commands related to clarification42426
Node: Organizing an item into the system43620
Ref: Choosing a task type44261
Ref: Applying hooks46394
Ref: Refiling to the appropriate area46881
Ref: New project heading47164
Ref: Other headings47423
Node: Engaging with your GTD items47963
Node: Working with the GTD Horizons48529
Ref: Areas of focus49272
Ref: Longer-term horizons50556
Node: Cleaning up / archiving completed work51363
Node: Commands you can call on org-agenda52228
Node: Defining your own agenda views53133
Node: Adding your own hooks when organizing53675
Node: Automating through emacs54887
Node: Troubleshooting56024
Node: Finding lost tasks56265
Node: Projects without a NEXT item56795
Node: I can't create a project when clarifying an inbox item!57266
Ref: Relevant commands with new names25224
Ref: heading states (TODO etc)25441
Ref: Differentiating GTD types of items25600
Ref: Multiple refile targets26967
Ref: Key bindings27819
Node: Installing28096
Node: use-package28391
Node: Manually28603
Node: Configuring28969
Node: The easy way29254
Node: Required configuration of sub-packages29823
Ref: Configuring org-edna30071
Node: configuration options for org-gtd30501
Ref: I don't care just let me start using it30751
Ref: Tell me all the levers I can pull31340
Node: Recommended key bindings35324
Node: Sample Doom Emacs Config36089
Node: Using Org GTD36961
Node: Org-mode building blocks for Org GTD37196
Node: The GTD flow38506
Node: Adding things to the inbox39092
Node: Processing the inbox40312
Node: Clarifying each item40838
Ref: How to start clarifying41354
Ref: data shape requirements41859
Ref: Options and commands related to clarification42420
Node: Organizing an item into the system43614
Ref: Choosing a task type44255
Ref: Applying hooks46388
Ref: Refiling to the appropriate area46875
Ref: New project heading47158
Ref: Other headings47417
Node: Engaging with your GTD items47957
Node: Working with the GTD Horizons48521
Ref: Areas of focus49264
Ref: Longer-term horizons50548
Node: Cleaning up / archiving completed work51355
Node: Commands you can call on org-agenda52220
Node: Defining your own agenda views53125
Node: Adding your own hooks when organizing53667
Node: Automating through emacs54879
Node: Troubleshooting56016
Node: Finding lost tasks56257
Node: Projects without a NEXT item56787
Node: I can't create a project when clarifying an inbox item!57258

End Tag Table

Expand Down

0 comments on commit 5083df7

Please sign in to comment.