summaryrefslogtreecommitdiff
path: root/blendoit/blendoit-init.org
blob: 84229645018d3f3ebaf2d673caa3882346e7cd7d (plain)
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
#+TITLE: My Literate GNU Emacs Config
#+AUTHOR: Marius Peter
#+DATE: <2020-07-23 Thu>
#+EMAIL: blendoit@gmail.com
#+STARTUP: showall customtime
#+SETUPFILE: ~/.emacs.d/templates/documents/general.org
#+INCLUDE: ~/.emacs.d/templates/documents/general.org_title

#+LATEX: \begin{abstract}
GNU Emacs is most often used as a text editor.
The utmost level of customization is afforded by enabling the user
to rewrite \textit{any} part of the source code and observe the editor's
modified behaviour in real time. Since its inception in 1984, GNU Emacs
has grown to be much more than a full-featured, high-productivity
text editor---new \textit{modes} have been written to interact with
hundreds of file formats, including \texttt{.txt}, \texttt{.pdf},
\texttt{.jpg}, \texttt{.csv}, and \texttt{.zip} just to name a few.
This configuration file itself was written in \textit{Org mode},
a collection of functions enabling the harmonious mixing of code
and comments in view of publication:
this is the endgame of \textit{literate programming}.
#+LATEX: \end{abstract}

* Introduction

The following sections were laid out very deliberately. When we start Emacs,
Emacs Lisp source code blocks contained in this document are evaluated
sequentially---our editing environment is constructed in real time as we
execute the blocks in order. For instance, we only begin loading packages once
we ensured ~use-package~ is working properly.

Customizing Emacs goes far, far beyond this document---feel free to experiment
and discover.

- ~C-h f~ describe function
- ~C-h v~ describe variable
- ~C-h k~ describe key

These three commands will attempt to describe the element currently under our
cursor, however you can start typing to search for another symbol.

* TODO First-time setup

Spacemacs-like dialog for default settings.

#+NAME: first-setup
# #+BEGIN_SRC emacs-lisp
#     ;; Prompt enterprise or personal install. Create file in .emacs.d/ on Linux,
#     ;; AppData/ on Windows. Ask user for details and preferred bindings.
#
#   ; Check if .emacs.d exists
#
#   ; If it does, warn user
#
#   ; Copy init-bootstrap.el from USB to where operating systems expects init.el
#
#   ;;   (defun blendoit/first-time-setup-windows-nt ()
#   ;;     "Execute the first-time setup on MS Windows.
#   ;; If no `.emacs.d/' config exists on local system, copy
#   ;; init-bootstrap.el to `~.emacs.d/'."
#   ;;      (interactive)
#   ;;      (find-file "~/.emacs.d/blendoit/blendoit-init.org"))
#
#   ;; (cond ((string-equal system-type "windows-nt")blendoit/first-time-setup-windows-nt)
#         ;; ((string-equal system-type "gnu/linux") blendoit/first-time-setup-linux))
# #+END_SRC

** File system paths

In this subsection, we tell Emacs about relevant paths to resources.

On my MS Windows machine, I add the path to Portable Git.[fn::Download from
https://git-scm.com/download/win]

#+BEGIN_SRC emacs-lisp
  (when (string-equal system-type "windows-nt")
    (add-to-list 'exec-path "C:/Users/marius.peter/PortableGit/bin/"))
#+END_SRC

* Early setup

** Garbage collection

First, we increase the RAM threshold beyond which the garbage collector is
activated.

#+NAME: garbage-collection
#+BEGIN_SRC emacs-lisp
(setq gc-cons-threshold 100000000)
#+END_SRC

** Profiling --- start

We start the profiler now , and will interrupt it in Section [[Profiling ---
stop]]. We will then present profiling report in Section [[Profiling --- report]].

#+NAME: profiler-start
#+BEGIN_SRC emacs-lisp
; (profiler-start)
#+END_SRC

** Emacs client

Makes opening emacs faster for following instances.

#+NAME: emacs-client
#+BEGIN_SRC emacs-lisp
; (setq initial-buffer-choice (lambda () (get-buffer "*dashboard*")))
#+END_SRC

** Custom file

Load settings created automatically by GNU Emacs Custom. (For example, any
clickable option/toggle is saved here.) Useful for fooling around with M-x
customize-group <package>.

user-emacs-directory

#+NAME: custom-file-location
#+BEGIN_SRC emacs-lisp
  (setq custom-file (concat user-emacs-directory "init-custom.el"))
  (load custom-file)
#+END_SRC

** Customization shortcuts

We begin by defining a user shortcut to this very file. We load this as early as
possible, this facilitates debugging.

#+NAME: shortcut-config
#+BEGIN_SRC emacs-lisp
  (defun my/find-literate-config ()
    "Jump to this very file."
    (interactive)
    (find-file my/literate-config))

  (global-set-key (kbd "C-c c") 'my/find-literate-config)
#+END_SRC

Now, different shortcuts for other customization actions:

#+NAME: shortcuts-customization
#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-c v") 'customize-variable)
  (global-set-key (kbd "C-c f") 'customize-face)
#+END_SRC

** Backups

Backups are so important that they should be described right after the shortcut
to this file.

#+BEGIN_SRC emacs-lisp
  (setq backup-directory-alist `((".*" . ,temporary-file-directory))
  auto-save-file-name-transforms `((".*" ,temporary-file-directory t))
      backup-by-copying t    ; Don't delink hardlinks
      version-control t      ; Use version numbers on backups
      delete-old-versions t  ; Automatically delete excess backups
      kept-new-versions 20   ; how many of the newest versions to keep
      kept-old-versions 5    ; and how many of the old
      )
#+END_SRC

** Initial and default frames

We set the dimensions of the inital and default frames.

#+BEGIN_SRC emacs-lisp
  (add-to-list 'default-frame-alist '(width  . 100))
  (add-to-list 'default-frame-alist '(height . 50))

  (add-to-list 'initial-frame-alist '(width  . 100))
  (add-to-list 'initial-frame-alist '(height . 50))
#+END_SRC

*** GNU/Linux

These settings affect the first and subsequent frames spawned by Emacs in
GNU/Linux. Frame transparency increases when focus is lost.

#+BEGIN_SRC emacs-lisp
  (when (and (display-graphic-p) (string-equal system-type "gnu/linux"))
    (set-frame-parameter (selected-frame) 'alpha '(90 . 50))
    (add-to-list 'default-frame-alist '(alpha . (90 . 50))))
#+END_SRC

** Secrets

The code contained in the =secrets.org= file is loaded by Emacs, but not
rendered in this PDF for the sake of privacy. It contains individually
identifying information such as names and e-mail addresses, which are used to
populate Org templates (Section [[~org-mode~]]).

You need to create this =secrets.org= file, as it is ignored by =git= by
default.

#+BEGIN_SRC emacs-lisp
  (org-babel-load-file "~/.emacs.d/blendoit/secrets.org")
#+END_SRC

* Global key bindings

The following bindings strive to further enhance CUA[fn::Common User Access.]
mode.

** Keyboard navigation

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-`") 'delete-other-windows)
#+END_SRC

*** Saving a file

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-s") 'save-buffer)
#+END_SRC

*** Opening a file

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-o") 'find-file)
#+END_SRC

*** Opening a recently visited file

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-r") 'counsel-recentf)
#+END_SRC

*** Locating a file

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-c l") 'counsel-locate)
#+END_SRC

*** Closing window and quitting Emacs

#+BEGIN_SRC emacs-lisp
  (defun my/delete-window-or-previous-buffer ()
    "Delete window; if sole window, previous buffer."
     (interactive)
     (if (> (length (window-list)) 1)
       (delete-window)
       (previous-buffer)))
#+END_SRC

The following bindings lead to more natural exit behaviors.

#+BEGIN_SRC emacs-lisp
(global-set-key (kbd "C-w") 'my/delete-window-or-previous-buffer)
(global-set-key (kbd "C-q") 'save-buffers-kill-terminal)
#+END_SRC

** Mouse zoom

The typical binding on both GNU/Linux and MS Windows is adequate here: ~C-=~ to
zoom in, ~C--~ to zoom out.

It seems that starting with Emacs 27.1, Control + mousewheel works.

#+BEGIN_SRC emacs-lisp
(global-set-key (kbd "C--") 'text-scale-decrease)
(global-set-key (kbd "C-=") 'text-scale-increase)
(global-set-key (kbd "C-+") 'text-scale-increase)
#+END_SRC

* Packages

Packages are collections of =.el= files providing added functionality to Emacs.

** Meta

How do we bootstrap packages? First, let's figure out:

1. Where we get our packages from
2. How we upgrade packages
3. How we ensure our required packages are installed

*** Package archives

List of package archives.

#+NAME: package-archives
#+BEGIN_SRC emacs-lisp
  (require 'package)
  (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t)
  (add-to-list 'package-archives '("org" . "https://orgmode.org/elpa/") t)
  (package-initialize)
#+END_SRC

*** TODO Convenient package update

One-function rollup of upgradeable package tagging, download and lazy install.

#+BEGIN_SRC emacs-lisp

#+END_SRC

*** ~use-package~

We ensure =use-package= is installed, as well as all packages described in this
configuration file.

#+BEGIN_SRC emacs-lisp
  (unless (package-installed-p 'use-package)
    (package-refresh-contents)
    (package-install 'use-package)
    (eval-when-compile (require 'use-package)))
  (setq use-package-always-ensure t)
(require 'use-package)
(require 'bind-key)
#+END_SRC

** ~org-mode~

Phew, I can finally introduce Org mode! I am so *excited*.

Org mode replaces aword processor, a presentation creator, and a spreadsheet
editor. IMHO, the spreadsheet ability captures more than 80% use cases wherein
one wishes to include a table in a text document destined for physical
publication. (It is clear that Excel spreadsheets are /not/ destined for
physical publication---simply attempt to print an Excel spreadsheet with the
default settings.)  In my opinion, Org mode matches all /useful/ features of
the Microsoft Office suite 1-to-1.

What follows are customizations designed to make Org mode behave more like
Microsoft Word. The end goal is, once again, to draw as many new users to Emacs
as possible!

*** Basic customization

Org base directory is in user home on GNU/Linux, or in =AppData= in MS Windows.

#+NAME: org-basic
#+BEGIN_SRC emacs-lisp
  (setq org-directory (concat user-emacs-directory "~/org"))
#+END_SRC

First, we hide markup symbols for *bold*, /italic/, _underlined_ and
+strikethrough+ text, and ensure our document appears indented upon
loading:[fn::It /appears/ indented, but the underlying plaintext file does not
contain tab characters!]

For the time being, I will in fact display emphasis markers, because hiding
them corrupts tables.

#+NAME: org-basic
#+BEGIN_SRC emacs-lisp
  (setq org-hide-emphasis-markers nil)
  (setq org-startup-indented t)
#+END_SRC

Then, we customize Org headings to emulate WYSIWYG[fn::What You See Is What You
Get (input and output are identical), as opposed to What You See Is What You
Mean (the input contains instructions that can modify the output).] behavior
normally found in Word:

*** Invisible edits

#+BEGIN_SRC emacs-lisp
(setq org-catch-invisible-edits t)
#+END_SRC

*** Agenda

The agenda displays a chronological list of headings across all agenda files
for which the heading or body contain a matching =org-time-stamp=.[fn::An
=org-time-stamp= can be inserted with ~C-c .~ (period)]

#+BEGIN_SRC emacs-lisp
  (global-set-key (kbd "C-c a") 'org-agenda-list)

  (defun my/find-diary-file ()
    "Load `org-agenda-diary-file'."
    (interactive)
    (find-file org-agenda-diary-file))

  (global-set-key (kbd "C-c d") 'my/find-diary-file)
#+END_SRC

*** Timestamps

More literary timestamps are exported to LaTeX using the following custom
format:

#+BEGIN_SRC emacs-lisp
  (setq org-time-stamp-custom-formats
    '("%d %b, %Y (%a)" . "%d %b, %Y (%a), at %H:%M"))
#+END_SRC

*** LaTeX export

We customize the format for org time stamps to make them pop in our exported
LaTeX documents.

#+BEGIN_SRC emacs-lisp
  (setq org-latex-active-timestamp-format
        "\\texttt{%s}")
  (setq org-latex-inactive-timestamp-format
        "\\texttt{%s}")
#+END_SRC

The following packages are loaded for every LaTeX export

#+BEGIN_SRC emacs-lisp
  (setq org-latex-packages-alist
     '(("AUTO" "polyglossia" t
        ("xelatex" "lualatex"))
       ("AUTO" "babel" t
        ("pdflatex"))
       ("AUTO" "booktabs" t
        ("pdflatex"))
       ("table,svgnames" "xcolor" t
        ("pdflatex"))))
#+END_SRC

Little bonus for GNU/Linux users: syntax highlighting for source code blocks in
LaTeX exports.

#+BEGIN_SRC emacs-lisp
  (when (string-equal system-type "gnu/linux")
    (add-to-list 'org-latex-packages-alist '("AUTO" "minted" t
                                             ("pdflatex" "lualatex")))
    (setq org-latex-listings 'minted)
     (setq org-latex-minted-options
       '(("style" "friendly") ())))
#+END_SRC

The following makes =TODO= items appear red and =CLOSED= items appear green in
Org's LaTeX exports. Very stylish, much flair!

*** Export

This creates a shorter binding for the most common Org export: Org \rightarrow
LaTeX \rightarrow PDF.

#+BEGIN_SRC emacs-lisp
(defun my/org-quick-export ()
  "Org export to PDF and open.
  This basically reimplements `C-c C-e l o'."
  (interactive)
    (org-open-file (org-latex-export-to-pdf)))

(global-set-key (kbd "C-c e") 'my/org-quick-export)
#+END_SRC

** TODO ~evil-mode~

Forgive me, for I have sinned.

This is the 2^{nd} most significant customization after ~org-mode~. Enabling
~evil-mode~ completely changes editing keys. For more information on =vi=
keybindings, visit [[https://hea-www.harvard.edu/~fine/Tech/vi.html]].

#+BEGIN_SRC emacs-lisp
  (use-package evil)
;  (setq evil-toggle-key "C-c d") ; devil...
;  (evil-mode 1)
#+END_SRC

** Spelling, completion, and snippets

The following customizations open the doors to vastly increased typing speed
and accuracy.

*** ~flycheck~

Syntax highlighting for Emacs.

#+NAME: flycheck
#+BEGIN_SRC emacs-lisp
  (use-package flycheck)
  (global-flycheck-mode)
#+END_SRC

*** TODO ~flyspell~

#+NAME: flyspell
#+BEGIN_SRC emacs-lisp
  (use-package flyspell)
  (add-hook 'text-mode-hook 'flyspell-mode)
#+END_SRC

*** Insert template from keyword

Thanks to yasnippet, we can type certain keywords, press =TAB=, and this will
automatically insert a text snippet. We may then navigate through the snippet
by using =TAB= (next field) and =SHIFT-TAB= (previous field).

For instance: Typing =src= then pressing =TAB= will expand the keyword to the
following text:

: #+BEGIN_SRC emacs-lisp
:
: #+END_SRC

We notice that emacs-lisp is highlighted---this is the first modifiable field.

#+NAME: yasnippet
#+BEGIN_SRC emacs-lisp
(use-package yasnippet)
(yas-global-mode 1)
#+END_SRC

*** Complete anything interactively

#+NAME: company
#+BEGIN_SRC emacs-lisp
;  (add-hook 'after-init-hook 'global-company-mode)
#+END_SRC

*** Delete all consecutive whitespaces

#+NAME: company
#+BEGIN_SRC emacs-lisp
(use-package hungry-delete
:init (hungry-delete-mode))
#+END_SRC

** Utilities

*** Versioning of files

Wonderful Git porcelain for Emacs. Enables the administration of a Git
repository in a pain-free way.

#+BEGIN_SRC emacs-lisp
  (use-package magit
   :bind ("C-c g" . magit-status))
#+END_SRC

*** Navigate between projects

This enables us to better manage our =.git= projects.

#+BEGIN_SRC emacs-lisp
  (use-package projectile
   :bind ("C-c p" . 'projectile-command-map)
   :init (projectile-mode 1)
         (setq projectile-completion-system 'ivy))
#+END_SRC

*** Display keyboard shortcuts on screen

#+BEGIN_SRC emacs-lisp
  (use-package which-key
    :init (which-key-mode))
#+END_SRC

*** Jump to symbol's definition

#+BEGIN_SRC emacs-lisp
(use-package dumb-jump)
(add-hook 'xref-backend-functions #'dumb-jump-xref-activate)
#+END_SRC

*** Graphical representation of file history

#+BEGIN_SRC emacs-lisp
(use-package undo-tree)
(global-undo-tree-mode)
#+END_SRC

*** Auto-completion framework

#+BEGIN_SRC emacs-lisp
  (use-package ivy
    :config (setq ivy-use-virtual-buffers t
                  ivy-count-format "%d/%d "
                  enable-recursive-minibuffers t))
  (ivy-mode t)
#+END_SRC

**** Smartly suggesting interactive search matches

  Wonderful counsellor!

#+BEGIN_SRC emacs-lisp
  (use-package counsel
   :bind ("M-x" . counsel-M-x)
   :config (counsel-mode t))

  (global-set-key (kbd "C-f") 'counsel-grep-or-swiper)
#+END_SRC

**** Searching for items

#+BEGIN_SRC emacs-lisp
(use-package swiper
 :bind (("C-f" . counsel-grep-or-swiper)))
#+END_SRC

** File formats

*** =csv= and Excel

#+BEGIN_SRC emacs-lisp
  (use-package csv-mode)
#+END_SRC

*** Interacting with PDFs

Org mode shines particularly when exporting to PDF---Org files can reliably be
shared and exported to PDF in a reproducible fashion.

#+BEGIN_SRC emacs-lisp
(use-package pdf-tools)
;; (pdf-tools-install)
#+END_SRC

*** Accounting

#+BEGIN_SRC emacs-lisp
  (use-package ledger-mode
    :bind
     ("C-c r" . ledger-report)
     ("C-c C" . ledger-mode-clean-buffer))
#+END_SRC

*** Plotting & charting

#+BEGIN_SRC emacs-lisp
(use-package gnuplot)
#+END_SRC

** Cosmetics

*** Start page

We replace the standard welcome screen with our own.

#+BEGIN_SRC emacs-lisp
  (setq inhibit-startup-message t)
  (use-package dashboard
    :config
    (dashboard-setup-startup-hook)
    (setq dashboard-startup-banner (concat user-emacs-directory "img/Safran_logo.svg"))
    (setq dashboard-items '((recents  . 5)
                            (projects . 5)))
    (setq dashboard-banner-logo-title "A modern professional text editor."))
#+END_SRC

*** Mode line

#+NAME: powerline
#+BEGIN_SRC emacs-lisp
  (use-package powerline)
#+END_SRC

*** TODO Sidebar
Get inspiration from ~ibuffer-sidebar~ and create a better sidebar.

#+BEGIN_SRC emacs-lisp
;; (load-file)
#+END_SRC

*** Better parentheses

#+BEGIN_SRC emacs-lisp
(use-package rainbow-delimiters
 :config (add-hook 'prog-mode-hook #'rainbow-delimiters-mode))
(electric-pair-mode)
     (show-paren-mode 1)
#+END_SRC

*** Colored keywords for those colors

This highlights hexadecimal numbers which look like colors, in that same color.

#+BEGIN_SRC emacs-lisp
  (use-package rainbow-mode
    :init
    (add-hook 'prog-mode-hook 'rainbow-mode))
#+END_SRC

* Editing preferences

These customizations enhance editor usability. They are not brought about

** Editor

*** Coding standards

This is just a better default. Don't @ me.

#+BEGIN_SRC emacs-lisp
(setq c-default-style "linux"
      c-basic-offset 4)
#+END_SRC

*** Recent files

The keybinding for opening a recently visited file is described in paragraph
[[Opening a recently visited file]].

#+BEGIN_SRC emacs-lisp
  (recentf-mode 1)
  (setq recentf-max-menu-items 25)
  (setq recentf-max-saved-items 25)
  (run-at-time nil (* 5 60) 'recentf-save-list)
#+END_SRC

** Frame

*** Clean up menus

Originally, I wished to inhibit certain entries in the GUI menus. Not worth the
effort at this time.

#+BEGIN_SRC emacs-lisp
(menu-bar-mode -1)
(tool-bar-mode -1)
#+END_SRC

*** Dividers

This ensures users can resize windows using the GUI. It also creates a useful
separation between the bottom of the frame and the echo area.

#+BEGIN_SRC emacs-lisp
(menu-bar-bottom-and-right-window-divider)
#+END_SRC

*** TODO Header & mode line
Complete mode line rewrite. Might require new package.

Top of the buffer is more intuitive for buffer info, bottom is more intuitive
for buffer action.

This is pretty much a gutted out powerline.

**** Header line

#+BEGIN_SRC emacs-lisp
  (defun my/header-line ()
    "My header line, yo."
    (setq header-line-format
          '("%e"
            (:eval
             (let* ((active (powerline-selected-window-active))
                    (face0 (if active 'powerline-active0 'powerline-inactive0))
                    (lhs (list (powerline-raw "%b" face0)))
                    (rhs (list (if (buffer-modified-p)
                                   (powerline-raw "Modified" face0 'r)
                                 "I did it!")
                               (powerline-fill face0 0))))
               (concat (powerline-render lhs)
                       (powerline-fill face0
                                       (powerline-width rhs))
                       (powerline-render rhs)))))))

  (add-hook 'find-file-hook #'my/header-line)
#+END_SRC

**** Mode line

#+BEGIN_SRC emacs-lisp
  (defun my/mode-line ()
    "My header line, yo."
    (setq mode-line-format "%b"))

  (add-hook 'find-file-hook #'my/mode-line)
#+END_SRC


** Window

** Buffer

Save cursor location in visited buffer after closing it or Emacs.

#+BEGIN_SRC emacs-lisp
(save-place-mode 1)
#+END_SRC

*** Column filling

A line of text is considered ``filled'' when it reaches 79 characters in
length.

#+BEGIN_SRC emacs-lisp
  (setq-default fill-column 79)
#+END_SRC

Automatically break lines longer than =fill-column=.

#+BEGIN_SRC emacs-lisp
  (add-hook 'org-mode-hook 'turn-on-auto-fill)
#+END_SRC

** Minibuffer

We replace the longer ~yes-or-no-p~ questions with more convenient ~y-or-n-p~.

#+BEGIN_SRC emacs-lisp
  (defalias 'yes-or-no-p 'y-or-n-p)
#+END_SRC

Disable minibuffer scroll bar.

#+BEGIN_SRC emacs-lisp
(set-window-scroll-bars (minibuffer-window) nil nil)
#+END_SRC

* Themes

Without a carefully designed theme, our editor could become unusable. Thus, we
describe two themes that were developed purposefully and iteratively.

#+BEGIN_SRC emacs-lisp
(setq custom-theme-directory (concat user-emacs-directory "themes/"))
(load-theme 'blendoit-light)
; (load-theme 'blendoit-dark)
#+END_SRC

** My light and dark themes

A highly legible unambiguous and thoughtful theme.

*** Colors

The default face is a black foreground on a white background, this matches MS
Word. We are striving for a simple, intuitive color scheme.

Most of the visual cues derived from color are identical in both light and dark
themes (Table [[theme-color-1]]).

#+NAME: theme-color-1
#+CAPTION[Light and dark themes' colors]: Light and dark themes' colors.
#+ATTR_LATEX: :booktabs t
| Color                           | ~blendoit-light~                | ~blendoit-dark~    |
|---------------------------------+---------------------------------+--------------------|
| Black                           | default text                    | default background |
| Lighter shades                  | lesser headers                  | /n/a/              |
| White                           | default background              | default text       |
| Darker shades                   | /n/a/                           | lesser headers     |
| \color{Red} Red                 | negative                        | /same/             |
| \color{Tomato} Tomato           | timestamp `TODO'                | /same/             |
| \color{Green} Green             | positive                        | /same/             |
| \color{ForestGreen} ForestGreen | timestamp `DONE'                | /same/             |
| \color{Blue} Blue               | interactable content; links     | /same/             |
| \color{SteelBlue} SteelBlue     | anything Org mode; anchor color | /same/             |
| \color{DeepSkyBlue} DeepSkyBlue | ~highlight~                     | /same/             |
| \color{DodgerBlue} DodgerBlue   | ~isearch~                       | /same/             |
| \color{Purple} Purple           |                                 |                    |

*** Cursors

In order to imitate other modern text editors, we resort to a blinking bar
cursor. We choose red, the most captivating color, because the cursor is
arguably the region on our screen:

1. most often looked at;
2. most often searched when lost.

In files containing only ~fixed-pitch~ fonts (i.e. files containing only code),
the cursor becomes a high-visibility box.

In files containing a mix of ~variable-pitch~ and ~fixed-pitch~ fonts, the
cursor is a more MS Word-like bar.

#+BEGIN_SRC emacs-lisp
(setq-default cursor-type (quote bar))
#+END_SRC

*** Faces

- ~default~: Hack
  - Legible, modern monospace font
  - Strict, sharp, uncompromising
- ~fixed-pitch~: Hack
- ~variable-pitch~: Liberation Sans
  - Libre alternative to Arial
- ~org-block~: Hermit
  - Slightly wider than Hack
  - More opinionated shapes
  - Very legible parentheses

**** ~variable-pitch-mode~

We use ~variable-pitch-mode~ for appropriate modes.

#+BEGIN_SRC emacs-lisp
(add-hook 'org-mode-hook 'variable-pitch-mode)
(add-hook 'info-mode-hook 'variable-pitch-mode)
#+END_SRC

**** TODO Default font size

Make default font size larger on displays of which the resolution is greater
than =1920x1080=.

#+BEGIN_SRC emacs-lisp
#+END_SRC

** TODO ~minimal~

* Late setup

At this point, our editor is almost ready to run. Phew! All that's left to do
is to interrupt our profiling activities, and smartly store the result of our
profiling.

** Profiling --- stop

#+BEGIN_SRC emacs-lisp
;; (profiler-stop)
#+END_SRC

** Profiling --- report

#+BEGIN_SRC emacs-lisp
;; (profiler-report)
#+END_SRC

* Conclusion

In this configuration file, we described a series of customization steps taken
to make Emacs more palatable to modern IDE users.
Copyright 2019--2024 Marius PETER