-
Notifications
You must be signed in to change notification settings - Fork 6
/
org-menu.el
1018 lines (914 loc) · 38.1 KB
/
org-menu.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; org-menu.el --- A discoverable menu for org-mode using transient -*- lexical-binding: t; coding: utf-8 -*-
;;
;; Copyright 2021 Jan Rehders
;;
;; Author: Jan Rehders <nospam@sheijk.net>
;; Version: 0.1alpha
;; Package-Requires: ((emacs "26.1") (transient "0.1"))
;; URL: https://github.com/sheijk/org-menu
;;
;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;;
;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;
;;; Commentary:
;;
;; Usage:
;;
;; Add this to your ~/.emacs to bind the menu to `C-c m':
;;
;; (with-eval-after-load 'org
;; (require 'org-menu) ;; not needed if installing by package manager
;; (define-key org-mode-map (kbd "C-c m") 'org-menu))
;;
;; The menu should be pretty self-explanatory. It is context dependent and
;; offers different commands for headlines, tables, timestamps, etc.
;; The task menu provides entry points for task that work from anywhere.
;;
;;; Code:
(require 'org)
(require 'transient)
(require 'org-capture)
(require 'org-timer)
(defgroup org-menu nil
"Options for `org-menu'."
:group 'org)
(defcustom org-menu-use-q-for-quit t
"Whether to add a q binding to quit to all menus.
Use this if you prefer to be consistent with magit. It will also
change some other bindings to use Q instead of q."
:group 'org-menu
:type 'boolean)
(defcustom org-menu-global-toc-depth 10
"The number of heading levels to show when displaying the global content."
:group 'org-menu
:type 'integer)
(defcustom org-menu-expand-snippet-function 'org-menu-expand-snippet-default
"The function used to expand a snippet.
See `org-menu-expand-snippet-default' for a list of snippet ids
which need to be supported. `org-menu-expand-snippet-yasnippet'
shows how to invoke snippets."
:group 'org-menu
:type 'function)
(defun org-menu-show-columns-view-options-p ()
"Return whether `org-columns' mode is active."
(and (boundp 'org-columns-overlays)
(not (null org-columns-overlays))))
(defun org-menu-show-heading-options-p ()
"Whether to show commands operating on headings."
(unless (org-menu-show-columns-view-options-p)
(org-at-heading-p)))
(defun org-menu-show-table-options-p ()
"Whether to show commands operating on tables."
(unless (org-menu-show-columns-view-options-p)
(org-at-table-p)))
(defun org-menu-show-list-options-p ()
"Whether to show commands operating on lists."
(unless (org-menu-show-columns-view-options-p)
(org-at-item-p)))
(defun org-menu-show-text-options-p ()
"Whether to show commands operating on text."
(not (or (org-menu-show-columns-view-options-p)
(org-at-heading-p)
(org-at-table-p)
(org-in-item-p)
(org-in-src-block-p))))
(defun org-menu-show-src-options-p ()
"Whether to show commands operating on src blocks."
(unless (org-menu-show-columns-view-options-p)
(org-in-src-block-p)))
(defun org-menu-show-link-options-p ()
"Whether to show commands operating on links.
Conditions have been adapted from `org-insert-link'"
(unless (org-menu-show-columns-view-options-p)
(or
;; Use variable from org-compat to support Emacs 26
;; this produces a warning in newer Emacs which we can't avoid
(org-in-regexp org-bracket-link-regexp 1)
(when (boundp 'org-link-angle-re)
(org-in-regexp org-link-angle-re))
(when (boundp 'org-link-plain-re)
(org-in-regexp org-link-plain-re)))))
(defun org-menu-show-timestamp-options-p ()
"Whether to show commands operating on timestamps."
(unless (org-menu-show-columns-view-options-p)
(org-at-timestamp-p 'lax)))
(defun org-menu-show-footnote-options-p ()
"Whether to show commands operating on footnotes."
(unless (org-menu-show-columns-view-options-p)
(or (org-footnote-at-definition-p)
(org-footnote-at-reference-p))))
(defun org-menu-heading-navigate-items (check-for-heading &optional cycle-function)
"Items to navigate headings.
These will be added to most sub menus. If `CHECK-FOR-HEADING' is
true the items will only be added if on a heading. `CYCLE-FUNCTION' is the
function to be used to cycle visibility of current element."
(setq cycle-function (or cycle-function #'org-cycle))
`(["Navigate"
,@(when check-for-heading '(:if org-menu-show-heading-options-p))
("p" "prev" org-previous-visible-heading :transient t)
("n" "next" org-next-visible-heading :transient t)
("c" "cycle" ,cycle-function :transient t)
("u" "parent" outline-up-heading :transient t)
("M-p" "prev (same level)" org-backward-heading-same-level :transient t)
("M-n" "next (same level)" org-forward-heading-same-level :transient t)
("M-w" "store link" org-store-link :transient t :if-not region-active-p)
("C-_" "undo" undo :transient t)]))
(defun org-menu-expand-snippet-default (snippet-id)
"Insert a fixed text for each `SNIPPET-ID'."
(pcase snippet-id
('block (insert "#+BEGIN:\n#+END:\n"))
('option (insert "#+"))
('subscript (insert "a_b"))
('superscript (insert "a^b"))
('plot
(insert
"#+plot: type:2d file:\"plot.svg\"
| A | B |
|---+----|
| 1 | 10 |
| 2 | 8 |
| 3 | 9 |
#+attr_org: :width 400px
[[file:plot.svg]]
"))
(_ (insert (format "unknown snippet type %s" snippet-id)))))
(autoload 'yas-expand-snippet "yasnippet")
(autoload 'yas-expand-from-trigger-key "yasnippet")
(defun org-menu-expand-snippet-yasnippet (snippet-id)
"Expand a yasnippet for each `SNIPPET-ID'."
(if (not (require 'yasnippet nil 'noerror))
(message "error: yasnippet not installed, could not expand %s" snippet-id)
(pcase snippet-id
('block
(insert "beg")
(yas-expand-from-trigger-key))
('option
(insert "opt")
(yas-expand-from-trigger-key))
('subscript
(yas-expand-snippet "${1:text}_{${2:sub}}"))
('superscript
(yas-expand-snippet "${1:text}^{${2:super}}"))
('plot
(yas-expand-snippet
"#+plot: type:${1:2d} file:\"${2:plot.svg}\"
| A | B |
|---+----|
| 1 | 10 |
| 2 | 8 |
| 3 | 9 |
#+attr_org: :width ${3:400px}
[[file:$2]]
"))
(_
(insert (format "unknown snippet type %s" snippet-id))))))
;; If yasnippet gets loaded it will be used automatically
(with-eval-after-load 'yasnippet
(unless (equal org-menu-expand-snippet-function #'org-menu-expand-snippet-default)
(setq org-menu-expand-snippet-function #'org-menu-expand-snippet-yasnippet)))
(defun org-menu-expand-snippet (snippet-id)
"Will expand the given snippet named `SNIPPET-ID' with `ARGS'."
(funcall org-menu-expand-snippet-function snippet-id))
(defun org-menu-show-headline-content ()
"Will show the complete content of the current headline and it's children."
(interactive)
(save-excursion
(outline-hide-subtree)
(org-show-children 4)
(org-goto-first-child)
(org-reveal '(4))))
;;;###autoload (autoload 'org-menu-visibility "org-menu" nil t)
(transient-define-prefix org-menu-visibility ()
"A menu to control visibility of `org-mode' items."
["Visibility"
["Heading"
("a" "all" org-show-subtree :if-not org-at-block-p :transient t)
("a" "all" org-hide-block-toggle :if org-at-block-p :transient t)
("c" "cycle" org-cycle :transient t)
("t" "content" org-menu-show-headline-content :if-not org-at-block-p :transient t)
("h" "hide" outline-hide-subtree :if-not org-at-block-p :transient t)
("h" "hide" org-hide-block-toggle :if org-at-block-p :transient t)
("r" "reveal" (lambda () (interactive) (org-reveal t)) :if-not org-at-block-p :transient t)]
["Global"
("C" "cycle global" org-global-cycle :transient t)
("go" "overview" org-overview)
("gt" "content" (lambda () (interactive) (org-content org-menu-global-toc-depth)))
("ga" "all" org-show-all)
("gd" "default" (lambda () (interactive) (org-set-startup-visibility)))]
["Narrow"
("nn" "toggle" org-toggle-narrow-to-subtree)
("nb" "to block" org-narrow-to-block :if org-at-block-p)
("ns" "to sub tree" org-narrow-to-subtree)
("ne" "to element" org-narrow-to-element)
("w" "widen" widen)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(transient-define-prefix org-menu-visibility-columns ()
"A menu to control visibility of `org-mode' items in `org-columns' mode."
["Visibility"
["Columns view"
:if org-menu-show-columns-view-options-p
("t" "content" org-columns-content :transient t)
("o" "overview" org-overview :transient t)
("g" "refresh" org-columns-redo :transient t)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-eval-src-items ()
"Return the items to evaluate a source block."
(list
["Source"
:if org-menu-show-src-options-p
("e" "run block" org-babel-execute-src-block)
("c" "check headers" org-babel-check-src-block)
("k" "clear results" org-babel-remove-result-one-or-many)
("'" "edit" org-edit-special)]))
;;;###autoload (autoload 'org-menu-eval "org-menu" nil t)
(transient-define-prefix org-menu-eval ()
"A menu to evaluate buffers, tables, etc. in `org-mode'."
["dummy"])
(defun org-menu-run-gnuplot ()
"Will call `org-plot/gnuplot' and update inline images."
(interactive)
(org-plot/gnuplot)
(when org-inline-image-overlays
(org-redisplay-inline-images)))
(transient-insert-suffix 'org-menu-eval (list 0)
`["Evaluation"
["Table"
:if org-at-table-p
("e" "table" (lambda () (interactive) (org-table-recalculate 'iterate)))
("1" "one iteration" (lambda () (interactive) (org-table-recalculate t)))
("l" "line" (lambda () (interactive) (org-table-recalculate nil)))
("f" "format" org-table-align :if org-at-table-p)]
,@(org-menu-eval-src-items)
["Heading"
:if-not org-in-src-block-p
("c" "update checkbox count" org-update-checkbox-count)]
["Plot"
("p" "gnuplot" org-menu-run-gnuplot)]
["Export"
("t" "tangle source files" org-babel-tangle)
("x" "export" org-export-dispatch)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-insert-block (str)
"Insert an org mode block of type `STR'."
(interactive)
(insert (format "#+begin_%s\n#+end_%s\n" str str)))
(defun org-menu-insert-horizontal-rule ()
"Insert a horizontal rule."
(interactive)
(insert "-----"))
;;;###autoload (autoload 'org-menu-insert-blocks "org-menu" nil t)
(transient-define-prefix org-menu-insert-blocks ()
"A menu to insert new blocks in `org-mode'."
[["Insert block"
("s" "source" (lambda () (interactive) (org-menu-insert-block "src")))
("e" "example" (lambda () (interactive) (org-menu-insert-block "example")))
("v" "verbatim" (lambda () (interactive) (org-menu-insert-block "verbatim")))
("a" "ascii" (lambda () (interactive) (org-menu-insert-block "ascii")))
("q" "quote" (lambda () (interactive) (org-menu-insert-block "quote")) :if-nil org-menu-use-q-for-quit)
("Q" "quote" (lambda () (interactive) (org-menu-insert-block "quote")) :if-non-nil org-menu-use-q-for-quit)
("d" "dynamic block" org-dynamic-block-insert-dblock)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
;;;###autoload (autoload 'org-menu-insert-heading "org-menu" nil t)
(transient-define-prefix org-menu-insert-heading ()
"A menu to insert new headings in `org-mode'."
[["Heading"
("h" "heading" org-insert-heading)
("H" "heading (after)" org-insert-heading-after-current)
("T" "todo" org-insert-todo-heading)]
["Items"
("d" "drawer" org-insert-drawer)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
;;;###autoload (autoload 'org-menu-insert-template "org-menu" nil t)
(transient-define-prefix org-menu-insert-template ()
"A menu to insert new templates in `org-mode'."
[["Templates"
("S" "structure template" org-insert-structure-template)
("B" "blocks" (lambda () (interactive) (org-menu-expand-snippet 'block)))
("O" "options" (lambda () (interactive) (org-menu-expand-snippet 'option)))]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
;;;###autoload (autoload 'org-menu-insert-timestamp "org-menu" nil t)
(transient-define-prefix org-menu-insert-timestamp ()
"A menu to insert timestamps in Org Mode."
[["Active"
("." "Time stamp" org-time-stamp)
("t" "Today" (lambda () (interactive) (org-insert-time-stamp (current-time) nil nil)))
("n" "Today + time" (lambda () (interactive) (org-insert-time-stamp (current-time) t nil)))]
["Inactive"
("!" "Time stamp (i)" org-time-stamp-inactive)
("T" "Today (i)" (lambda () (interactive) (org-insert-time-stamp (current-time) nil t)))
("N" "Today + time (i)" (lambda () (interactive) (org-insert-time-stamp (current-time) t t)))]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-table-insert-row-below ()
"Insert a new table column below point."
(interactive)
(org-table-insert-row '4))
(defun org-menu-table-insert-column-left ()
"Insert a new column to the left of point."
(interactive)
(org-table-insert-column)
(org-table-move-column-right))
;;;###autoload (autoload 'org-menu-insert-table "org-menu" nil t)
(transient-define-prefix org-menu-insert-table ()
"A menu to insert table items in `org-mode'."
[["Table"
("t" "table" org-table-create-or-convert-from-region :if-not org-at-table-p)
("i" "import" org-table-import :if-not org-at-table-p)]
["Rows/columns"
:if org-at-table-p
("r" "row above" org-table-insert-row :transient t)
("R" "row below" org-menu-table-insert-row-below :transient t)
("c" "column left" org-table-insert-column :transient t)
("C" "column right" org-menu-table-insert-column-left :transient t)
("-" "horiz. line" org-table-insert-hline :transient t)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-insert-superscript ()
"Insert a text with superscript."
(interactive)
(org-menu-expand-snippet 'superscript))
(defun org-menu-insert-subscript ()
"Insert a text with subscript."
(interactive)
(org-menu-expand-snippet 'subscript))
(defun org-menu-parse-formatting (format-char)
"Will return the bounds of the format markup `FORMAT-CHAR'."
(let ((original-point (point))
start end)
(ignore-errors
(save-excursion
(save-restriction
(save-match-data
(org-narrow-to-element)
(goto-char (search-backward (format "%c" format-char)))
(setq start (point))
(goto-char original-point)
(goto-char (search-forward (format "%c" format-char)))
(setq end (point))
(cons start end)))))))
(defun org-menu-toggle-format (format-char)
"Will either remove `FORMAT-CHAR' or add it around region/point."
(let ((range (org-menu-parse-formatting format-char))
(format-string (format "%c" format-char)))
(if (null range)
(org-menu-insert-text format-string format-string t)
(goto-char (cdr range))
(delete-char -1)
(goto-char (car range))
(delete-char 1))))
;;;###autoload (autoload 'org-menu-insert-list "org-menu" nil t)
(transient-define-prefix org-menu-insert-list ()
"A menu to insert lists."
[["List"
("-" "item" (lambda () (interactive) (insert "- ")))
("+" "+" (lambda () (interactive) (insert "+ ")))
("*" "*" (lambda () (interactive) (insert "* ")))
("." "1." (lambda () (interactive) (insert "1. ")))
(")" "1)" (lambda () (interactive) (insert "1) ")))]
["Todo"
("t" "todo" (lambda () (interactive) (insert "- [ ] ")))
("d" "done" (lambda () (interactive) (insert "- [X] ")))
("p" "partial" (lambda () (interactive) (insert "- [-] ")))]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-insert-plot ()
"Insert a small example plot for `gnu-plot'."
(interactive)
(beginning-of-line 1)
(org-menu-expand-snippet 'plot))
(defun org-menu-insert-option-line-smart (line)
"Insert `LINE'. If inside a block move to right before it."
(beginning-of-line 1)
(insert line "\n"))
(defun org-menu-insert-name (name)
"Insert a #+NAME for the next element."
(interactive "MName? ")
(org-menu-insert-option-line-smart (format "#+NAME: %s" name)))
(defun org-menu-insert-caption (caption)
"Insert a #+CAPTION for the next element."
(interactive "MCaption? ")
(org-menu-insert-option-line-smart (format "#+CAPTION: %s" caption)))
(defun org-menu-insert-startup-setting (setting)
"Insert a buffer `SETTING'."
(interactive (list (completing-read "Startup setting? "
(mapcar 'car org-startup-options))))
(org-menu-insert-option-line-smart (format "#+STARTUP: %s" setting)))
(defun org-menu-insert-buffer-setting (setting)
"Insert a buffer `SETTING'."
(interactive (list (completing-read "Buffer setting? " org-options-keywords)))
(insert (format "#+%s " setting)))
(defun org-menu-insert-footnote-definition (name definition)
"Insert a definition for a footnote.
Named `NAME' using `DEFINITION'."
(interactive "MName? \nMDefinition? ")
(org-menu-insert-option-line-smart (format "[fn:%s] %s" name definition)))
(defun org-menu-insert-footnote-inline (name definition)
"Insert a definition for an inline footnote.
Named `NAME' with `DEFINITION'."
(interactive "MName? \nMDefinition? ")
(insert (format "[fn:%s: %s]" name definition)))
;;;###autoload (autoload 'org-menu-insert "org-menu" nil t)
(transient-define-prefix org-menu-insert ()
"A menu to insert new items in `org-mode'."
["Insert"
["Element"
("." "time" org-menu-insert-timestamp)
("l" "link (new)" org-insert-link)
("L" "link (stored)" org-insert-last-stored-link :transient t)
("T" "templates" org-menu-insert-template)]
["Structure"
("h" "heading" org-menu-insert-heading)
("-" "list" org-menu-insert-list)
("H" "hor. rule" org-menu-insert-horizontal-rule)]
["Block/table"
("b" "block" org-menu-insert-blocks)
("t" "table" org-menu-insert-table)
("p" "plot" org-menu-insert-plot)]
["Format"
("^" "superscript" org-menu-insert-superscript)
("_" "subscript" org-menu-insert-subscript)]
["Footnotes"
("fd" "define" org-menu-insert-footnote-definition)
("fi" "inline" org-menu-insert-footnote-inline)]
["Options"
("n" "name" org-menu-insert-name)
("c" "caption" org-menu-insert-caption)
("s" "startup option" org-menu-insert-startup-setting)
("o" "buffer option" org-menu-insert-buffer-setting)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-comment-line ()
"Toggle line comment w/o moving cursor."
(interactive)
(save-excursion (comment-line 1)))
(defun org-menu-fix-timestamp ()
"Fix the timestamp at `(point)'."
(interactive)
(org-timestamp-change 0 'day))
(defun org-menu-insert-text (left right &optional surround-whitespace)
"Will insert left|right and put the curser at |.
If region is active it will be surrounded by `LEFT' and `RIGHT' and
the point will be at end of region. Will add spaces before/after text if
`SURROUND-WHITESPACE' is true and it's needed."
(let ((start (point))
(end (point)))
(when (region-active-p)
(setq start (region-beginning)
end (region-end))
(deactivate-mark))
(when (> start end)
;; swap variables w/o importing cl-lib
(setq start (prog1 end (setq end start))))
(goto-char start)
(when (and surround-whitespace
(not (bolp))
(not (looking-back " +" nil)))
(insert " "))
(insert left)
(forward-char (- end start))
(save-excursion
(insert right)
(when (and surround-whitespace
(not (eolp))
(not (looking-at " +")))
(insert " ")))))
;;;###autoload (autoload 'org-menu-goto "org-menu" nil t)
(transient-define-prefix org-menu-goto ()
"Menu to go to different places by name."
[["Go to"
("h" "heading" imenu)
("s" "source block" org-babel-goto-named-src-block)
("r" "result block" org-babel-goto-named-result)
("." "calendar" org-goto-calendar :if org-menu-show-timestamp-options-p)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-toggle-nbspace ()
"Will remove non-breaking space before/after point or insert it if none found."
(interactive)
(cond
((looking-back "")
(backward-delete-char 1))
((looking-at "")
(delete-char 1))
(t
(insert "\u200b"))))
(defun org-menu-text-format-items (check-for-table)
"Items to format text.
Will add an ':if org-menu-show-text-options-p' criteria if
`CHECK-FOR-TABLE' is true."
(list
`["Navigate"
,@(when check-for-table '(:if org-menu-show-text-options-p))
("p" "up" previous-line :transient t)
("n" "down" next-line :transient t)
("b" "left" backward-word :transient t)
("f" "right" forward-word :transient t)
("u" "parent" org-up-element :transient t)
("M-w" "store link" org-store-link :transient t :if-not region-active-p)
("C-_" "undo" undo :transient t)
("SPC" "mark" set-mark-command :transient t)
("C-x C-x" "exchange" exchange-point-and-mark :transient t)]
`["Formatting"
,@(when check-for-table '(:if org-menu-show-text-options-p))
("*" "Bold" (lambda nil (interactive) (org-menu-toggle-format ?*)) :transient t)
("/" "italic" (lambda nil (interactive) (org-menu-toggle-format ?/)) :transient t)
("_" "underline" (lambda nil (interactive) (org-menu-toggle-format ?_)) :transient t)
("+" "strikethrough" (lambda nil (interactive) (org-menu-toggle-format ?+)) :transient t)
("S-SPC" "non-breaking space" org-menu-toggle-nbspace :transient t)]
`["Source"
,@(when check-for-table '(:if org-menu-show-text-options-p))
("~" "code" (lambda nil (interactive) (org-menu-toggle-format ?~)) :transient t)
("=" "verbatim" (lambda nil (interactive) (org-menu-toggle-format ?=)) :transient t)]))
;;;###autoload (autoload 'org-menu-text-in-element "org-menu" nil t)
(transient-define-prefix org-menu-text-in-element ()
"Add formatting for text inside other elements like lists and tables."
["dummy"])
(transient-insert-suffix 'org-menu-text-in-element (list 0)
`[,@(org-menu-text-format-items nil)
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
;;;###autoload (autoload 'org-menu-options "org-menu" nil t)
(transient-define-prefix org-menu-options ()
"A menu to toggle options."
[["Display"
("l" "show links" org-toggle-link-display)
("i" "inline images" org-toggle-inline-images)
("p" "pretty entities" org-toggle-pretty-entities)
("I" "indent by level" org-indent-mode)
("t" "timestamp overlay" org-toggle-time-stamp-overlays)
("n" "numbered headings" org-num-mode)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-toggle-has-checkbox ()
"Toggle whether the current list item has a checkbox."
(interactive)
(save-excursion
(back-to-indentation)
(if (not (looking-at "- "))
(message "Not at list item")
(end-of-line 1)
(org-ctrl-c-ctrl-c '(4)))))
(defun org-menu-is-timer-running ()
"Return whether a timer is currently running."
(and org-timer-start-time
(not org-timer-countdown-timer)
(not org-timer-pause-time)))
(defun org-menu-is-timer-paused ()
"Return whether a timer has been started and is paused."
(and org-timer-start-time
(not org-timer-countdown-timer)
org-timer-pause-time))
;;;###autoload (autoload 'org-menu-clock "org-menu" nil t)
(transient-define-prefix org-menu-clock ()
"Time management using org-modes clock."
[["Clock"
("<tab>" "in" org-clock-in :if-not org-clock-is-active)
("TAB" "in" org-clock-in :if-not org-clock-is-active)
("o" "out" org-clock-out :if org-clock-is-active)
("j" "goto" org-clock-goto :if org-clock-is-active)
("q" "cancel" org-clock-cancel
:if (lambda () (and (not org-menu-use-q-for-quit)
(org-clock-is-active))))
("Q" "cancel" org-clock-cancel
:if (lambda () (and org-menu-use-q-for-quit
(org-clock-is-active))))
("d" "display" org-clock-display :if org-clock-is-active)
("x" "in again" org-clock-in-last :if-not org-clock-is-active)
("z" "resolve" org-resolve-clocks)]
["Timer"
("0" "start" org-timer-start :if-nil org-timer-start-time)
("_" "stop" org-timer-stop :if-non-nil org-timer-start-time)
("." "insert" org-timer :if-non-nil org-timer-start-time)
("-" "... item" org-timer-item :if-non-nil org-timer-start-time)
("," "pause" org-timer-pause-or-continue :if org-menu-is-timer-running)
("," "continue" org-timer-pause-or-continue :if org-menu-is-timer-paused)
(";" "countdown" org-timer-set-timer :if-nil org-timer-start-time)]
["Effort"
("e" "set effort" org-set-effort)
("E" "increase" org-inc-effort)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(defun org-menu-columns-globally ()
"Turn on `org-columns' globally."
(interactive)
(org-columns t))
(defun org-menu-columns-next ()
"Move into the next row when org-columns is active.
Code copied from lambda in org-colview.el after
(org-defkey org-columns-map [down]
"
(interactive)
(let ((col (current-column)))
(beginning-of-line 2)
(while (and (org-invisible-p2) (not (eobp)))
(beginning-of-line 2))
(move-to-column col)
(if (derived-mode-p 'org-agenda-mode)
(org-agenda-do-context-action))))
(defun org-menu-columns-previous ()
"Move into the previous row when org-columns is active.
Code copied from lambda in org-colview.el after
(org-defkey org-columns-map [up]
"
(interactive)
(let ((col (current-column)))
(beginning-of-line 0)
(while (and (org-invisible-p2) (not (bobp)))
(beginning-of-line 0))
(move-to-column col)
(if (eq major-mode 'org-agenda-mode)
(org-agenda-do-context-action))))
(defun org-menu-columns-forward ()
"Move into the next column when org-columns is active.
Code copied from lambda in org-colview.el after
(org-defkey org-columns-map [right]
"
(interactive)
(goto-char (1+ (point))))
(defun org-menu-columns-backward ()
"Move into the next column when org-columns is active."
(interactive)
(backward-char 1))
(transient-define-prefix org-menu-search-and-filter ()
"A menu to search and filter `org-mode' documents."
["Search and filter"
["Filter"
("/" "only matching" org-sparse-tree)
("q" "tags" org-tags-sparse-tree :if-nil org-menu-use-q-for-quit)
("Q" "tags" org-tags-sparse-tree :if-non-nil org-menu-use-q-for-quit)
("t" "todos" org-show-todo-tree)
("d" "deadlines" org-check-deadlines)
("r" "remove highlights" org-remove-occur-highlights :if-non-nil org-occur-highlights)]
["Dates"
("b" "before" org-check-before-date)
("a" "after" org-check-after-date)
("D" "range" org-check-dates-range)]
["Views"
("A" "agenda" org-agenda)
("c" "columns" org-columns :if-nil org-columns-current-fmt)
("c" "columns off" org-columns-quit :if-non-nil org-columns-current-fmt)
("gc" "whole buffer" org-menu-columns-globally :if-nil org-columns-current-fmt)]
["Quit"
:if-non-nil org-menu-use-q-for-quit
("q" "quit" transient-quit-all)]])
(transient-define-prefix org-menu-attachments ()
"A menu to manage attachments."
["Attachments"
["Add"
("a" "file" org-attach-attach)
("c" "copy" org-attach-attach-cp)
("m" "move" org-attach-attach-mv)
("l" "link" org-attach-attach-ln)
("y" "symlink" org-attach-attach-lns)
("u" "download" org-attach-url)
("b" "buffer" org-attach-buffer)
("n" "new" org-attach-new)]
["Open"
("o" "attachment" org-attach-open)
("O" "in Emacs" org-attach-open-in-emacs)
("f" "directory" org-attach-reveal)
("F" "in Emacs" org-attach-reveal-in-emacs)]
["Delete"
("d" "delete" org-attach-delete-one)
("D" "all" org-attach-delete-all)]
["More"
("s" "set directory" org-attach-set-directory)
("S" "unset" org-attach-unset-directory)
("z" "synchronize" org-attach-sync)]]
(interactive)
(require 'org-attach)
(transient-setup 'org-menu-attachments))
(transient-define-prefix org-menu-archive ()
"A menu to archive items."
["dummy"])
(transient-insert-suffix 'org-menu-archive (list 0)
`["Archive"
,@(org-menu-heading-navigate-items nil #'org-force-cycle-archived)
["Archive to"
("t" "tree" org-archive-subtree :transient t)
("s" "sibling" org-archive-to-archive-sibling :transient t)
("Q" "tag" org-toggle-archive-tag :transient t)]])
(defun org-menu-insert-todo-heading-after-current ()
"Insert a new todo heading with same level as current, after subtree."
(interactive)
(org-insert-todo-heading '(16)))
;;;###autoload (autoload 'org-menu "org-menu" nil t)
(transient-define-prefix org-menu ()
"A discoverable menu to edit and view `org-mode' documents."
["dummy"])
(transient-insert-suffix 'org-menu (list 0)
`["Org mode"
;; Items for headings
,@(org-menu-heading-navigate-items t)
["Move heading"
:if org-menu-show-heading-options-p
("P" "up" org-metaup :transient t)
("N" "down" org-metadown :transient t)
("B" "left" org-shiftmetaleft :transient t)
("F" "right" org-shiftmetaright :transient t)
("b" "left (line)" org-metaleft :transient t)
("f" "right (line)" org-metaright :transient t)
("r" "refile" org-refile :transient t)]
["Change heading"
:if org-menu-show-heading-options-p
("*" "toggle" org-ctrl-c-star :if-not org-at-table-p :transient t)
("t" "todo" org-todo :transient t)
("q" "tags" org-set-tags-command :transient t :if-nil org-menu-use-q-for-quit)
("Q" "tags" org-set-tags-command :transient t :if-non-nil org-menu-use-q-for-quit)
("y" "property" org-set-property :transient t)
("," "priority" org-priority :transient t)
("A" "archive" org-menu-archive :transient t)
("D" "deadline" org-deadline :transient t)
("S" "schedule" org-schedule :transient t)
("/" "comment" org-toggle-comment :transient t)
("N" "add note" org-add-note)]
["Make new/delete"
:if org-menu-show-heading-options-p
("mh" "make heading (before)" org-insert-heading)
("mH" "make heading (after)" org-insert-heading-after-current)
("mt" "make todo (before)" org-insert-todo-heading)
("mT" "make todo (after)" org-menu-insert-todo-heading-after-current)
("mc" "clone with time shift" org-clone-subtree-with-time-shift)
("dh" "delete heading" org-cut-subtree :transient t)
("dy" "delete property" org-delete-property :transient t)
("a" "attachments" org-menu-attachments)
("C-w" "cut tree" org-cut-special :transient t)
("C-y" "yank tree" org-paste-special :transient t)]
;; Items for tables
["Navigate"
:if org-menu-show-table-options-p
("p" "up" previous-line :transient t)
("n" "down" next-line :transient t)
("b" "left" org-table-previous-field :transient t)
("f" "right" org-table-next-field :transient t)
("u" "parent" outline-up-heading :transient t)
("M-w" "store link" org-store-link :transient t :if-not region-active-p)
("C-_" "undo" undo :transient t)]
["Move r/c"
:if org-menu-show-table-options-p
("P" "up" org-table-move-row-up :transient t)
("N" "down" org-table-move-row-down :transient t)
("B" "left" org-table-move-column-left :transient t)
("F" "right" org-table-move-column-right :transient t)]
["Field"
:if org-menu-show-table-options-p
("'" "edit" org-table-edit-field)
("SPC" "blank" org-table-blank-field :transient t)
("RET" "from above" org-table-copy-down :transient t)
("t" "text formatting" org-menu-text-in-element)]
["Formulas"
:if org-menu-show-table-options-p
("E" "edit all" org-table-edit-formulas :transient t)
("=" "field" (lambda () (interactive) (org-table-eval-formula '(4))) :transient t)
("+" "in place" (lambda () (interactive) (org-table-eval-formula '(16))))
("c" "column" org-table-eval-formula :transient t)
("h" "coordinates" org-table-toggle-coordinate-overlays :transient t)
("D" "debug" org-table-toggle-formula-debugger :transient t)]
["Table"
:if org-menu-show-table-options-p
("dr" "delete row" org-shiftmetaup :transient t)
("dc" "delete column" org-shiftmetaleft :transient t)
("m" "make" org-menu-insert-table)
,@(when (fboundp (function org-table-toggle-column-width))
;; This will emit a warning during byte compilation. We can ignore it
(list '("S" "shrink column" org-table-toggle-column-width :transient t)))
("r" "sort" org-table-sort-lines :transient t)
("M-w" "copy rect" org-table-copy-region :transient t :if region-active-p)
("C-w" "cut rect" org-table-cut-region :transient t :if region-active-p)
("C-y" "yank rect" org-table-paste-rectangle :transient t)]
;; Items for lists
["Navigate"
:if org-menu-show-list-options-p
("p" "prev" previous-line :transient t)
("n" "next" next-line :transient t)
("c" "cycle" org-cycle :transient t)
("u" "parent" org-up-element :transient t)
("M-p" "prev (same level)" org-backward-element :transient t)
("M-n" "next (same level)" org-forward-element :transient t)
("M-w" "store link" org-store-link :transient t :if-not region-active-p)
("C-_" "undo" undo :transient t)]
["Move list"
:if org-menu-show-list-options-p
("P" "up" org-metaup :transient t)
("N" "down" org-metadown :transient t)
("B" "left" org-shiftmetaleft :transient t)
("F" "right" org-shiftmetaright :transient t)
("b" "left (line)" org-metaleft :transient t)
("f" "right (line)" org-metaright :transient t)]
["List"
:if org-menu-show-list-options-p
("R" "repair" org-list-repair)
("*" "turn into tree" org-list-make-subtree)
("S" "sort" org-sort-list :transient t)
("t" "text formatting" org-menu-text-in-element)]
["Toggle"
:if org-menu-show-list-options-p
("-" "list item" org-toggle-item :if-not org-at-table-p :transient t)
("+" "list style" org-cycle-list-bullet :if-not org-at-table-p :transient t)
("d" "done" org-toggle-checkbox :transient t)
("h" "half-done"
(lambda () (interactive) (org-toggle-checkbox '(16)))
:transient t)
("m" "checkbox" org-menu-toggle-has-checkbox :transient t)]
;; Items for text
,@(org-menu-text-format-items t)
["Line"
:if org-menu-show-text-options-p
(":" "fixed width" org-toggle-fixed-width :transient t)
(";" "comment" org-menu-comment-line :transient t)
("--" "list" org-toggle-item :transient t)
("-*" "heading" org-ctrl-c-star :transient t)]
;; Items for source blocks
,@(org-menu-eval-src-items)
["Link"
:if org-menu-show-link-options-p
("e" "edit" org-insert-link :transient t)]
["Timestamp"
:if org-menu-show-timestamp-options-p
("." "type" org-toggle-timestamp-type :transient t)
("e" "edit" org-time-stamp :transient t)
("R" "repair" org-menu-fix-timestamp :transient t)]
["Footnote"
:if org-menu-show-footnote-options-p
("ed" "delete" (lambda () (interactive) (org-footnote-delete)))
("es" "sort" (lambda () (interactive) (org-footnote-sort)))
("er" "renumber" (lambda () (interactive) (org-footnote-renumber-fn:N)))
("eS" "sort+renumber" (lambda () (interactive)
(org-footnote-renumber-fn:N)
(org-footnote-sort)))
("en" "normalize" (lambda () (interactive) (org-footnote-normalize)))]
;; Items for column view
["Navigate"
:if org-menu-show-columns-view-options-p
("p" "prev" org-menu-columns-previous :transient t)
("n" "next" org-menu-columns-next :transient t)
("f" "forward" org-menu-columns-forward :transient t)
("b" "backward" org-menu-columns-backward :transient t)
("M-w" "store link" org-store-link :transient t :if-not region-active-p)
("C-_" "undo" undo :transient t)]
["Value"
:if org-menu-show-columns-view-options-p
("e" "edit" org-columns-edit-value :transient t)
("V" "show" org-columns-show-value :transient t)
("M-n" "next" org-columns-next-allowed-value :transient t)
("M-p" "previous" org-columns-previous-allowed-value :transient t)
("a" "edit allowed" org-columns-edit-allowed :transient t)]
["Column"
:if org-menu-show-columns-view-options-p
("E" "edit column" org-columns-edit-attributes :transient t)
("{" "narrow" org-columns-narrow :transient t)
("}" "widen" org-columns-widen :transient t)
("M-<right>" "move right" org-columns-move-right :transient t)
("M-<left>" "move left" org-columns-move-left :transient t)
("M-S-<right>" "new" org-columns-new :transient t)
("M-S-<left>" "delete" org-columns-delete :transient t)]
["Tasks"