mirror of https://github.com/Chizi123/.emacs.d.git

Joel Grunbaum
2020-10-05 0c962c57156f8df515359e7ea919b48742a56632
commit | author | age
990949 1 #+TITLE: My Emacs configuration
5a75e4 2 #  LocalWords:  poppler mingw emacs eq nt gnuplot setenv mapconcat el cond minibuffer pdf color Smartparens smartparens yas aindent whitespace eldoc ielm ibuffer hippie pscp pos Spaceline spaceline powerline spacemacs seperator dir Yasnippet yasnippet flycheck magit fullscreen CEDET askifnotset semanticdb EDE ede gdb srefactor analyzer eval cdb autosetup ghostscript math unicode reftex bibtex TeXcount texcount str latin rkt PlantUML plantuml autoload alist matlab verilog ds vh src fontify natively fortran dvipng plist xcolor EXWM Zenburn setq zenburn defun dolist init config DejaVu ispell aspell flyspell kbd recentf sexp ov bg listp defadvice progn prog keyfreq autosave dabbrev hl gc linum linux utf RET ARG arg configs backends contribs AucTex tex auctex LaTeX url htmlize linter backend writegood ggtags gtags dired eshell asm cd dwim VHDL defvar ctags vhdl concat sp html awk defalias cedet mips IPython ein contrib pandoc dokuwiki EMMS MPD emms toc favicon href css stylesheet async dataLayer gtag js UA sitelinks br Github postamble isso center disqus onclick Disqus javascript dsq createElement getElementsByTagName xml urlset xmlns curr loc RSS elfeed
8a38cc 3
bf794a 4 * COMMENT Windows dependencies
80d515 5 Dependencies needed for Aspell, poppler PDF-tools, compilers and ghost-script provided by mingw64 in windows.
990949 6 #+BEGIN_SRC emacs-lisp
C 7   (when (eq system-type 'windows-nt)
8     (add-to-list 'exec-path "C:/msys64/usr/bin")
9     (add-to-list 'exec-path "C:/msys64/mingw64/bin")
10     (add-to-list 'exec-path "c:/Program Files/gnuplot")
11     (setenv "PATH" (mapconcat #'identity exec-path path-separator)))
12 #+END_SRC
13
14 * Aesthetic changes
0fcc09 15 ** Emacs theme
80d515 16 Theme switcher, using a cond allows loading of many preconfigured themes which can be switched between easily.
JG 17 Zenburn theme is my default.
990949 18 #+BEGIN_SRC emacs-lisp
0fcc09 19   (setq emacs-theme 'zenburn)
80d515 20
JG 21   (defun disable-all-themes ()
22       (dolist (i custom-enabled-themes)
23            (disable-theme i)))
412080 24
0fcc09 25   (cond ((eq emacs-theme 'zenburn)
C 26          (use-package zenburn-theme
27            :ensure t
412080 28            :init
C 29            (disable-all-themes)
0fcc09 30            :config
C 31            (load-theme 'zenburn t)))
32         ((eq emacs-theme 'doom-one)
33          (use-package doom-themes
34            :ensure t
412080 35            :init
C 36            (disable-all-themes)
0fcc09 37            :config
C 38            (setq doom-themes-enable-bolt t
39                  doom-themes-enable-italic t)
40            (load-theme 'doom-one t)
41            (doom-themes-visual-bell-config)
412080 42            (doom-themes-org-config)))
a428a2 43         ((eq emacs-theme 'nord)
JG 44          (use-package nord-theme
45            :ensure t
46            :init
47            (disable-all-themes)
48            :config
49            (load-theme 'nord t)))
b0ee5f 50         ((eq emacs-theme 'solarized)
JG 51          (use-package solarized-theme
52            :ensure t
53            :init
54            (disable-all-themes)
55            :config
56            (load-theme 'solarized-dark t)))
995f2c 57         ((eq emacs-theme 'jetbrains-darcula)
JG 58          (use-package jetbrains-darcula-theme
59            :ensure t
60            :init
61            (disable-all-themes)
62            :config
63            (load-theme 'jetbrains-darcula t)))
412080 64         ((eq emacs-theme 'none)
80d515 65          (disable-all-themes)))
990949 66 #+END_SRC
8a38cc 67
990949 68 ** Default font
80d515 69 Set default font and faces.
20e001 70 #+BEGIN_SRC emacs-lisp 
350884 71   (cond ((member "Dank Mono" (font-family-list))
JG 72          (set-frame-font "Dank Mono-11" nil t))
73         ((member "DejaVu Sans Mono" (font-family-list))
74          (set-frame-font "DejaVu Sans Mono" nil t))
75         ((member "Source Code Pro" (font-family-list))
76          (set-frame-font "Source Code Pro-10" nil t)))
77
20e001 78   (set-face-italic 'font-lock-comment-face t)
C 79   (set-face-italic 'font-lock-keyword-face t)
990949 80 #+END_SRC
8a38cc 81
990949 82 ** Remove menu bar, toolbar, but keep scroll bar
80d515 83 Make the emacs interface slightly nicer.
990949 84 #+BEGIN_SRC emacs-lisp
C 85   (menu-bar-mode 0)
86   (tool-bar-mode 0)
87   (scroll-bar-mode 1)
88 #+END_SRC
350884 89 * COMMENT EXWM
JG 90 Emacs window manager.
91 Tiling window manager that runs in emacs.
5a75e4 92 Open external applications with =s-&=
350884 93 #+BEGIN_SRC emacs-lisp
JG 94   (use-package exwm
95     :ensure t
96     :config
97     (require 'exwm-config)
98     (exwm-config-default))
99 #+END_SRC
990949 100
C 101 * Writing requirements
102 ** Spellchecking
80d515 103 Use aspell for spellchecking. 
JG 104 Auto-enable in latex and org as they're the main writing modes.
990949 105 #+BEGIN_SRC emacs-lisp
C 106   (require 'ispell)
107   (setq-default ispell-program-name "aspell")
108   (setq-default ispell-local-dictionary "en_AU")
109   (add-hook 'latex-mode-hook 'flyspell-mode)
0ba1ff 110   ;; (add-hook 'latex-mode-hook 'flyspell-buffer)
990949 111   (add-hook 'org-mode-hook 'flyspell-mode)
0ba1ff 112   ;; (add-hook 'org-mode-hook 'flyspell-buffer)
f1b53f 113   (diminish 'flyspell-mode)
a428a2 114
990949 115 #+END_SRC
C 116
117 ** Switch-window
80d515 118 Helps to change windows easily when many are open at once.
990949 119 #+BEGIN_SRC emacs-lisp
C 120 (use-package switch-window
121   :ensure t
122   :config
123     (setq switch-window-input-style 'minibuffer)
124     (setq switch-window-increase 4)
125     (setq switch-window-threshold 2)
126     (setq switch-window-shortcut-style 'qwerty)
127     (setq switch-window-qwerty-shortcuts
128         '("a" "s" "d" "f" "j" "k" "l" "i" "o"))
129   :bind
130     ([remap other-window] . switch-window))
131 #+END_SRC
8a38cc 132
990949 133 ** Go to new window when opened
80d515 134 Go to new window when its opened instead of staying with current one.
990949 135 #+BEGIN_SRC emacs-lisp
C 136   (defun split-and-follow-horizontally ()
137     (interactive)
138     (split-window-below)
139     (balance-windows)
140     (other-window 1))
141   (global-set-key (kbd "C-x 2") 'split-and-follow-horizontally)
142
143   (defun split-and-follow-vertically ()
144     (interactive)
145     (split-window-right)
146     (balance-windows)
147     (other-window 1))
148   (global-set-key (kbd "C-x 3") 'split-and-follow-vertically)
149 #+END_SRC
8a38cc 150
990949 151 ** PDF-tools
80d515 152 Helpful pdf viewer.
990949 153 #+BEGIN_SRC emacs-lisp
bf794a 154   (use-package pdf-tools
JG 155     :ensure t
156     :config
157     (pdf-tools-install 1))
990949 158 #+END_SRC
8a38cc 159
be9cff 160 ** COMMENT Writegood-mode
80d515 161 Supposedly should provide insight to writing quality.
49aa9f 162 #+BEGIN_SRC emacs-lisp
JG 163   (use-package writegood-mode
164     :ensure t
165     :hook (text-mode . writegood-mode))
166 #+END_SRC
167
990949 168 * Helm and Projectile
C 169 ** Helm core
80d515 170 Helm aids the user interface for emacs. Adds visual and auto-complete feedback for emacs commands.
990949 171 #+BEGIN_SRC emacs-lisp
C 172   (use-package helm-config
173     :ensure helm
174     :bind (("M-x" . helm-M-x)
175            ("C-x C-f" . helm-find-files)
176            ("M-y" . helm-show-kill-ring)
177            ("C-x b" . helm-mini)
178            ("C-c h o" . helm-occur))
179     :config
180     (setq helm-M-x-fuzzy-match t)
181     (setq helm-buffers-fuzzy-matching t
182           helm-recentf-fuzzy-match    t)
183     (setq helm-split-window-in-side-p           t ; open helm buffer inside current window, not occupy whole other window
184           helm-move-to-line-cycle-in-source     t ; move to end or beginning of source when reaching top or bottom of source.
185           helm-ff-search-library-in-sexp        t ; search for library in `require' and `declare-function' sexp.
186           helm-scroll-amount                    8 ; scroll 8 lines other window using M-<next>/M-<prior>
187           helm-ff-file-name-history-use-recentf t
188           helm-echo-input-in-header-line t)
189     (defun spacemacs//helm-hide-minibuffer-maybe ()
190       "Hide minibuffer in Helm session if we use the header line as input field."
191       (when (with-helm-buffer helm-echo-input-in-header-line)
192         (let ((ov (make-overlay (point-min) (point-max) nil nil t)))
193           (overlay-put ov 'window (selected-window))
194           (overlay-put ov 'face
195                        (let ((bg-color (face-background 'default nil)))
196                          `(:background ,bg-color :foreground ,bg-color)))
197           (setq-local cursor-type nil))))
198     (add-hook 'helm-minibuffer-set-up-hook
199               'spacemacs//helm-hide-minibuffer-maybe)
200     (helm-mode 1))
201 #+END_SRC
8a38cc 202
990949 203 ** Projectile
80d515 204 Projectile is project management framework for emacs.
JG 205 Helps in navigation and management of projects.
206 Identifies project layout from git.
990949 207 *** Enable it
C 208  #+BEGIN_SRC emacs-lisp
209    (use-package projectile
210      :ensure t
211      :bind ("C-c p" . projectile-command-map)
212      :diminish projectile-mode
213      :config
214      (projectile-global-mode)
215      (setq projectile-completion-system 'helm)
216      (when (eq system-type 'windows-nt)
217        (setq projectile-indexing-method 'alien)))
218  #+END_SRC
8a38cc 219
990949 220 *** Let it compile things
80d515 221 Shortcut for compilation.
990949 222  #+BEGIN_SRC emacs-lisp
C 223    (global-set-key (kbd "<f5>") 'projectile-compile-project)
224  #+END_SRC
8a38cc 225
990949 226 *** Enable communication with helm
80d515 227 Use helm to manage project.
990949 228 #+BEGIN_SRC emacs-lisp
baf326 229   (use-package helm-projectile
C 230     :ensure t
231     :config
232     (helm-projectile-on))
990949 233 #+END_SRC
8a38cc 234
be9cff 235 ** COMMENT ggtags
0ba1ff 236 Use GNU Global Tags. Can be useful for large projects.
bf794a 237 #+BEGIN_SRC emacs-lisp
JG 238     (use-package ggtags
239       :ensure t
240       :bind (("C-c g s" . ggtags-find-other-symbol)
241            ("C-c g h" . ggtags-view-tag-history)
242            ("C-c g r" . ggtags-find-reference)
243            ("C-c g f" . ggtags-find-file)
244            ("C-c g c" . ggtags-create-tags)
245            ("C-c g u" . ggtags-update-tags))
246       :config
247       (add-hook 'c-mode-common-hook
248               (lambda ()
249                 (when (derived-mode-p 'c-mode 'c++-mode 'java-mode)
250                   (ggtags-mode 1))))
251       )
252
253     (setq
254      helm-gtags-ignore-case t
255      helm-gtags-auto-update t
256      helm-gtags-use-input-at-cursor t
257      helm-gtags-pulse-at-cursor t
258      helm-gtags-prefix-key "\C-c g"
259      helm-gtags-suggested-key-mapping t
260      )
261
262     (use-package helm-gtags
263       :ensure t
264       :config
265       (add-hook 'dired-mode-hook 'helm-gtags-mode)
266       (add-hook 'eshell-mode-hook 'helm-gtags-mode)
267       (add-hook 'c-mode-hook 'helm-gtags-mode)
268       (add-hook 'c++-mode-hook 'helm-gtags-mode)
269       (add-hook 'asm-mode-hook 'helm-gtags-mode)
270     
271       (define-key helm-gtags-mode-map (kbd "C-c g a") 'helm-gtags-tags-in-this-function)
272       (define-key helm-gtags-mode-map (kbd "C-j") 'helm-gtags-select)
273       (define-key helm-gtags-mode-map (kbd "M-.") 'helm-gtags-dwim)
274       (define-key helm-gtags-mode-map (kbd "M-,") 'helm-gtags-pop-stack)
275       (define-key helm-gtags-mode-map (kbd "C-c <") 'helm-gtags-previous-history)
276       (define-key helm-gtags-mode-map (kbd "C-c >") 'helm-gtags-next-history))
277 #+END_SRC
278
be9cff 279 ** COMMENT Ctags
0ba1ff 280 Ctags is an older tagging program that supports more languages.
JG 281 Currently setup for VHDL as I had to work with a large existing VHDL code-base.
bf794a 282 #+BEGIN_SRC emacs-lisp
JG 283   (defvar ctags-command "ctags -e -R --languages=vhdl")
284
285   (defun ctags ()
286     (call-process-shell-command ctags-command nil "*Ctags*"))
287
288
289   (defun ctags-find-tags-file ()
290     "Recursively searches each parent directory for a file named
291                 TAGS and returns the path to that file or nil if a tags file is
292                 not found or if the buffer is not visiting a file."
293     (progn
294       (defun find-tags-file-r (path)
295         "Find the tags file from current to the parent directories."
296         (let* ((parent-directory (file-name-directory (directory-file-name path)))
297                (tags-file-name (concat (file-name-as-directory path) "TAGS")))
298           (cond
299            ((file-exists-p tags-file-name) (throw 'found tags-file-name))
300            ((string= "/TAGS" tags-file-name) nil)
301            (t (find-tags-file-r parent-directory)))))
302
303       (if (buffer-file-name)
304           (catch 'found
305             (find-tags-file-r (file-name-directory buffer-file-name)))
306         nil)))
307
308   (defun ctags-set-tags-file ()
309     "Uses `ctags-find-tags-file' to find a TAGS file. If found,
310                 set 'tags-file-name' with its path or set as nil."
311     (setq-default tags-file-name (ctags-find-tags-file)))
312
313   (defun ctags-create-tags-table ()
314     (interactive)
315     (let* ((current-directory default-directory)
316            (top-directory (read-directory-name
317                            "Top of source tree: " default-directory))
318            (file-name (concat (file-name-as-directory top-directory) "TAGS")))
319       (cd top-directory)
320       (if (not (= 0 (ctags)))
321           (message "Error creating %s!" file-name)
322         (setq-default tags-file-name file-name)
323         (message "Table %s created and configured." tags-file-name))
324       (cd current-directory)))
325
326   (defun ctags-update-tags-table ()
327     (interactive)
328     (let ((current-directory default-directory))
329       (if (not tags-file-name)
330           (message "Tags table not configured.")
331         (cd (file-name-directory tags-file-name))
332         (if (not (= 0 (ctags)))
333             (message "Error updating %s!" tags-file-name)
334           (message "Table %s updated." tags-file-name))
335         (cd current-directory))))
336
337   (defun ctags-create-or-update-tags-table ()
338     "Create or update a tags table with `ctags-command'."
339     (interactive)
340     (if (not (ctags-set-tags-file))
341         (ctags-create-tags-table)
342       (ctags-update-tags-table)))
343
344
345   (defun ctags-search ()
346     "A wrapper for `tags-search' that provide a default input."
347     (interactive)
348     (let* ((symbol-at-point (symbol-at-point))
349            (default (symbol-name symbol-at-point))
350            (input (read-from-minibuffer
351                    (if (symbol-at-point)
352                        (concat "Tags search (default " default "): ")
353                      "Tags search (regexp): "))))
354       (if (and (symbol-at-point) (string= input ""))
355           (tags-search default)
356         (if (string= input "")
357             (message "You must provide a regexp.")
358           (tags-search input)))))
359 #+END_SRC
360
990949 361 * Small tweaks
C 362 ** Remove startup screen
0ba1ff 363 Start on scratch buffer instead.
990949 364 #+BEGIN_SRC emacs-lisp
C 365 (setq inhibit-startup-message t)
366 #+END_SRC
8a38cc 367
990949 368 ** Disable bell
0ba1ff 369 Bloody bell dings every time you hit a key too much.
990949 370 #+BEGIN_SRC emacs-lisp
C 371 (setq ring-bell-function 'ignore)
372 #+END_SRC
8a38cc 373
990949 374 ** Pretty symbols
0ba1ff 375 Why not? They make it look nice.
990949 376 #+BEGIN_SRC emacs-lisp
C 377   (when window-system
378     (use-package pretty-mode
379       :ensure t
380       :diminish t
381       :config
382       (global-pretty-mode)))
383 #+END_SRC
8a38cc 384
0ba1ff 385 ** COMMENT Find file other window
990949 386 Lets it accept more than one file. Works recursively.
C 387 #+BEGIN_SRC emacs-lisp
388 (defadvice find-file-other-window (around find-files activate)
389   (if (listp filename)
390       (loop for f in filename do (find-file-other-window f wildcards))
391     ad-do-it))
392 #+END_SRC
8a38cc 393
990949 394 ** Which key
0ba1ff 395 Helps to explain keybindings if you get lost.
990949 396 #+BEGIN_SRC emacs-lisp
C 397   (use-package which-key
398     :ensure t
399     :diminish which-key-mode
400     :config
401     (which-key-mode))
402 #+END_SRC
8a38cc 403
bf794a 404 ** Config shortcuts
JG 405 *** Go to this file
990949 406 #+BEGIN_SRC emacs-lisp
C 407 (defun config-visit ()
408   (interactive)
409   (find-file "~/.emacs.d/config.org"))
410 (global-set-key (kbd "C-c e d") 'config-visit)
411 #+END_SRC
8a38cc 412
bf794a 413 *** Go to init.el
990949 414 #+BEGIN_SRC emacs-lisp
C 415   (defun init-visit ()
416     (interactive)
417     (find-file "~/.emacs.d/init.el"))
418   (global-set-key (kbd "C-c e i") 'init-visit)
419 #+END_SRC
8a38cc 420
bf794a 421 *** Reload configuration
990949 422 #+BEGIN_SRC emacs-lisp
C 423 (defun config-reload ()
424   "Reloads ~/.emacs.d/config.org at run time"
425   (interactive)
426   (org-babel-load-file (expand-file-name "~/.emacs.d/config.org")))
427 (global-set-key (kbd "C-c e r") 'config-reload)
428 #+END_SRC
8a38cc 429
990949 430 ** Smartparens
0ba1ff 431 Matches brackets automatically. Added "$" for latex in org mode.
990949 432 #+BEGIN_SRC emacs-lisp
0ba1ff 433   (use-package smartparens
JG 434     :ensure t
435     :diminish smartparens-mode
436     :config
437     (progn
438       (require 'smartparens-config)
439       (smartparens-global-mode 1))
440     (sp-with-modes 'org-mode
441       (sp-local-pair "$" "$")))
990949 442 #+END_SRC
8a38cc 443
0ba1ff 444 ** COMMENT Rainbow
JG 445 Its a little gimmicky but its still cool.
446 Colours according to code after a "#", works with 3 and 6 character hex codes.
990949 447 #+BEGIN_SRC emacs-lisp
C 448   (use-package rainbow-mode
449     :ensure t
450     :diminish rainbow-mode
451     :init
452     (add-hook 'prog-mode-hook 'rainbow-mode))
453 #+END_SRC
8a38cc 454
990949 455 ** Rainbow delimiters
C 456 A bit more useful than above.
457 Colours the brackets so that they stand out more.
458 #+BEGIN_SRC emacs-lisp
459   (use-package rainbow-delimiters
460     :ensure t
461     :init
462       (add-hook 'prog-mode-hook #'rainbow-delimiters-mode))
463 #+END_SRC
8a38cc 464
0ba1ff 465 ** Following whitespace
990949 466 Removes unnecessary white space
C 467 #+BEGIN_SRC emacs-lisp
0ba1ff 468   (use-package clean-aindent-mode
JG 469     :ensure t
470     :hook prog-mode)
990949 471 #+END_SRC
C 472 Shows trailing white space
473 #+BEGIN_SRC emacs-lisp
474 (add-hook 'prog-mode-hook (lambda () (interactive) (setq show-trailing-whitespace 1)))
475 #+END_SRC
8a38cc 476
0ba1ff 477 ** Whitespace mode
990949 478 Reveals whitespace characters
C 479 #+BEGIN_SRC emacs-lisp
480 (global-set-key (kbd "C-c w") 'whitespace-mode)
481 (add-hook 'diff-mode-hook (lambda ()
482                             (setq-local whitespace-style
483                                         '(face
484                                           tabs
485                                           tab-mark
486                                           spaces
487                                           space-mark
488                                           trailing
489                                           indentation::space
490                                           indentation::tab
491                                           newline
492                                           newline-mark))
493                             (whitespace-mode 1)))
494
495 #+END_SRC
8a38cc 496
990949 497 ** eldoc
0ba1ff 498 Shows function arguments in echo area below mode line.
990949 499 #+BEGIN_SRC emacs-lisp
f1b53f 500   (diminish 'eldoc-mode)
990949 501   (add-hook 'emacs-lisp-mode-hook 'eldoc-mode)
C 502   (add-hook 'lisp-interaction-mode-hook 'eldoc-mode)
503   (add-hook 'ielm-mode-hook 'eldoc-mode)
504 #+END_SRC
8a38cc 505
0ba1ff 506 ** Key frequency statistics
JG 507 Collects interesting statistics about key presses.
508 Use M-x keyfreq-show to show in emacs or M-x keyfreq-html to output
990949 509 #+BEGIN_SRC emacs-lisp
C 510 (use-package keyfreq
511   :ensure t
512   :config
513   (keyfreq-mode 1)
514   (keyfreq-autosave-mode 1))
515 #+END_SRC
8a38cc 516
0ba1ff 517 ** Undo tree
JG 518 A more advanced undo mechanism.
519 Supports branched undo history (thus the tree).
520 Pretty neat, if seldom used.
990949 521 #+BEGIN_SRC emacs-lisp
C 522 (use-package undo-tree
523   :ensure t
524   :diminish undo-tree-mode
525   :config
526   (global-undo-tree-mode))
527 #+END_SRC
8a38cc 528
0ba1ff 529 ** Volatile highlights
990949 530 Colour the material just copied
C 531 #+BEGIN_SRC emacs-lisp
532 (use-package volatile-highlights
533   :ensure t
534   :diminish volatile-highlights-mode
535   :config
536   (volatile-highlights-mode t))
537 #+END_SRC
8a38cc 538
990949 539 ** ibuffer
0ba1ff 540 View all open buffers in their own buffer rather in the temporary mini buffer.
990949 541 #+BEGIN_SRC emacs-lisp
C 542 (global-set-key (kbd "C-x C-b") 'ibuffer)
543 (setq ibuffer-use-other-window t)
544 #+END_SRC
8a38cc 545
0ba1ff 546 ** Hippie expand
JG 547 Seems cool, but I don't think I ever use this.
548 Meant to suggest completions to beginning of a word.
990949 549 #+BEGIN_SRC emacs-lisp
C 550 (global-set-key (kbd "M-/") 'hippie-expand) ;; replace dabbrev-expand
551 (setq
552  hippie-expand-try-functions-list
553  '(try-expand-dabbrev ;; Try to expand word "dynamically", searching the current buffer.
554    try-expand-dabbrev-all-buffers ;; Try to expand word "dynamically", searching all other buffers.
555    try-expand-dabbrev-from-kill ;; Try to expand word "dynamically", searching the kill ring.
556    try-complete-file-name-partially ;; Try to complete text as a file name, as many characters as unique.
557    try-complete-file-name ;; Try to complete text as a file name.
558    try-expand-all-abbrevs ;; Try to expand word before point according to all abbrev tables.
559    try-expand-list ;; Try to complete the current line to an entire line in the buffer.
560    try-expand-line ;; Try to complete the current line to an entire line in the buffer.
561    try-complete-lisp-symbol-partially ;; Try to complete as an Emacs Lisp symbol, as many characters as unique.
562    try-complete-lisp-symbol) ;; Try to complete word as an Emacs Lisp symbol.
563  )
564 #+END_SRC
8a38cc 565
990949 566 ** Highlight line
0ba1ff 567 Very useful for finding where you are.
990949 568 #+BEGIN_SRC emacs-lisp
C 569 (global-hl-line-mode)
570 #+END_SRC
8a38cc 571
990949 572 ** Line numbers
0ba1ff 573 Everyone needs line numbers when programming.
990949 574 #+BEGIN_SRC emacs-lisp
C 575 (add-hook 'prog-mode-hook 'linum-mode)
576 #+END_SRC
577
578 ** Garbage collection
0ba1ff 579 Starts garbage collection every 100MB.
990949 580 #+BEGIN_SRC emacs-lisp
C 581 (setq gc-cons-threshold 100000000)
582 #+END_SRC
583
584 ** Kill ring
585 Changes the kill ring size to 5000.
586 #+BEGIN_SRC emacs-lisp
587   (setq global-mark-ring-max 5000
588     mark-ring-max 5000
589     mode-require-final-newline t
590     kill-ring-max 5000
591     kill-whole-line t)
592 #+END_SRC
8a38cc 593
990949 594 ** Coding style
0ba1ff 595 Use java for java, awk for awk and K&R for everything else.
JG 596 K&R uses 4 space tabs.
990949 597 #+BEGIN_SRC emacs-lisp
bf794a 598   (setq c-default-style '((java-mode . "java")
JG 599                          (awk-mode . "awk")
600                          (other . "k&r")))
990949 601 #+END_SRC
C 602
603 ** Coding system
0ba1ff 604 Cause we all love UTF8
990949 605 #+BEGIN_SRC emacs-lisp
bf794a 606   (set-terminal-coding-system 'utf-8)
JG 607   (set-keyboard-coding-system 'utf-8)
608   (set-language-environment "UTF-8")
609   (prefer-coding-system 'utf-8)
610   (setq-default indent-tabs-mode t
611             tab-width 4)
612   (delete-selection-mode)
613   (global-set-key (kbd "RET") 'newline-and-indent)
990949 614 #+END_SRC
8a38cc 615
990949 616 ** Move to beginning of line ignoring whitespace
C 617 Move point back to indentation of beginning of line.
0ba1ff 618 Pretty good for getting to the start of what you actually wanted.
990949 619
C 620 Move point to the first non-whitespace character on this line.
621 If point is already there, move to the beginning of the line.
622 Effectively toggle between the first non-whitespace character and
623 the beginning of the line.
624
625 If ARG is not nil or 1, move forward ARG - 1 lines first. If
626 point reaches the beginning or end of the buffer, stop there.
627 #+BEGIN_SRC emacs-lisp
628 (defun prelude-move-beginning-of-line (arg)
629   (interactive "^p")
630   (setq arg (or arg 1))
631
632   ;; Move lines first
633   (when (/= arg 1)
634     (let ((line-move-visual nil))
635       (forward-line (1- arg))))
636
637   (let ((orig-point (point)))
638     (back-to-indentation)
639     (when (= orig-point (point))
640       (move-beginning-of-line 1))))
641
642 (global-set-key (kbd "C-a") 'prelude-move-beginning-of-line)
643 #+END_SRC
8a38cc 644
990949 645 ** Indent region or buffer
0ba1ff 646 Indent, slightly different to standard tab or C-M-\.
990949 647 #+BEGIN_SRC emacs-lisp
C 648 (defun indent-region-or-buffer ()
649   "Indent a region if selected, otherwise the whole buffer."
650   (interactive)
651   (unless (member major-mode prelude-indent-sensitive-modes)
652     (save-excursion
653       (if (region-active-p)
654           (progn
655             (indent-region (region-beginning) (region-end))
656             (message "Indented selected region."))
657         (progn
658           (indent-buffer)
659           (message "Indented buffer.")))
660       (whitespace-cleanup))))
661
662 (global-set-key (kbd "C-c i") 'indent-region-or-buffer)
663 #+END_SRC
8a38cc 664
990949 665 ** Tramp
0ba1ff 666 Remote editing mode.
JG 667 Hate having to re-input passwords.
990949 668 #+BEGIN_SRC emacs-lisp
C 669   (when (eq system-type 'windows-nt)
670     (setq tramp-default-method "pscp"))
671   (setq password-cache-expiry nil)
672 #+END_SRC
673
0ba1ff 674 ** COMMENT Y or N instead of yes or no
JG 675 Need not type out whole word.
676 #+BEGIN_SRC emacs-lisp
677   (defalias 'yes-or-no-p 'y-or-n-p)
678 #+END_SRC
679
990949 680 * Mode line tweaks
C 681 Diminish is used but is included in init.el such that it can be used throughout this document
682 ** Spaceline
0ba1ff 683 A little easier to read than the default emacs mode line.
990949 684 #+BEGIN_SRC emacs-lisp
412080 685     (use-package spaceline
C 686       :ensure t
687       :config
688       (require 'spaceline-config)
689       (setq spaceline-buffer-encoding-abbrev-p t)
690       (setq spaceline-line-column-p t)
691       (setq spaceline-line-p t)
692       (setq powerline-default-separator (quote arrow))
693       (spaceline-spacemacs-theme)
694       (spaceline-helm-mode))
990949 695 #+END_SRC
8a38cc 696
1005e3 697 *** Separator
JG 698 Slightly nicer separator.
699 #+BEGIN_SRC emacs-lisp
700 (setq powerline-default-separator nil)
701 #+END_SRC
702
0c962c 703 ** Nyan mode
JG 704 Use nyan cat as a reference for buffer progression.
705 #+BEGIN_SRC emacs-lisp
706   (use-package nyan-mode
707     :ensure t
708     :config
709     (nyan-mode 1))
710 #+END_SRC
711
990949 712 * Programming tweaks
C 713 ** Yasnippet
0ba1ff 714 Add snippets, pretty useful.
JG 715 Manually added snippets are in ~/.emacs.d/snippets/{mode}.
990949 716 #+BEGIN_SRC emacs-lisp
bf794a 717   (use-package yasnippet
JG 718     :ensure t
719     :diminish yas-minor-mode
720     :config
721     (use-package yasnippet-snippets
722       :ensure t)
723     (yas-reload-all)
724     (yas-global-mode 1))
990949 725 #+END_SRC
8a38cc 726
0ba1ff 727 ** Flycheck
JG 728 Basic linter. Works pretty well.
990949 729 #+BEGIN_SRC emacs-lisp
8a38cc 730   (use-package flycheck
C 731     :ensure t
732     :diminish flycheck-mode
733     :config
734     (global-flycheck-mode))
990949 735 #+END_SRC
0ba1ff 736 *** flycheck-pos-tip
JG 737 Add suggestions at the cursor.
990949 738 #+BEGIN_SRC emacs-lisp
C 739 (use-package flycheck-pos-tip
740   :ensure t
741   :after flycheck
742   :config
743   (flycheck-pos-tip-mode))
744 #+END_SRC
8a38cc 745
990949 746 ** Company
0ba1ff 747 Company is auto-complete for Emacs.
JG 748 Uses various backends, more of which are added later.
990949 749 #+BEGIN_SRC emacs-lisp
C 750   (use-package company
751     :ensure t
752     :diminish company-mode
753     :config
754     (global-company-mode)
755     (setq company-idle-delay 0)
756     (setq company-minimum-prefix-length 3))
757 #+END_SRC
8a38cc 758
da7a13 759 ** Version control
JG 760 Settings for emacs' own version control system.
761 *** Enable version control on the mode line
762 #+BEGIN_SRC emacs-lisp
763   (vc-mode)
764 #+END_SRC
990949 765 ** Magit
0ba1ff 766 Emacs git client.
JG 767 Pretty good and offers fairly decent features.
990949 768 #+BEGIN_SRC emacs-lisp
C 769   (use-package magit
770     :ensure t
771     :commands magit-get-top-dir
772     :bind ("C-x g" . magit-status)
773     :init
774     (progn
775       ;; make magit status go full-screen but remember previous window
776       ;; settings
777       ;; from: http://whattheemacsd.com/setup-magit.el-01.html
778       (defadvice magit-status (around magit-fullscreen activate)
779         (window-configuration-to-register :magit-fullscreen)
780         ad-do-it
781         (delete-other-windows))
782
783       ;; Close popup when committing - this stops the commit window
784       ;; hanging around
785       ;; From: http://git.io/rPBE0Q
786       (defadvice git-commit-commit (after delete-window activate)
787         (delete-window))
788
789       (defadvice git-commit-abort (after delete-window activate)
790         (delete-window))
791
792       :config
793       (progn
794         ;; restore previously hidden windows
795         (defadvice magit-quit-window (around magit-restore-screen activate)
796           (let ((current-mode major-mode))
797             ad-do-it
798             ;; we only want to jump to register when the last seen buffer
799             ;; was a magit-status buffer.
800             (when (eq 'magit-status-mode current-mode)
801               (jump-to-register :magit-fullscreen)))))
802
803       ;; magit settings
804       (setq
805        ;; don't put "origin-" in front of new branch names by default
806        magit-default-tracking-name-function 'magit-default-tracking-name-branch-only
807        ;; open magit status in same window as current buffer
808        magit-status-buffer-switch-function 'switch-to-buffer
809        ;; highlight word/letter changes in hunk diffs
810        magit-diff-refine-hunk t
811        ;; ask me if I want to include a revision when rewriting
812        magit-rewrite-inclusive 'ask
813        ;; ask me to save buffers
814        magit-save-some-buffers t
815        ;; pop the process buffer if we're taking a while to complete
816        magit-process-popup-time 10
817        ;; ask me if I want a tracking upstream
818        magit-set-upstream-on-push 'askifnotset
819        )))
820 #+END_SRC
8a38cc 821
990949 822 ** CEDET
0ba1ff 823 *** Semantic
JG 824 Parser library for code, supports many other packages.
825 Allows emacs to be mode aware of what is being written.
990949 826 #+BEGIN_SRC emacs-lisp
C 827   (use-package semantic
828     :config
829     (global-semanticdb-minor-mode 1)
830     (global-semantic-idle-scheduler-mode 1)
831     (global-semantic-idle-summary-mode 1)
832     (semantic-mode 1))
833 #+END_SRC
8a38cc 834
a428a2 835 *** COMMENT EDE
0ba1ff 836 Emacs Development Environment.
JG 837 Can be used to manage and create build files for a project.
990949 838 #+BEGIN_SRC emacs-lisp
C 839 (use-package ede
840   :config
841   (global-ede-mode t))
842 #+END_SRC
8a38cc 843
990949 844 *** gdb-many-windows
0ba1ff 845 Enhances the use of GDB in emacs.
JG 846 Shows register contents, variable contents and others in addition to GDB shell.
847 Also shows source code while debugging.
990949 848 #+BEGIN_SRC emacs-lisp
C 849 (setq
850  gdb-many-windows t
851  gdb-show-main t)
852 #+END_SRC
8a38cc 853
0ba1ff 854 *** COMMENT Semantic refactor
JG 855 Trying to get this to work.
856 Should help to refactor file.
990949 857 #+BEGIN_SRC emacs-lisp
0ba1ff 858   (use-package srefactor
JG 859     :ensure t
860     :bind (("M-RET o" . 'srefactor-lisp-one-line)
861        ("M-RET m" . 'srefactor-lisp-format-sexp)
862        ("M-RET d" . 'srefactor-lisp-format-defun)
863        ("M-RET b" . 'srefactor-lisp-format-buffer)
864        :map c-mode-base-map
865             ("M-RET" . 'srefactor-refactor-at-point)
866             :map c++-mode-map
867             ("M-RET" . 'srefactor-refactor-at-point)))
990949 868 #+END_SRC
8a38cc 869
990949 870 ** Language specific configs
C 871 *** C/C++
0ba1ff 872 **** COMMENT yasnippet
JG 873 Enable yasnippet for C/C++.
990949 874 #+BEGIN_SRC emacs-lisp
C 875 (add-hook 'c++-mode-hook 'yas-minor-mode)
876 (add-hook 'c-mode-hook 'yas-minor-mode)
877 #+END_SRC
8a38cc 878
0ba1ff 879 **** Flycheck clang
JG 880 Add the clang backend for linting.
990949 881 #+BEGIN_SRC emacs-lisp
C 882 (use-package flycheck-clang-analyzer
883   :ensure t
884   :config
885   (with-eval-after-load 'flycheck
886     (require 'flycheck-clang-analyzer)
887      (flycheck-clang-analyzer-setup)))
888 #+END_SRC
8a38cc 889
0ba1ff 890 **** Company
JG 891 Add header completion as well as Irony, which uses clang for suggestions.
990949 892 #+BEGIN_SRC emacs-lisp
C 893   (use-package company-c-headers
894       :ensure t
895       :after company
896       :config
897       (add-hook 'c++-mode-hook 'company-mode)
898       (add-hook 'c-mode-hook 'company-mode))
899
900   (use-package irony
901     :ensure t
902     :init
903     (setq w32-pipe-read-delay 0)
904     (setq irony-server-w32-pipe-buffer-size (* 64 1024))
905     (add-hook 'c++-mode-hook 'irony-mode)
906     (add-hook 'c-mode-hook 'irony-mode)
907     (add-hook 'irony-mode-hook 'irony-cdb-autosetup-compile-options)
908     (add-hook 'irony-mode-hook 'irony-cdb-autosetup-compile-options))
0ba1ff 909
JG 910   (use-package company-irony
911     :ensure t
912     :config
913     (add-to-list 'company-backends '(company-c-headers
914                                      company-dabbrev-code
915                                      company-irony)))
990949 916 #+END_SRC
8a38cc 917
990949 918 *** emacs-lisp
0ba1ff 919 **** COMMENT yasnippet
JG 920 Enable yasnippet.
990949 921 #+BEGIN_SRC emacs-lisp
C 922 (add-hook 'emacs-lisp-mode-hook 'yas-minor-mode)
923 #+END_SRC
8a38cc 924
0ba1ff 925 **** COMMENT company
JG 926 Add slime backend.
990949 927 #+BEGIN_SRC emacs-lisp
C 928 (add-hook 'emacs-lisp-mode-hook 'company-mode)
929
930 (use-package slime
931   :ensure t
932   :config
933   (setq inferior-lisp-program "/usr/bin/sbcl")
934   (setq slime-contribs '(slime-fancy)))
935
936 (use-package slime-company
937   :ensure t
938   :init
939     (require 'company)
940     (slime-setup '(slime-fancy slime-company)))
941 #+END_SRC
8a38cc 942
bf794a 943 *** COMMENT x86
990949 944 **** x86-lookup
0ba1ff 945 Look up reference PDF. Use Intel manual.
990949 946 #+BEGIN_SRC emacs-lisp
C 947 (use-package x86-lookup
948   :ensure t
949   :init
950   (setq x86-lookup-pdf "D:/Coding/x86-instructions.pdf")
951   :bind ("C-h x" . x86-lookup))
952 #+END_SRC
8a38cc 953
990949 954 *** Latex
C 955 **** AucTex
0ba1ff 956 AucTex contains many additions to make tex editing good.
990949 957 #+BEGIN_SRC emacs-lisp
20e001 958   (use-package tex
C 959     :ensure auctex
960     :config
961     (setq TeX-auto-save t)
962     (setq TeX-parse-self t)
963     (setq TeX-view-program-selection '((output-pdf "PDF Tools"))
964           TeX-source-correlate-start-server t)
965     (add-hook 'TeX-after-compilation-finished-functions #'TeX-revert-document-buffer))
990949 966 #+END_SRC
8a38cc 967
990949 968 **** Company
0ba1ff 969 Help company complete tex math and references.
990949 970 #+BEGIN_SRC emacs-lisp
C 971   (use-package company-math
972     :ensure t
973     :after company
974     :config
1005e3 975     (add-to-list 'company-backends '(company-math-symbols-unicode company-math-symbols-latex
0a6cd2 976                                      company-latex-commands))
1005e3 977     (setq company-math-allow-latex-symbols-in-faces t))
990949 978
C 979   (use-package company-reftex
980     :ensure t
981     :after company
982     :config
1005e3 983     (add-to-list 'company-backends 'company-reftex-citations))
990949 984
C 985   (use-package company-auctex
986     :ensure t
987     :after company
988     :config
989     (company-auctex-init))
990
991   (use-package company-bibtex
992     :ensure t
993     :after company
994     (add-to-list 'company-backends 'company-bibtex))
995 #+END_SRC
8a38cc 996
bf794a 997 **** TeXcount
0ba1ff 998 Word counts in latex.
JG 999 Uses a Perl script.
1000 #+BEGIN_SRC emacs-lisp
1001   (defun get-texcount-latest()
1002     (if (not(file-directory-p "~/.texcount"))
1003         (make-directory "~/.texcount"))
1004     (url-copy-file "https://app.uio.no/ifi/texcount/download.php?file=texcount_3_1_1.zip" "~/.texcount/texcount.zip" 1)
1005     (shell-command "unzip -o ~/.texcount/texcount.zip -d ~/.texcount")
1006     (add-to-list 'exec-path "~/.texcount/texcount.pl"))
20e001 1007
0ba1ff 1008   (if (not(file-exists-p "~/.texcount/texcount.pl"))
JG 1009       (get-texcount-latest))
990949 1010
0ba1ff 1011   (defun texcount ()
JG 1012     (interactive)
1013     (let*
1014         ( (this-file (buffer-file-name))
1015           (enc-str (symbol-name buffer-file-coding-system))
1016           (enc-opt
1017            (cond
1018             ((string-match "utf-8" enc-str) "-utf8")
1019             ((string-match "latin" enc-str) "-latin1")
1020             ("-encoding=guess")
1021             ) )
1022           (word-count
1023            (with-output-to-string
1024              (with-current-buffer standard-output
1025                (call-process "texcount" nil t nil "-0" enc-opt this-file)
1026                ) ) ) )
1027       (message word-count)
1028       ) )
1029   (add-hook 'LaTeX-mode-hook (lambda () (define-key LaTeX-mode-map (kbd "C-c c") 'texcount)))
1030   (add-hook 'latex-mode-hook (lambda () (define-key latex-mode-map (kbd "C-c c") 'texcount)))
1031 #+END_SRC
990949 1032
C 1033 *** PlantUML
0ba1ff 1034 Sets the PlantUML path for the mode to generate models.
990949 1035 #+BEGIN_SRC emacs-lisp
bf794a 1036   (use-package plantuml-mode
JG 1037     :ensure t
1038     :init
1039     (cond ((eq system-type 'windows-nt)
1040            (setq plantuml-jar-path "c:/ProgramData/chocolatey/lib/plantuml/tools/plantuml.jar"))
1041           ((eq system-type 'gnu/linux)
4659c3 1042            (setq plantuml-jar-path "/usr/share/java/plantuml/plantuml.jar")))
JG 1043     (setq planuml-default-exec-mode 'jar))
990949 1044 #+END_SRC
C 1045
bf794a 1046 *** COMMENT Racket
990949 1047 **** Major mode
0ba1ff 1048 Set racket path in windows and enable racket mode.
990949 1049 #+BEGIN_SRC emacs-lisp
C 1050   (when (eq system-type 'windows-nt)
1051     (add-to-list 'exec-path "c:/Program Files/Racket")
1052     (setenv "PATH" (mapconcat #'identity exec-path path-separator)))
1053
1054   (use-package racket-mode
1055       :ensure t
1056       :config
1057       (autoload 'racket-mode "Racket" "Racket Editing Mode" t)
1058       (add-to-list
1059        'auto-mode-alist
8a38cc 1060        '("\\.rkt$" . racket-mode))
990949 1061       (setq matlab-indent-function t))
C 1062 #+END_SRC
1063
0ba1ff 1064 *** COMMENT Verilog
baf326 1065 **** Get latest version
0ba1ff 1066 Pull the latest version from the web.
baf326 1067 #+BEGIN_SRC emacs-lisp
C 1068   (defun get-verilog-latest()
0864ff 1069     (if (not(file-directory-p "~/.emacs.d/elpa/verilog-mode"))
C 1070         (make-directory "~/.emacs.d/elpa/verilog-mode"))
1071     (if (file-exists-p "~/.emacs.d/elpa/verilog-mode/verilog-mode.el")
1072         (delete-file "~/.emacs.d/elpa/verilog-mode/verilog-mode.el"))
dc8eb0 1073     (url-copy-file "https://www.veripool.org/ftp/verilog-mode.el" "~/.emacs.d/elpa/verilog-mode/verilog-mode.el" 1))
baf326 1074 #+END_SRC
C 1075
1076 **** Integrate into emacs
0ba1ff 1077 Add updated version (based off auto-package-update) and integrate it with Emacs.
990949 1078 #+BEGIN_SRC emacs-lisp
0864ff 1079     (defun verilog-read-file-as-string (file)
C 1080       "Read FILE contents."
1081       (when (file-exists-p file)
1082         (with-temp-buffer
1083           (insert-file-contents file)
1084           (buffer-string))))
1085
1086     (defun verilog-write-string-to-file (file string)
1087       "Substitute FILE contents with STRING."
1088       (with-temp-buffer
1089         (insert string)
1090         (when (file-writable-p file)
1091           (write-region (point-min)
1092                         (point-max)
1093                         file))))
1094
1095     (defun verilog-today-day ()
1096       (time-to-days (current-time)))
1097
1098     (defun should-update-verilog-p ()
1099       "Return non-nil when an update is due."
1100       (and
1101        (or
1102         (not (file-exists-p "~/.emacs.d/.last-verilog-update-day"))
1103         (if (>= (/ (- (verilog-today-day) (verilog-read-last-update-day)) 7) 1)
1104             t
1105           nil))))
1106
1107     (defun verilog-read-last-update-day ()
1108       "Read last update day."
1109       (string-to-number
1110        (verilog-read-file-as-string "~/.emacs.d/.last-verilog-update-day")))
1111
1112     (defun verilog-write-current-day ()
1113       "Store current day."
1114       (verilog-write-string-to-file
1115        "~/.emacs.d/.last-verilog-update-day"
1116        (int-to-string (verilog-today-day))))
1117
1118     (use-package verilog-mode
1119       :init
1120       (when (should-update-verilog-p)
1121           (get-verilog-latest)
1122           (verilog-write-current-day))
1123       (add-to-list 'load-path "~/.emacs.d/elpa/verilog-mode/verilog-mode.el")
1124       :config
1125       (autoload 'verilog-mode "verilog-mode" "Verilog mode" t )
1126       (add-to-list 'auto-mode-alist '("\\.[ds]?vh?\\'" . verilog-mode)))
990949 1127 #+END_SRC
8a38cc 1128
0ba1ff 1129 *** COMMENT MATLAB
49aa9f 1130 Mode for editing MATLAB m-files.
JG 1131 #+BEGIN_SRC emacs-lisp
0ba1ff 1132   (use-package matlab
JG 1133     :ensure matlab-mode
1134     :config
1135     (autoload 'matlab-mode "matlab" "Matlab Editing Mode" t)
1136     (add-to-list
1137      'auto-mode-alist
1138      '("\\.m$" . matlab-mode))
1139     (setq matlab-indent-function t)
1140     (setq matlab-shell-command "matlab")
1141     (matlab-cedet-setup))
49aa9f 1142 #+END_SRC
JG 1143
0ba1ff 1144 *** COMMENT MIPS
JG 1145 For editing MIPS assembly.
49aa9f 1146 #+BEGIN_SRC emacs-lisp
JG 1147   (use-package mips-mode
1148     :ensure t
1149     :mode "\\.mips$")
1150 #+END_SRC
1151
0ba1ff 1152 *** COMMENT IPython notebooks
60454d 1153 Allow emacs to view and use IPython notebooks
JG 1154 #+BEGIN_SRC emacs-lisp
1155   (use-package ein
1156     :ensure t)
1157 #+END_SRC
1158
990949 1159 * Org mode
C 1160 ** Up to date org
0ba1ff 1161 Pull the latest org mode from the repository, rather than the org which comes with emacs.
990949 1162 #+BEGIN_SRC emacs-lisp
C 1163     (use-package org
0ba1ff 1164       :ensure org-plus-contrib
990949 1165       :pin org)
C 1166 #+END_SRC
8a38cc 1167
990949 1168 ** Small tweaks
0ba1ff 1169 Small quality of life changes to org-mode.
990949 1170 #+BEGIN_SRC emacs-lisp
C 1171 (setq org-src-fontify-natively t)
1172 (setq org-src-tab-acts-natively t)
1173 (setq org-confirm-babel-evaluate nil)
1174 (setq org-export-with-smart-quotes t)
1175 (setq org-src-window-setup 'current-window)
1176 (add-hook 'org-mode-hook 'org-indent-mode)
1177 (diminish 'org-indent-mode)
1178 (diminish 'visual-line-mode)
1179 #+END_SRC
a428a2 1180 *** Spell checking for code and latex
JG 1181 #+BEGIN_SRC emacs-lisp
1182   (add-to-list 'ispell-skip-region-alist '("#\\+BEGIN_SRC" . "#\\+END_SRC"))
1183   (add-to-list 'ispell-skip-region-alist '("\\$" . "\\$"))
1184   (add-to-list 'ispell-skip-region-alist '("\\$\\$" . "\\$\\$"))
1185 #+END_SRC
8a38cc 1186
990949 1187 ** Line wrapping
0ba1ff 1188 Enable line wrapping for long lines.
990949 1189 #+BEGIN_SRC emacs-lisp
C 1190   (add-hook 'org-mode-hook
bf794a 1191             '(lambda ()
JG 1192                (visual-line-mode 1)))
990949 1193 #+END_SRC
8a38cc 1194
990949 1195 ** org-bullets
0ba1ff 1196 Use bullets of different colours and styles instead of the "\*\*\*" to denote indentation levels.
990949 1197 #+BEGIN_SRC emacs-lisp
bf794a 1198   (use-package org-bullets
JG 1199     :ensure t
1200     :config
990949 1201     (add-hook 'org-mode-hook (lambda () (org-bullets-mode))))
C 1202 #+END_SRC
8a38cc 1203
990949 1204 ** Org Babel
0ba1ff 1205 Allows the execution of code from within an org buffer.
JG 1206 Code output can also be input to the buffer.
990949 1207 *** Languages
0ba1ff 1208 Add a bunch of languages to org babel supported languages
990949 1209 #+BEGIN_SRC emacs-lisp
baf326 1210     (org-babel-do-load-languages 'org-babel-load-languages '((emacs-lisp . t)
C 1211                                                              (C . t)
1212                                                              (python . t)
1213                                                              (latex . t)
1214                                                              (scheme . t)
1215                                                              (gnuplot . t)
1216                                                              (matlab . t)
1217                                                              (plantuml . t)
1218                                                              (fortran . t)
1219                                                              (java . t)
1220                                                              (plantuml . t)))
1221 #+END_SRC
1222
0ba1ff 1223 **** PlantUML path
JG 1224 Org uses its own path for some reason.
baf326 1225 #+BEGIN_SRC emacs-lisp
C 1226   (setq org-plantuml-jar-path plantuml-jar-path)
990949 1227 #+END_SRC
8a38cc 1228
5a75e4 1229 *** Async export
JG 1230 Allow the editing of files while execution of blocks is occurring.
1231 Needs :async tag in src header.
1232 #+BEGIN_SRC emacs-lisp
1233   (use-package ob-async
1234     :ensure t)
1235 #+END_SRC
1236
990949 1237 ** Latex preview fragments match colour
C 1238 Make the previews match theme colour of Emacs.
0ba1ff 1239 Gets very annoying very quickly without it.
990949 1240 #+BEGIN_SRC emacs-lisp
C 1241   (let ((dvipng--plist (alist-get 'dvipng org-preview-latex-process-alist)))
1242     (plist-put dvipng--plist :use-xcolor t)
1243     (plist-put dvipng--plist :image-converter '("dvipng -D %D -T tight -o %O %f")))
1244 #+END_SRC
bf794a 1245
0ba1ff 1246 ** Org export additions
JG 1247 *** Pandoc
1248 Call pandoc on org buffer from org export.
1249 #+BEGIN_SRC emacs-lisp
1250   (use-package ox-pandoc
1251     :ensure t)
1252 #+END_SRC
1253
1254 *** COMMENT Dokuwiki Wiki
1255 Allow export to dokuwiki markup from org.
1256 #+BEGIN_SRC emacs-lisp
1257   (use-package ox-wk
1258     :ensure t)
1259 #+END_SRC
1260
1261 * COMMENT EMMS
be9cff 1262 Emacs media manager.
0ba1ff 1263 I come back to it every now and again as an MPD front-end, but haven't quite gotten the hang of it.
be9cff 1264 #+BEGIN_SRC emacs-lisp
JG 1265   (use-package emms-setup
1266     :ensure emms
1267     :init
1268     (add-to-list 'load-path "~/elisp/emms/")
1269     :config
1270     (emms-all)
1271     (emms-default-players)
1272     (setq emms-source-file-directory "~/Music/"))
1273 #+END_SRC
1274
a428a2 1275 * COMMENT Org Blog
0ba1ff 1276 I use org to write my blog and use org-static-blog to generate the HTML.
be9cff 1277 ** Org static blog config
0ba1ff 1278 Basic configuration for site.
JG 1279 Copied and modified from the example configuration.
be9cff 1280 #+BEGIN_SRC emacs-lisp
1005e3 1281   (use-package org-static-blog
JG 1282     :ensure t
1283     :config
1284     (setq org-static-blog-publish-title "Joel's Site")
1285     (setq org-static-blog-publish-url "https://blog.joelg.cf/")
1286     (setq org-static-blog-publish-directory "/backup/home/joel/Downloads/Chizi123.github.io/")
1287     (setq org-static-blog-posts-directory "/backup/home/joel/Downloads/Chizi123.github.io/posts/")
1288     (setq org-static-blog-drafts-directory "/backup/home/joel/Downloads/Chizi123.github.io/drafts/")
1289     (setq org-static-blog-enable-tags t)
1290     (setq org-export-with-toc nil)
1291     (setq org-export-with-section-numbers nil)
be9cff 1292
1005e3 1293     ;; This header is inserted into the <head> section of every page:
JG 1294     ;;   (you will need to create the style sheet at
1295     ;;    ~/projects/blog/static/style.css
1296     ;;    and the favicon at
1297     ;;    ~/projects/blog/static/favicon.ico)
1298     (setq org-static-blog-page-header
1299           "<meta name=\"author\" content=\"Joel Grunbaum\">
0ba1ff 1300       <meta name=\"referrer\" content=\"no-referrer\">
JG 1301       <link href= \"static/style.css\" rel=\"stylesheet\" type=\"text/css\" />
1302       <link rel=\"icon\" href=\"static/favicon.png\">
1303       <script async src=\"https://www.googletagmanager.com/gtag/js?id=UA-147303155-2\"></script>
1304       <script>
1305         window.dataLayer = window.dataLayer || [];
1306         function gtag(){dataLayer.push(arguments);}
1307         gtag('js', new Date());
1308         gtag('config', 'UA-147303155-2');
1309       </script>
1310       ")
be9cff 1311
1005e3 1312     ;; This preamble is inserted at the beginning of the <body> of every page:
JG 1313     ;;   This particular HTML creates a <div> with a simple linked headline
1314     (setq org-static-blog-page-preamble
1315           "<div class=\"header\">
0ba1ff 1316         <a href=\"https://blog.joelg.cf\">Joel's Site - Personal site and constant work in progress</a>
JG 1317         <div class=\"sitelinks\">
1318           <a href=\"https://blog.joelg.cf/about-me.html\">About Me</a> |
1319           <a href=\"https://github.com/Chizi123\">Github</a> |
1320           <a href=\"https://facebook.com/joel.grun.5\">Facebook</a>
1321         </div>
1322       </div>")
1323
1005e3 1324     ;; This postamble is inserted at the end of the <body> of every page:
JG 1325     ;;   This particular HTML creates a <div> with a link to the archive page
1326     ;;   and a licensing stub.
1327     (setq org-static-blog-page-postamble
1328           "<div id=\"archive\">
0ba1ff 1329         <a href=\"https://blog.joelg.cf/archive.html\">Other posts</a>
be9cff 1330       </div>
0ba1ff 1331       <br>
1005e3 1332       <center><button id=\"disqus_button\" onclick=\"load_disqus()\">Load Disqus Comments</button></center>
JG 1333     <div id=\"disqus_thread\"></div>
1334     <script type=\"text/javascript\">
1335       function load_disqus() {
1336           var dsq = document.createElement('script');
1337           dsq.type = 'text/javascript';
1338           dsq.async = true;
1339           dsq.src = 'https://joelg-cf.disqus.com/embed.js';
1340           (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
1341           document.getElementById('disqus_button').style.visibility = 'hidden';
1342       };
1343     </script>"))
be9cff 1344 #+END_SRC
JG 1345
0ba1ff 1346 ** Sitemap addition
JG 1347 Creates a sitemap.xml for the blog based on the generated HTML files output in the final directory.
1348 #+BEGIN_SRC emacs-lisp
1349   (defun blog-publish()
1350     (interactive)
1351     (org-static-blog-publish)
1352     (setq n 0)
1353     (setq site "https://blog.joelg.cf/")
1354     (setq posts (directory-files org-static-blog-publish-directory))
1355     (generate-new-buffer "sitemap.xml.gen")
1356     (with-current-buffer "sitemap.xml.gen" (insert "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n"))
1357     (while (< n (length (directory-files org-static-blog-publish-directory)))
1358       (setq curr (nth n posts))
1359       (if (string-match "\\(html\\)" curr)
1360           (if (string-match "index.html" curr)
1361               (with-current-buffer "sitemap.xml.gen" (insert (concat "\t<url>\n\t\t<loc>" site "</loc>\n\t</url>\n")))
1362             (with-current-buffer "sitemap.xml.gen" (insert (concat "\t<url>\n\t\t<loc>" site curr "</loc>\n\t</url>\n")))))
1363       (setq n (1+ n)))
1364     (with-current-buffer "sitemap.xml.gen" (insert "</urlset>"))
1365     (with-current-buffer "sitemap.xml.gen" (write-region (point-min) (point-max) (concat org-static-blog-publish-directory "sitemap.xml")) t)
1366     (kill-buffer "sitemap.xml.gen"))
1367 #+END_SRC
1368
be9cff 1369 ** Emacs-htmlize
0ba1ff 1370 Allow org features to be exported to HTML for site.
be9cff 1371 #+BEGIN_SRC emacs-lisp
JG 1372   (use-package htmlize
1373     :ensure t)
1374 #+END_SRC
0ba1ff 1375
a428a2 1376 * Journaling
JG 1377 ** Noteworthy entries
1378 I write weekly journal entries recapping my week.
1379 These files are in org mode.
1380 This is inspired by org-static-blog.
1381 #+BEGIN_SRC emacs-lisp
1382   (defun journal-create-new-post ()
1383       "Create a new entry, prompt for title and insert header"
1384     (interactive)
1385     (let ((title (read-string "Title: ")))
1386       (find-file (concat "~/Documents/Journal/entry/"
1387                          (read-string "Filename: "
1388                                       (concat (format-time-string "%Y-%m-%d-" (current-time))
1389                                               (replace-regexp-in-string "\s" "-" (downcase title))
1390                                               ".org"))))
1391       (insert "#+title: " title "\n"
1392               "#+date: " (format-time-string "<%Y-%m-%d %H:%M>") "\n"
1393               "#+filetags: ")))
1394 #+END_SRC
1395 *** Publish entries
1396 Use org-publish to collate entries into a single unit.
1397 #+BEGIN_SRC emacs-lisp
1398   (setq org-publish-project-alist
1399                '(("Journal"
1400                  :base-directory "~/Documents/Journal/entry/"
1401                  :publishing-directory "~/Documents/Journal/out/"
1402                  :publishing-function org-html-publish-to-html
0a6cd2 1403                  ;;:htmlized-source t
a428a2 1404                  :section-numbers nil
JG 1405                  :html-preamble t
0a6cd2 1406                  :html-validation-link nil
JG 1407
a428a2 1408                  :auto-sitemap t
0a6cd2 1409                  :sitemap-sort-files anti-chronologically
JG 1410                  :sitemap-file-entry-format "%d - %t"
1411                  :sitemap-title "Home"
1412                  :sitemap-filename "index.html"
1413                  :sitemap-function org-publish-sitemap)))
5a75e4 1414 #+END_SRC