-
Notifications
You must be signed in to change notification settings - Fork 49
/
setup-org.el
1849 lines (1651 loc) · 80 KB
/
setup-org.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
;; Time-stamp: <2022-06-30 09:57:41 kmodi>
;; Hi-lock: (("\\(^;\\{3,\\}\\)\\( *.*\\)" (1 'org-hide prepend) (2 '(:inherit org-level-1 :height 1.3 :weight bold :overline t :underline t) prepend)))
;; Hi-Lock: end
;; Org Mode
;; Contents:
;;
;; Org Variables
;; Org Defuns
;; Org File Apps
;; Org Goto
;; Easy Templates
;; Bindings
;; Org Export
;; Org Export Customization
;; Inbuilt Exporters
;; ox-latex - LaTeX export
;; ox-html - HTML export
;; ox-beamer - Beamer export
;; ox-odt - ODT, doc export
;; External Exporters
;; ox-reveal - Presentations using reveal.js
;; ox-minutes - Meeting Minutes ASCII export
;; Helper Packages for Export
;; Convert included pdf to image
;; Extract image from included .zip
;; Org Src
;; Org Capture
;; Org Agenda
;; Org Table
;; Table Recalculation
;; Table Field Marking
;; Org Entities
;; Org Babel
;; Org Babel Tangle
;; Diagrams
;; Python
;; Other Org Packages
;; Org Tree Slide
;; Org Cliplink
;; Sticky Header Line
;; Org Link Ref
;; Htmlize Region→File
;; Include Src lines
;; Org TOC
;; Citations
;; Denote
;; Provide
;; Notes
(use-package org
:preface
(progn
(defvar org-dev-lisp-directory (when modi/default-share-directory
(let* ((dir-1 (file-name-as-directory (expand-file-name "emacs" modi/default-share-directory)))
(dir-2 (file-name-as-directory (expand-file-name "site-lisp" dir-1)))
(dir (file-name-as-directory (expand-file-name "org" dir-2))))
dir))
"Directory containing lisp files for dev version of Org.
This value must match the `lispdir' variable in the Org local.mk.
By default the value is \"$prefix/emacs/site-lisp/org\", where
`prefix' must match that in local.mk too.")
(defvar org-dev-info-directory (when modi/default-share-directory
(let* ((dir-1 (file-name-as-directory (expand-file-name "org" modi/default-share-directory)))
(dir (file-name-as-directory (expand-file-name "info" dir-1))))
dir))
"Directory containing Info manual file for dev version of Org.
This value must match the `infodir' variable in the Org local.mk.")
(when (and org-dev-lisp-directory
org-dev-info-directory)
(with-eval-after-load 'package
;; If `modi/org-version-select' is *not* `emacs', remove the Emacs
;; version of Org from the `load-path'.
(unless (eq modi/org-version-select 'emacs)
;; Remove Org that ships with Emacs from the `load-path'.
(let ((default-org-path (expand-file-name "org" modi/default-lisp-directory)))
(setq load-path (delete default-org-path load-path))))
(dolist (org-elpa-install-path (directory-files-recursively
package-user-dir
"\\`org-[0-9.]+\\'"
:include-directories))
(unless (eq modi/org-version-select 'elpa)
(setq load-path (delete org-elpa-install-path load-path))
;; Also ensure that the associated path is removed from Info
;; search list.
(setq Info-directory-list (delete org-elpa-install-path Info-directory-list)))
(when (eq modi/org-version-select 'elpa)
(add-to-list 'load-path org-elpa-install-path)))
(let ((dev-org-path (directory-file-name org-dev-lisp-directory))
(dev-org-info (directory-file-name org-dev-info-directory)))
(if (eq modi/org-version-select 'dev)
(progn
(add-to-list 'load-path dev-org-path)
;; It's possible that `org-dev-info-directory' is set to an
;; unconventional value, in which case, it will not be
;; automatically added to `Info-directory-alist'. So to ensure
;; that the correct Org Info is used, add it to
;; `Info-directory-alist' manually.
(add-to-list 'Info-directory-list dev-org-info))
;; If `modi/org-version-select' is *not* `dev', remove the
;; development version of Org from the `load-path'.
(setq load-path (delete dev-org-path load-path))
(with-eval-after-load 'info
;; Also ensure that the associated path is removed from Info search
;; list.
(setq Info-directory-list (delete dev-org-info Info-directory-list)))))))
;; Modules that should always be loaded together with org.el.
;; `org-modules' default:
;; Org 9.3 and older: '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
;; Org 9.4 and newer: '(ol-w3m ol-bbdb ol-bibtex ol-docview ol-gnus ol-info ol-irc ol-mhe ol-rmail ol-eww)
(if (eq modi/org-version-select 'dev)
(setq org-modules '(ol-info))
(setq org-modules '(org-info)))
;; Set my default org-export backends. This variable needs to be set before
;; org.el is loaded.
(setq org-export-backends '(ascii html latex))
;; Do not open links of mouse left clicks.
;; Default behavior caused inline images in Org buffers to pop up in their
;; own buffers when left clicked on by mistake. I can still intentionally
;; open links and such images in new buffers by doing C-c C-o.
(setq org-mouse-1-follows-link nil))
:mode ("\\.org\\'" . org-mode)
:config
(progn
;;; Org Variables
(setq org-src-fontify-natively t) ;Fontify code in code blocks
;; Display entities like \tilde, \alpha, etc in UTF-8 characters
(setq org-pretty-entities t)
;; Render subscripts and superscripts in Org buffers
(setq org-pretty-entities-include-sub-superscripts t)
;; Allow _ and ^ characters to sub/super-script strings but only when
;; string is wrapped in braces
(setq org-use-sub-superscripts '{}) ;In-buffer rendering
;; Single key command execution when at beginning of a headline
(setq org-use-speed-commands t) ;? speed-key opens Speed Keys help
(setq org-speed-commands-user '(("m" . org-mark-subtree)))
(setq org-hide-leading-stars t)
;; Prevent auto insertion of blank lines before headings and list items
(setq org-blank-before-new-entry '((heading)
(plain-list-item)))
;; fold / overview - collapse everything, show only level 1 headlines
;; content - show only headlines
;; nofold / showall - expand all headlines except the ones with :archive:
;; tag and property drawers
;; showeverything - same as above but without exceptions
(setq org-startup-folded 'showall)
;; https://orgmode.org/manual/Clean-view.html
(setq org-startup-indented t) ;Enable `org-indent-mode' on Org startup
(with-eval-after-load 'org-indent
(setq org-indent-indentation-per-level 1)) ;Default = 2
(setq org-log-done 'time) ;Insert only timestamp when closing an Org TODO item
;; (setq org-log-done 'note) ;Insert timestamp and note when closing an Org TODO item
;; https://orgmode.org/manual/Closing-items.html
(setq org-todo-keywords '((sequence "TODO" "SOMEDAY" "CANCELED" "DONE")))
(setq org-todo-keyword-faces
'(("TODO" . org-todo)
("SOMEDAY" . (:foreground "black" :background "#FFEF9F"))
("CANCELED" . (:foreground "#94BFF3" :weight bold :strike-through t))
("DONE" . (:foreground "black" :background "#91ba31"))))
;; Block entries from changing state to DONE while they have children
;; that are not DONE - https://orgmode.org/manual/TODO-dependencies.html
(setq org-enforce-todo-dependencies t)
;; http://emacs.stackexchange.com/a/17513/115
(setq org-special-ctrl-a/e '(t ;For C-a. Possible values: nil, t, 'reverse
. t)) ;For C-e. Possible values: nil, t, 'reverse
(setq org-catch-invisible-edits 'smart) ;http://emacs.stackexchange.com/a/2091/115
;; Number of empty lines needed to keep an empty line between collapsed trees.
;; If you leave an empty line between the end of a subtree and the following
;; headline, this empty line is hidden when the subtree is folded.
;; Org-mode will leave (exactly) one empty line visible if the number of
;; empty lines is equal or larger to the number given in this variable.
(setq org-cycle-separator-lines 2) ;Default = 2
(with-eval-after-load 'org-footnote
;; Prevent renumbering/sorting footnotes when a footnote is added/removed.
;; Doing so would create a big diff in an Org file containing lot of
;; footnotes even if only one footnote was added/removed.
(setq org-footnote-auto-adjust nil)) ;`'sort' - only sort
;`'renumber' - only renumber
;`t' - sort and renumber
;`nil' - do nothing (default)
;; ;; The default value of `org-highlight-links' contains `plain' too.
;; ;; - "plain" links are links in normal text, no whitespace, like http://foo.com.
;; ;; Here's why I remove "plain" from this list:
;; ;; - If I have two bracketed links next to each-other in org-mode (like below),
;; ;; [[http://google.com][1]],[[https://orgmode.org][2]]
;; ;; - and, if `plain' is in the `org-highlight-links' list,
;; ;; the "," in there will also be highlighted as a link. So it would look
;; ;; as if the "1,2" string pointed to a single link!
;; ;; But without `plain' as part of this list, the "1" and "2" strings will
;; ;; look like separate links (as should be the case), as the "," will not be
;; ;; highlighted as a link.
;; (setq org-highlight-links (delete 'plain org-highlight-links))
;; Sat May 27 11:55:43 EDT 2017 - kmodi
;; Above workaround is not needed after this fix in Org master:
;; https://code.orgmode.org/bzg/org-mode/commit/2d29269bb1b9af08011e091913798b6598e4b156
;; `org-default-notes-file' is used as a fall back file for org-capture.el.
(setq org-default-notes-file (expand-file-name "notes.org" org-directory))
(defvar modi/one-org-agenda-file (expand-file-name "agenda.files" org-directory)
"One file to contain a list of all Org agenda files.")
(setq org-agenda-files modi/one-org-agenda-file)
(unless (file-exists-p modi/one-org-agenda-file)
;; http://stackoverflow.com/a/14072295/1219634
;; touch `modi/one-org-agenda-file'
(write-region "" :ignore modi/one-org-agenda-file))
;; Allow multiple line Org emphasis markup
;; http://emacs.stackexchange.com/a/13828/115
(setcar (nthcdr 4 org-emphasis-regexp-components) 20) ;Up to 20 lines, default is just 1
;; Below is needed to apply the modified `org-emphasis-regexp-components'
;; settings from above.
(org-set-emph-re 'org-emphasis-regexp-components org-emphasis-regexp-components)
;;; Org Defuns
;; http://emacs.stackexchange.com/a/13854/115
;; Heading▮ --(C-c C-t)--> * TODO Heading▮
;; * Heading▮ --(C-c C-t)--> * TODO Heading▮
(defun modi/org-first-convert-to-heading (orig-fun &rest args)
(let ((is-heading))
(save-excursion
(forward-line 0)
(when (looking-at "^\\*")
(setq is-heading t)))
(unless is-heading
(org-toggle-heading))
(apply orig-fun args)))
;; Tue Aug 29 11:35:28 EDT 2017 - kmodi
;; Stopped advising this today as I don't seem to find this useful.
;; (advice-add 'org-todo :around #'modi/org-first-convert-to-heading)
(defun modi/org-return-no-indent (&optional n)
"Make `org-return' repeat the number passed through the argument"
(interactive "p")
(dotimes (cnt n)
(org-return nil)))
;; http://emacs.stackexchange.com/a/10712/115
(defun modi/org-delete-link ()
"Replace an Org link of the format [[LINK][DESCRIPTION]] with DESCRIPTION.
If the link is of the format [[LINK]], delete the whole Org link.
In both the cases, save the LINK to the kill-ring.
Execute this command while the point is on or after the hyper-linked Org link."
(interactive)
(when (derived-mode-p 'org-mode)
(let ((search-invisible t) start end)
(save-excursion
(when (re-search-backward "\\[\\[" nil :noerror)
(when (re-search-forward "\\[\\[\\(.*?\\)\\(\\]\\[.*?\\)*\\]\\]"
nil :noerror)
(setq start (match-beginning 0))
(setq end (match-end 0))
(kill-new (match-string-no-properties 1)) ;Save link to kill-ring
(replace-regexp "\\[\\[.*?\\(\\]\\[\\(.*?\\)\\)*\\]\\]" "\\2"
nil start end)))))))
(defun modi/lower-case-org-keywords ()
"Lower case Org keywords and block identifiers.
Example: \"#+TITLE\" -> \"#+title\"
\"#+BEGIN_EXAMPLE\" -> \"#+begin_example\"
Inspiration:
https://code.orgmode.org/bzg/org-mode/commit/13424336a6f30c50952d291e7a82906c1210daf0."
(interactive)
(save-excursion
(goto-char (point-min))
(let ((case-fold-search nil)
(count 0))
;; Match examples: "#+FOO bar", "#+FOO:", "=#+FOO=", "~#+FOO~",
;; "‘#+FOO’", "“#+FOO”", ",#+FOO bar",
;; "#+FOO_bar<eol>", "#+FOO<eol>".
(while (re-search-forward "\\(?1:#\\+[A-Z_]+\\(?:_[[:alpha:]]+\\)*\\)\\(?:[ :=~’”]\\|$\\)" nil :noerror)
(setq count (1+ count))
(replace-match (downcase (match-string-no-properties 1)) :fixedcase nil nil 1))
(message "Lower-cased %d matches" count))))
(defun modi/org-in-any-block-p ()
"Return non-nil if the point is in any Org block.
The Org block can be *any*: src, example, verse, etc., even any
Org Special block.
This function is heavily adapted from `org-between-regexps-p'."
(save-match-data
(let ((pos (point))
(case-fold-search t)
(block-begin-re "^[[:blank:]]*#\\+begin_\\(?1:.+?\\)\\(?: .*\\)*$")
(limit-up (save-excursion (outline-previous-heading)))
(limit-down (save-excursion (outline-next-heading)))
beg end)
(save-excursion
;; Point is on a block when on BLOCK-BEGIN-RE or if
;; BLOCK-BEGIN-RE can be found before it...
(and (or (org-in-regexp block-begin-re)
(re-search-backward block-begin-re limit-up :noerror))
(setq beg (match-beginning 0))
;; ... and BLOCK-END-RE after it...
(let ((block-end-re (concat "^[[:blank:]]*#\\+end_"
(match-string-no-properties 1)
"\\( .*\\)*$")))
(goto-char (match-end 0))
(re-search-forward block-end-re limit-down :noerror))
(> (setq end (match-end 0)) pos)
;; ... without another BLOCK-BEGIN-RE in-between.
(goto-char (match-beginning 0))
(not (re-search-backward block-begin-re (1+ beg) :noerror))
;; Return value.
(cons beg end))))))
(defun modi/org-split-block ()
"Sensibly split the current Org block at point.
(1) Point in-between a line
#+begin_src emacs-lisp #+begin_src emacs-lisp
(message▮ \"one\") (message \"one\")
(message \"two\") --> #+end_src
#+end_src ▮
#+begin_src emacs-lisp
(message \"two\")
#+end_src
(2) Point at EOL
#+begin_src emacs-lisp #+begin_src emacs-lisp
(message \"one\")▮ (message \"one\")
(message \"two\") --> #+end_src
#+end_src ▮
#+begin_src emacs-lisp
(message \"two\")
#+end_src
(3) Point at BOL
#+begin_src emacs-lisp #+begin_src emacs-lisp
(message \"one\") (message \"one\")
▮(message \"two\") --> #+end_src
#+end_src ▮
#+begin_src emacs-lisp
(message \"two\")
#+end_src
"
(interactive)
(if (modi/org-in-any-block-p)
(save-match-data
(save-restriction
(widen)
(let ((case-fold-search t)
(at-bol (bolp))
block-start
block-end)
(save-excursion
(re-search-backward "^\\(?1:[[:blank:]]*#\\+begin_.+?\\)\\(?: .*\\)*$" nil nil 1)
(setq block-start (match-string-no-properties 0))
(setq block-end (replace-regexp-in-string
"begin_" "end_" ;Replaces "begin_" with "end_", "BEGIN_" with "END_"
(match-string-no-properties 1))))
;; Go to the end of current line, if not at the BOL
(unless at-bol
(end-of-line 1))
(insert (concat (if at-bol "" "\n")
block-end
"\n\n"
block-start
(if at-bol "\n" "")))
;; Go to the line before the inserted "#+begin_ .." line
(beginning-of-line (if at-bol -1 0)))))
(message "Point is not in an Org block")))
(defun modi/org-meta-return (&optional arg)
"Insert a new heading or wrap a region in a table.
Calls `org-insert-heading', `org-insert-item',
`org-table-wrap-region', or `modi/org-split-block' depending on
context. When called with an argument, unconditionally call
`org-insert-heading'."
(interactive "P")
(org-check-before-invisible-edit 'insert)
(or (run-hook-with-args-until-success 'org-metareturn-hook)
(call-interactively (cond (arg #'org-insert-heading)
((org-at-table-p) #'org-table-wrap-region)
((org-in-item-p) #'org-insert-item)
((modi/org-in-any-block-p) #'modi/org-split-block)
(t #'org-insert-heading)))))
(advice-add 'org-meta-return :override #'modi/org-meta-return)
;; (advice-remove 'org-meta-return #'modi/org-meta-return)
;; Make C-u C-return insert heading *at point* (not respecting content),
;; even when the point is directly after a list item.
;; Reason: http://lists.gnu.org/r/emacs-orgmode/2018-02/msg00368.html
(defun modi/org-insert-heading-respect-content (&optional invisible-ok)
"Insert heading with `org-insert-heading-respect-content' set to t.
With \\[universal-argument] prefix, insert Org heading directly at
point."
(interactive)
(let ((respect-content (unless current-prefix-arg
'(4))))
(org-insert-heading respect-content invisible-ok)))
(advice-add 'org-insert-heading-respect-content :override
#'modi/org-insert-heading-respect-content)
;; Below helped be speed up eless.org tangling speed from ~4
;; seconds to ~2.5 seconds, and exporting time of nim.org when
;; down from 53 seconds to 39 seconds.
;; https://www.reddit.com/r/emacs/comments/9lpybf/a_fast_org_tangling_solution_using_nim/e7bettq/
(defun modi/advice-org-tangle-and-export-boost (orig-fun &rest args)
"Speed up Org tangling and exporting considerably.
- Prevent GC.
- Prevent Projectile hooks/advices from interfering with the find-files
and file deletes."
(let ((orig-gc-thresh gc-cons-threshold)
(projectile-enabled (and (fboundp #'projectile-mode)
projectile-mode))
(t1 (current-time)))
;; Try to prevent GC.
(setq gc-cons-threshold (* 200 1024 1024)) ;200 MB before garbage collection
(when projectile-enabled
;; Disable projectile hooks and advices.
(remove-hook 'find-file-hook #'projectile-find-file-hook-function)
(advice-remove 'delete-file #'delete-file-projectile-remove-from-cache))
(prog1
(apply orig-fun args)
;; Re-add projectile mode hooks and advices.
(when projectile-enabled
(add-hook 'find-file-hook #'projectile-find-file-hook-function)
(advice-add 'delete-file :before #'delete-file-projectile-remove-from-cache))
(setq gc-cons-threshold orig-gc-thresh)
(message "exec time: %S" (float-time (time-since t1))))))
(dolist (fn '(org-babel-tangle org-export-to-file))
(advice-add fn :around #'modi/advice-org-tangle-and-export-boost)
;; (advice-remove fn #'modi/advice-org-tangle-and-export-boost)
)
;;; Org File Apps
;; Make firefox the default web browser for applications like viewing
;; an html file exported from Org ( C-c C-e h o )
(when (executable-find "firefox")
(add-to-list 'org-file-apps '("\\.x?html\\'" . "firefox %s")))
;; Change the default app for opening pdf files from org
;; http://stackoverflow.com/a/9116029/1219634
(setcdr (assoc "\\.pdf\\'" org-file-apps) "acroread %s")
;;; Org Goto
(defun modi/org-goto-override-bindings (&rest _)
"Override the bindings set by `org-goto-map' function."
(org-defkey org-goto-map "\C-p" #'outline-previous-visible-heading)
(org-defkey org-goto-map "\C-n" #'outline-next-visible-heading)
(org-defkey org-goto-map "\C-f" #'outline-forward-same-level)
(org-defkey org-goto-map "\C-b" #'outline-backward-same-level)
org-goto-map)
(advice-add 'org-goto-map :after #'modi/org-goto-override-bindings)
;;; Easy Templates
;; https://orgmode.org/manual/Easy-Templates.html
;; http://oremacs.com/2015/03/07/hydra-org-templates
;; https://github.com/abo-abo/hydra/wiki/Org-mode-block-templates
;; Sun Nov 05 09:30:51 EST 2017 - kmodi
;; Copy of the old "Easy Templates" feature that was removed in
;; https://code.orgmode.org/bzg/org-mode/commit/c04e357f3d5d93484277a7e439847b1233b872bd
(defconst org-easy-template-alist ;Old `org-structure-template-alist'
'(("s" "#+begin_src ?\n\n#+end_src")
("bd" "#+begin_description\n?\n#+end_description") ;Special block in `ox-hugo'
("bm" "#+begin_mark\n?\n#+end_mark") ;Special block in `ox-hugo'
("bn" "#+begin_note\n?\n#+end_note") ;Special block in `ox-hugo'
("bs" "#+begin_sidenote\n?\n#+end_sidenote") ;Special block in `ox-hugo'
("e" "#+begin_example\n?\n#+end_example")
("q" "#+begin_quote\n?\n#+end_quote")
("v" "#+begin_verse\n?\n#+end_verse")
("V" "#+begin_verbatim\n?\n#+end_verbatim")
("c" "#+begin_center\n?\n#+end_center")
("C" "#+begin_comment\n?\n#+end_comment")
("X" "#+begin_export ?\n\n#+end_export")
("l" "#+begin_export latex\n?\n#+end_export")
("L" "#+latex: ")
("h" "#+begin_export html\n?\n#+end_export")
("H" "#+html: ")
("i" "#+include: %file ?"))
"Structure completion elements.
This is a list of abbreviation keys and values. The value gets
inserted if you type `<' followed by one or more characters and
then press the completion key, usually `TAB'. %file will be
replaced by a file name after prompting for the file using
completion. The cursor will be placed at the position of the `?'
in the template.")
(defun org-try-structure-completion ()
"Try to complete a structure template before point.
This looks for strings like \"<e\" on an otherwise empty line and
expands them."
(let ((l (buffer-substring (point-at-bol) (point)))
a)
(when (and (looking-at "[ \t]*$")
(string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
(setq a (assoc (match-string 1 l) org-easy-template-alist)))
(org-complete-expand-structure-template (+ -1 (point-at-bol)
(match-beginning 1))
a)
t)))
(defun org-complete-expand-structure-template (start cell)
"Expand a structure template."
(let ((rpl (nth 1 cell))
(ind ""))
(delete-region start (point))
(when (string-match "\\`[ \t]*#\\+" rpl)
(cond
((bolp))
((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
(setq ind (buffer-substring (point-at-bol) (point))))
(t (newline))))
(setq start (point))
(when (string-match "%file" rpl)
(setq rpl (replace-match
(concat
"\""
(save-match-data
(abbreviate-file-name (read-file-name "Include file: ")))
"\"")
t t rpl)))
(setq rpl (mapconcat 'identity (split-string rpl "\n")
(concat "\n" ind)))
(insert rpl)
(when (re-search-backward "\\?" start t) (delete-char 1))))
(defun modi/org-template-expand (str &optional arg)
"Expand Org template based on STR.
STR is always prefixed with \"<\". The string following that
\"<\" must match with the `car' of one of the elements in
`org-easy-template-alist' (examples: \"<e\", \"<s\").
If no region is selected, this function simply runs
`org-try-structure-completion' and does the template expansion
based on `org-easy-template-alist'. If a region is selected, the
selected text is wrapped with that Org template.
If the \"#+begin_src\" block is inserted and ARG is a string
representing the source language, that source block is annotated
with that ARG. If ARG is nil, point is returned to the end of
the \"#+begin_src\" line after the template insertion.
If the \"#+begin_export\" block is inserted and ARG is a string
representing the export backend, that export block is annotated
with that ARG. If ARG is nil, point is returned to the end of
the \"#+begin_export\" line after the template insertion."
(let* ((is-region? (use-region-p))
(beg (if is-region?
(region-beginning)
(point)))
;; Copy marker for end so that if characters are added/removed
;; before the `end', the reference end point is updated (because of
;; being a marker).
(end (when is-region?
(copy-marker (region-end) t)))
content post-src-export column)
(goto-char beg)
;; Save the indentation level of the content (if region is selected) or
;; the point (if region is not selected).
(save-excursion
(forward-line 0) ;Go to BOL
(when (looking-at "[[:blank:]]")
(back-to-indentation)
(setq column (current-indentation))))
(when is-region?
;; Update `beg' if needed..
;; If `beg' is at BOL, update `beg' to be at the indentation.
(when (and (bolp)
column)
(back-to-indentation)
(setq beg (point)))
;; Insert a newline if `beg' is *not* at BOL.
;; Example: You have ^abc$ where ^ is BOL and $ is EOL.
;; "bc" is selected and pressing <e should result in:
;; a
;; #+begin_example
;; bc
;; #+end_example
(unless (or (bolp)
(looking-back "^[[:blank:]]*"))
(insert "\n")
(when column
(indent-to column))
(setq beg (point)))
;; Update `end' if needed ..
(goto-char end)
(cond
((bolp) ;`end' is at BOL
(skip-chars-backward " \n\t")
(set-marker end (point)))
((and (not (bolp)) ;`end' is neither at BOL nor at EOL
(not (looking-at "[[:blank:]]*$")))
;; Insert a newline if `end' is neither at BOL nor EOL
;; Example: You have ^abc$ where ^ is bol and $ is eol.
;; "a" is selected and pressing <e should result in:
;; #+begin_example
;; a
;; #+end_example
;; bc
(insert "\n")
(when column
(indent-to column))
(skip-chars-backward " \n\t")
(set-marker end (point)))
(t ;`end' is either at EOL or looking at trailing whitespace
))
;; Now delete the content in the selected region and save it to
;; `content'.
(setq content (delete-and-extract-region beg end))
;; Make the `end' marker point to nothing as its job is done.
;; http://lists.gnu.org/archive/html/emacs-orgmode/2017-09/msg00049.html
;; (elisp) Overview of Markers
(set-marker end nil))
;; Insert the `str' required for template expansion (example: "<e").
(insert str)
(org-try-structure-completion)
(when (let* ((case-fold-search t)) ;Ignore case
(looking-back "^[[:blank:]]*#\\+begin_\\(src\\|export\\)[[:blank:]]+"))
(cond
((stringp arg)
(insert arg)
(forward-line))
((and (null arg) ;If the language for the source block,
content) ;or the backend for the export block is not specified
(setq post-src-export (point))
(forward-line))
(t
)))
;; At this point the cursor will be between the #+begin_.. and
;; #+end_.. lines. Now also indent the point forward if needed.
(when column
(indent-to column))
;; Now if a region was selected, and `content' was saved from that,
;; paste it back in.
(when content
;; A special case for verbatim blocks.. need to escape "*" and "#+"
;; with commas -- (org) Literal examples.
;; http://lists.gnu.org/archive/html/emacs-orgmode/2017-10/msg00349.html
(when (save-excursion
(previous-line)
(forward-line 0)
(let* ((case-fold-search t)) ;Ignore case
(looking-at-p (concat "^[[:blank:]]*#\\+BEGIN_"
(regexp-opt '("EXAMPLE" "EXPORT" "SRC"))))))
(setq content (org-escape-code-in-string content)))
(insert content)
(deactivate-mark)
(when post-src-export ;Case where user needs to specify the #+begin_src language,
(goto-char post-src-export))))) ;or the #+begin_export backend.
(defhydra hydra-org-template (:color blue
:hint nil)
"
org-template: _c_enter _s_rc _e_xample _v_erilog _t_ext [_bd_] description
_l_atex _h_tml _V_erse _m_atlab _L_aTeX: [_bm_] mark
_q_uote _E_macs-lisp _n_im _i_nclude: _H_TML: [_bn_] note
_o_rg _S_hell _p_ython e_X_port [_bs_] sidenote
"
("s" (modi/org-template-expand "<s")) ;#+begin_src ... #+end_src
("E" (modi/org-template-expand "<s" "emacs-lisp"))
("v" (modi/org-template-expand "<s" "systemverilog"))
("m" (modi/org-template-expand "<s" "matlab"))
("n" (modi/org-template-expand "<s" "nim"))
("o" (modi/org-template-expand "<s" "org"))
("S" (modi/org-template-expand "<s" "shell"))
("p" (modi/org-template-expand "<s" "python"))
("t" (modi/org-template-expand "<s" "text"))
("bd" (modi/org-template-expand "<bd")) ;#+begin_description ... #+end_description (Special block in `ox-hugo')
("bm" (modi/org-template-expand "<bm")) ;#+begin_mark ... #+end_mark (Special block in `ox-hugo')
("bn" (modi/org-template-expand "<bn")) ;#+begin_note ... #+end_note (Special block in `ox-hugo')
("bs" (modi/org-template-expand "<bs")) ;#+begin_sidenote ... #+end_sidenote (Special block in `ox-hugo')
("e" (modi/org-template-expand "<e")) ;#+begin_example ... #+end_example
("x" (modi/org-template-expand "<e")) ;#+begin_example ... #+end_example
("q" (modi/org-template-expand "<q")) ;#+begin_quote ... #+end_quote
("V" (modi/org-template-expand "<v")) ;#+begin_verse ... #+end_verse
("c" (modi/org-template-expand "<c")) ;#+begin_center ... #+end_center
("X" (modi/org-template-expand "<X")) ;#+begin_export ... #+end_export
("l" (modi/org-template-expand "<X" "latex")) ;#+begin_export latex ... #+end_export
("h" (modi/org-template-expand "<X" "html")) ;#+begin_export html ... #+end_export
("L" (modi/org-template-expand "<L")) ;#+latex:
("H" (modi/org-template-expand "<H")) ;#+html:
("i" (modi/org-template-expand "<I")) ;#+include: line
("<" self-insert-command "<")
("Q" nil "quit"))
(defun modi/org-template-maybe ()
"Insert org-template if point is at the beginning of the
line, or if a region is selected. Else call
`self-insert-command'."
(interactive)
(let ((is-region? (use-region-p)))
(if (or is-region?
(and (not is-region?)
(looking-back "^[[:blank:]]*")))
(hydra-org-template/body)
(self-insert-command 1))))
;;; Bindings
(defun modi/reset-local-set-keys ()
(local-unset-key (kbd "<f10>"))
(local-unset-key (kbd "<s-f10>"))
(local-unset-key (kbd "<S-f10>"))
(local-unset-key (kbd "<C-f10>")))
(add-hook 'org-mode-hook #'modi/reset-local-set-keys)
(bind-keys
:map org-mode-map
("C-m" . modi/org-return-no-indent)
("<" . modi/org-template-maybe)
("M-p" . org-previous-visible-heading)
("M-P" . org-backward-heading-same-level)
("M-n" . org-next-visible-heading)
("M-N" . org-forward-heading-same-level))
;; Bind the "org-table-*" command ONLY when the point is in an Org table.
;; http://emacs.stackexchange.com/a/22457/115
(bind-keys
:map org-mode-map
:filter (org-at-table-p)
("C-c ?" . org-table-field-info)
("C-c SPC" . org-table-blank-field)
("C-c +" . org-table-sum)
("C-c =" . org-table-eval-formula)
("C-c `" . org-table-edit-field)
("C-#" . org-table-rotate-recalc-marks)
("C-c }" . org-table-toggle-coordinate-overlays)
("C-c {" . org-table-toggle-formula-debugger)
;; Add the <return> variant of bindings so that they work on
;; Emacs GUI too.
("S-<return>" . org-table-copy-down))
;; https://lists.gnu.org/r/emacs-orgmode/2019-01/msg00312.html
;; Add the <return> variant of bindings so that they work on Emacs
;; GUI too.
(bind-keys
:map org-mode-map
("M-S-<return>" . org-insert-todo-heading)
("ESC S-<return>" . org-insert-todo-heading)
("M-<return>" . org-meta-return)
("ESC <return>" . org-meta-return))
;; https://orgmode.org/manual/Activation.html
(bind-keys
:map modi-mode-map
("C-c a" . org-agenda)
("C-c c" . org-capture)
("C-c l" . org-store-link))))
(use-package org-eldoc
:load-path "elisp/org-contrib/lisp/"
:after org)
;;; Org Export
(use-package ox
:defer t
:config
(progn
;; Require wrapping braces to interpret _ and ^ as sub/super-script
(setq org-export-with-sub-superscripts '{}) ;also #+options: ^:{}
(setq org-export-with-smart-quotes t) ;also #+options: ':t
(setq org-export-headline-levels 4)
;;;; Org Export Customization
;; Delete selected columns from Org tables before exporting
;; http://thread.gmane.org/gmane.emacs.orgmode/106497/focus=106683
(defun mbrand/org-export-delete-commented-cols (back-end)
"Delete columns $2 to $> marked as `<#>' on a row with `/' in $1.
If you want a non-empty column $1 to be deleted make it $2 by
inserting an empty column before and adding `/' in $1."
(goto-char (point-min))
(while (re-search-forward
"^[ \t]*| +/ +|\\(.*|\\)? +\\(<#>\\) *|" nil :noerror)
(goto-char (match-beginning 2))
(org-table-delete-column)
(beginning-of-line)))
(add-hook 'org-export-before-processing-hook #'mbrand/org-export-delete-commented-cols)
;; http://lists.gnu.org/archive/html/emacs-orgmode/2016-09/msg00168.html
(defun cpit/filter-begin-only (type)
"Remove BEGIN_ONLY %s blocks whose %s doesn't equal TYPE.
For those that match, only remove the delimiters.
On the flip side, for BEGIN_EXCEPT %s blocks, remove those if %s equals TYPE. "
(goto-char (point-min))
(while (re-search-forward " *#\\+BEGIN_\\(ONLY\\|EXCEPT\\) +\\([a-z]+\\)\n"
nil :noerror)
(let ((only-or-export (match-string-no-properties 1))
(block-type (match-string-no-properties 2))
(begin-from (match-beginning 0))
(begin-to (match-end 0)))
(re-search-forward (format " *#\\+END_%s +%s\n"
only-or-export block-type))
(let ((end-from (match-beginning 0))
(end-to (match-end 0)))
(if (or (and (string= "ONLY" only-or-export)
(string= type block-type))
(and (string= "EXCEPT" only-or-export)
(not (string= type block-type))))
(progn ;Keep the block,
;delete just the comment markers
(delete-region end-from end-to)
(delete-region begin-from begin-to))
;; Delete the block
(message "Removing %s block" block-type)
(delete-region begin-from end-to))))))
(add-hook 'org-export-before-processing-hook #'cpit/filter-begin-only)
;;;; Inbuilt Exporters
(defun modi/org-export-to-html-txt-pdf ()
"Export the Org file to HTML, Ascii and PDF formats."
(interactive)
(org-html-export-to-html)
(org-ascii-export-to-ascii)
(org-latex-export-to-pdf))
;;;;; ox-latex - LaTeX export
(use-package ox-latex
:config
(progn
(defvar modi/ox-latex-use-minted t
"Use `minted' package for listings.")
(setq org-latex-compiler "xelatex") ;introduced in Org 9.0
(setq org-latex-prefer-user-labels t) ;org-mode version 8.3+
;; ox-latex patches
(load (expand-file-name
"ox-latex-patches.el"
(concat user-emacs-directory "elisp/patches/"))
nil :nomessage)
;; Previewing latex fragments in Org mode
;; https://orgmode.org/worg/org-tutorials/org-latex-preview.html
;; (setq org-latex-create-formula-image-program 'dvipng) ;NOT Recommended
(setq org-latex-create-formula-image-program 'imagemagick) ;Recommended
;; Controlling the order of loading certain packages w.r.t. `hyperref'
;; http://tex.stackexchange.com/a/1868/52678
;; ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/hyperref/README.pdf
;; Remove the list element in `org-latex-default-packages-alist'.
;; that has '("hyperref" nil) as its cdr.
;; http://stackoverflow.com/a/9813211/1219634
(setq org-latex-default-packages-alist
(delq (rassoc '("hyperref" nil) org-latex-default-packages-alist)
org-latex-default-packages-alist))
;; `hyperref' will be added again later in `org-latex-packages-alist'
;; in the correct order.
;; The `org-latex-packages-alist' will output tex files with
;; \usepackage[FIRST STRING IF NON-EMPTY]{SECOND STRING}
;; It is a list of cells of the format:
;; ("options" "package" SNIPPET-FLAG COMPILERS)
;; If SNIPPET-FLAG is non-nil, the package also needs to be included
;; when compiling LaTeX snippets into images for inclusion into
;; non-LaTeX output (like when previewing latex fragments using the
;; "C-c C-x C-l" binding.
;; COMPILERS is a list of compilers that should include the package,
;; see `org-latex-compiler'. If the document compiler is not in the
;; list, and the list is non-nil, the package will not be inserted
;; in the final document.
(defconst modi/org-latex-packages-alist-pre-hyperref
'(("letterpaper,margin=1.0in" "geometry")
;; Prevent an image from floating to a different location.
;; http://tex.stackexchange.com/a/8633/52678
("" "float")
;; % 0 paragraph indent, adds vertical space between paragraphs
;; http://en.wikibooks.org/wiki/LaTeX/Paragraph_Formatting
("" "parskip"))
"Alist of packages that have to be loaded before `hyperref'
package is loaded.
ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/hyperref/README.pdf ")
(defconst modi/org-latex-packages-alist-post-hyperref
'(;; Prevent tables/figures from one section to float into another section
;; http://tex.stackexchange.com/a/282/52678
("section" "placeins")
;; Graphics package for more complicated figures
("" "tikz")
("" "caption")
;;
;; Packages suggested to be added for previewing latex fragments
;; https://orgmode.org/worg/org-tutorials/org-latex-preview.html
("mathscr" "eucal")
("" "latexsym"))
"Alist of packages that have to (or can be) loaded after `hyperref'
package is loaded.")
;; The "H" option (`float' package) prevents images from floating around.
(setq org-latex-default-figure-position "H") ;figures are NOT floating
;; (setq org-latex-default-figure-position "htb") ;default - figures are floating
;; `hyperref' package setup
(setq org-latex-hyperref-template
(concat "\\hypersetup{\n"
"pdfauthor={%a},\n"
"pdftitle={%t},\n"
"pdfkeywords={%k},\n"
"pdfsubject={%d},\n"
"pdfcreator={%c},\n"
"pdflang={%L},\n"
;; Get rid of the red boxes drawn around the links
"colorlinks,\n"
"citecolor=black,\n"
"filecolor=black,\n"
"linkcolor=blue,\n"
"urlcolor=blue\n"
"}"))
(if modi/ox-latex-use-minted
;; using minted
;; https://github.com/gpoore/minted
(progn
(setq org-latex-listings 'minted) ;default nil
;; The default value of the `minted' package option `cachedir'
;; is "_minted-\jobname". That clutters the working dirs with
;; _minted* dirs. So instead create them in temp folders.
(defvar latex-minted-cachedir
(file-name-as-directory
(expand-file-name ".minted/\\jobname" modi/temporary-file-directory)))
;; `minted' package needed to be loaded AFTER `hyperref'.
;; http://tex.stackexchange.com/a/19586/52678
(add-to-list 'modi/org-latex-packages-alist-post-hyperref
`(,(concat "cachedir=" ;options
latex-minted-cachedir)
"minted" ;package
;; If `org-latex-create-formula-image-program'
;; is set to `dvipng', minted package cannot be
;; used to show latex previews.
,(not (eq org-latex-create-formula-image-program 'dvipng)))) ;snippet-flag
;; minted package options (applied to embedded source codes)
(setq org-latex-minted-options
'(("linenos")
("numbersep" "5pt")
("frame" "none") ;box frame is created by `mdframed' package
("framesep" "2mm")
;; minted 2.0+ required for `breaklines'
("breaklines"))) ;line wrapping within code blocks
(when (equal org-latex-compiler "pdflatex")
(add-to-list 'org-latex-minted-options '(("fontfamily" "zi4")))))
;; not using minted
(progn
;; Commented out below because it clashes with `placeins' package
;; (add-to-list 'modi/org-latex-packages-alist-post-hyperref '("" "color"))
(add-to-list 'modi/org-latex-packages-alist-post-hyperref '("" "listings"))))
(setq org-latex-packages-alist
(append modi/org-latex-packages-alist-pre-hyperref
'(("" "hyperref" nil))
modi/org-latex-packages-alist-post-hyperref))
;; `-shell-escape' is required when using the `minted' package
;; https://orgmode.org/worg/org-faq.html#using-xelatex-for-pdf-export
;; latexmk runs pdflatex/xelatex (whatever is specified) multiple times
;; automatically to resolve the cross-references.
;; (setq org-latex-pdf-process '("latexmk -xelatex -quiet -shell-escape -f %f"))
;; Below value of `org-latex-pdf-process' with %latex will work in Org 9.0+
;; (setq org-latex-pdf-process
;; '("%latex -interaction nonstopmode -shell-escape -output-directory %o %f"
;; "%latex -interaction nonstopmode -shell-escape -output-directory %o %f"