#+title: Emacs setup for use with LaTeX, Org, and Python #+author: Gerard Vermeulen #+latex_class: article-local #+latex_class_options: [11pt,a4paper,english,svgnames] #+macro: kbd (eval (by-backend-kbd-org-macro $1)) #+options: ^:{} #+property: header-args:emacs-lisp :exports code :results silent :tangle init.el #+property: header-args:org :tangle include.org #+startup: showeverything #+include: "include.org" * Quick start :PROPERTIES: :CUSTOM_ID: sec:quick-start :END: Backup your =user-emacs-directory= (defaults often to =~/.emacs.d= on =Linux=, =Unix=, or =Darwin=) directory and execute the commands in listing [[lst:prepare-user-emacs-directory]]. After invoking Emacs interactively (in interactive mode, neither in batch mode, nor in server mode), Emacs will ask you to install a selected set of packages. Quit Emacs and invoke Emacs again. #+caption[Prepare the user-emacs-directory]: #+caption: Clone and initialize the user-emacs-directory. #+name: lst:prepare-user-emacs-directory #+begin_src shell :noeval :tangle no cd ~ git clone ccdr@mercury.grenoble.cnrs.fr:SERVER/emacs.d.git .emacs.d make --directory=.emacs.d init emacs & #+end_src * Introduction :PROPERTIES: :CUSTOM_ID: sec:introduction :END: This Emacs setup aims to install automatically a minimal set of extension packages that allows to handle my reports and presentations. The file format of the reports is [[https://orgmode.org/][Org Mode]] plain text with [[https://www.python.org/][Python]] source code blocks and the file format of the presentations is [[https://www.latex-project.org/][LaTeX]]. This [[info:org#Top][org]] file (more precisely the original [[info:org#Top][org]] source file of this file) illustrates three methods in my work-flow: 1. How to tangle (or export) source blocks from [[info:org#Top][org]] files. This file contains source blocks to produce the files =early-init.el=, =init.el=, =latexmkrc=, =org-store-link=, and =example.py= by tangling. 2. How to export [[info:org#Top][org]] files to other formats such as [[https://en.wikipedia.org/wiki/HTML][HTML]], [[https://www.latex-project.org/][LaTeX]], and [[https://en.wikipedia.org/wiki/PDF][PDF]]. 3. How [[info:org#Hyperlinks][org hyperlinks (info)]] allow to link inside and outside [[info:org#Top][Org Mode]]: hover over or click on the links to experiment. The [[https://en.wikipedia.org/wiki/AUCTeX][AUCTeX - Aalborg University Center TeX]] extension package provides a powerful [[https://en.wikipedia.org/wiki/Text-based_user_interface][Text-based User Interface (TUI)]] environment to edit the [[https://www.latex-project.org/][LaTeX]] presentations. The [[https://github.com/bdarcus/citar][citar]] extension package provides quick filtering and selecting of bibliographic entries, and the option to run different commands on those selections. [[https://github.com/bdarcus/citar][Citar]] requires [[info:org#Top][Org-9.5 (info)]], which is already part of Emacs-28.1. [[https://github.com/bdarcus/citar][Citar]] exploits the enhancements of Emacs' builtin selection mechanism provided by the extension packages [[https://github.com/minad/vertico][vertico]], [[https://github.com/oantolin/orderless][orderless]], [[https://github.com/oantolin/embark][embark]], [[https://github.com/minad/marginalia][marginalia]], and [[https://github.com/minad/consult][consult]]. The [[https://github.com/andras-simonyi/citeproc-el][citeproc]] extension package provides [[https://citationstyles.org/][CSL: citation style language]] processing capabilities to [[https://github.com/bdarcus/citar][citar]] and [[https://orgmode.org/][Org Mode]]. [[https://github.com/citation-style-language/styles#readme][Citation style language: style repository]] links to a curated repository of CSL styles. The [[https://github.com/vedang/pdf-tools][pdf-tools]] extension package renders [[https://en.wikipedia.org/wiki/PDF][PDF]] file with the possibility to annotate the file or to click on anchors in the [[https://en.wikipedia.org/wiki/PDF][PDF]] file that link back to the original [[https://www.latex-project.org/][LaTeX]] file of the document. An example of my work-flow are the steps to convert this [[info:org#Top][org]] file to [[https://en.wikipedia.org/wiki/PDF][PDF]] and to see the result with [[https://github.com/vedang/pdf-tools][pdf-tools]] in Emacs: execute the commands ~pdf-tools-install~, ~org-babel-tangle~, ~org-latex-export-latex-to-latex~, and ~compile~. This sets up an infinite [[https://www.latex-project.org/][LaTeX]] compilation loop to update and redisplay the [[https://en.wikipedia.org/wiki/PDF][PDF]] file after excution of the ~org-latex-export-latex-to-latex~ command in this buffer. Here follows a list of interesting Emacs configurations: 1. [[https://github.com/alhassy/emacs.d][Musa Al-hassy's configuration]] is an impressive example of producing the Emacs initialization files and other files by tangling an [[info:org#Top][org]] file. His methodology is impressive, as his [[https://alhassy.github.io/ElispCheatSheet/][Elisp Cheat Sheet]] and [[https://alhassy.github.io/org-special-block-extras/][org-special-block-extra package]] show. To me, this is a configuration to admire, but his methodology is way over my head. 2. [[https://github.com/oantolin/emacs-config][Omar Antolin Camarena's configuration]] exploits built-in packages, Omar's own small packages, and large external packages. Omar is the author of [[https://github.com/oantolin/orderless][orderless]] and [[https://github.com/oantolin/embark][embark]]. I have stolen his idea of using ~custom-set-variables~ instead of the customize interface although that is [[https://www.masteringemacs.org/article/bad-emacs-advice][bad Emacs advice]] for new users. 3. [[https://gitlab.com/ambrevar/dotfiles][Pierre Neirhardt's configuration]] implements lazy loading without help of external packages. I have stolen his approach of using lazy loading to silently ignore the setup stanzas of uninstalled extension packages. 4. [[https://sachachua.com/dotemacs/][Sacha Chua's configuration]] is a practical example of producing the Emacs initialization files by tangling an [[info:org#Top][org]] file. It gives me the impression that she is a very practical person trying to achieve her goals by the most efficient means. 5. [[https://github.com/purcell/emacs.d][Steve Purcell's configuration]] is well organized, a showcase of readable code, as well helpful commit and issue histories. See for instance the discussion on [[https://github.com/purcell/emacs.d/issues/778][the correctness of order of company candidates in Emacs lisp mode]]. Here follows a list of links on how to use Emacs and Elisp: 1. [[https://www.youtube.com/watch?v=lkIicfzPBys][A guided tour of Emacs]] is a link to a video tour pointing how [[info:emacs#Buffers][buffers (info)]], [[info:emacs#Dired][dired (info)]], [[info:emacs#Help][documentation (info)]], [[info:elisp#Top][elisp (info)]], [[info:elisp#Debugging][elisp debugging (info)]], [[info:eshell#Top][eshell (info)]], and [[info:emacs#Keyboard Macros][keyboard macros (info)]] turn Emacs in an powerful coding and editing environment. 2. [[https://www.youtube.com/watch?v=6ZWp05OW1c0][Emergency Emacs]] is a link to a video on fundamental editing features and principles with focus on [[info:ediff#Top][ediff (info)]], [[info:emacs#Undo][undo (info)]], [[info:emacs#Moving Point][moving point (info)]], [[info:emacs#Erasing][erasing (info)]], and [[info:emacs#Dynamic Abbrevs][dynamic abbreviations (info)]]. 2. [[https://endlessparentheses.com/][Endless Parentheses]] is a blog with many mindblowing code snippets. 3. [[https://www.murilopereira.com/how-to-open-a-file-in-emacs/][How to open a file in Emacs]] looks into [[info:elisp#Top][elisp (info)]] and [[info:elisp#Debugging][elisp debugging (info)]] and then compares Emacs, [[https://www.vim.org/][Vim]], [[https://neovim.io/][Neovim]], and [[https://code.visualstudio.com/][Visual Studio Code]] with respect to values and technology. 4. [[https://protesilaos.com/codelog/2022-01-31-learning-emacs/][Learning Emacs and Elisp]] is a link to a video tutorial with a transcript on the best approach to learn Emacs and Elisp. 5. [[https://www.masteringemacs.org/][Mastering Emacs]] is a link to a blog with many interesting posts that promotes a book on how to become a proficient Emacs user. * [[info:emacs#Early Init File][Early Init File (info)]] :PROPERTIES: :CUSTOM_ID: sec:early-init-file :END: Try to load [[https://github.com/emacscollective/no-littering][no-littering]] as early as possible, since it helps to keep =~/.emacs.d= clean. #+caption[Tangle the early-init-file]: #+caption: Tangle the early-init-file. #+name: lst:tangle-early-init-file #+begin_src emacs-lisp :tangle early-init.el ;;; early-init.el --- user early-init file -*- lexical-binding: t -*- ;;; Commentary: ;;; Code: (setq load-prefer-newer t) (require 'no-littering nil 'noerror) (provide 'early-init) ;; Emacs looks for "Local variables:" after the last "?\n?\f". ;; Local Variables: ;; indent-tabs-mode: nil ;; End: ;;; earl-init.el ends here #+end_src In order to get help in understanding the code block above in a buffer showing the original [[info:org#Top][Org]] source file, type {{{kbd(C-c C-c)}}} after moving point (or cursor) to one of the items of the list: 1. src_emacs-lisp{(describe-variable #'load-prefer-newer t)} 2. src_emacs-lisp{(apropos-library "no-littering")} 3. src_emacs-lisp{(find-function #'hack-local-variables)} to execute the code between the curly braces for access to help. This shows that *Emacs is a self-documenting editor.* * [[info:emacs#Init File][Init File (info)]] header :PROPERTIES: :CUSTOM_ID: sec:init-file-header :END: The =user-init-file= header requires =cl-lib= and customizes Emacs variables. It consists of four parts in listing [[lst:1st-custom-set-variables-call]], [[lst:2nd-custom-set-variables-call]], [[lst:3rd-custom-set-variables-call]], and [[lst:4th-custom-set-variables-call]] in order to limit the length of the listings for exporting to LaTeX. The [[info:elisp#Quoting][quoting (info)]] and the [[info:elisp#Backquote][backquote (info)]] pages explain how to understand the ~'~ (quote), ~`~ (backquote), ~,~ (substitute) and ~@,~ (splice) in the ~custom-set-variables~ function calls in listing [[lst:1st-custom-set-variables-call]], [[lst:2nd-custom-set-variables-call]], [[lst:3rd-custom-set-variables-call]], and [[lst:4th-custom-set-variables-call]]. A tutorial of how to use those reader macros is the [[https://mullikine.github.io/posts/macro-tutorial/][didactic emacs-lisp macro example]]. The [[info:emacs#Init File][init file (info)]] does not load the ~custom-file~ as [[info:emacs#Saving Customizations][saving customizations (info)]] recommends because of the ~custom-set-variables~ function calls. #+caption[Customize the first set of Emacs variables]: #+caption: Customize the first set of Emacs variables. #+name: lst:1st-custom-set-variables-call #+begin_src emacs-lisp ;;; init.el --- user init file -*- lexical-binding: t -*- ;;; Commentary: ;;; Code: (require 'cl-lib) (custom-set-variables '(after-save-hook #'executable-make-buffer-file-executable-if-script-p) '(column-number-mode t) '(cursor-type 'box) `(custom-file ,(locate-user-emacs-file "custom.el")) '(epg-pinentry-mode 'loopback) '(global-hl-line-mode t) '(global-hl-line-sticky-flag t) '(history-delete-duplicates t) '(history-length 500) '(indent-tabs-mode nil) '(inhibit-startup-buffer-menu t) '(inhibit-startup-screen t) '(initial-buffer-choice t) '(initial-scratch-message "") `(insert-directory-program ,(or (executable-find "gls") (executable-find "ls"))) '(kill-ring-max 300)) #+end_src #+caption[Customize the second set of Emacs variables]: #+caption: Customize the second set of Emacs variables. #+name: lst:2nd-custom-set-variables-call #+begin_src emacs-lisp (custom-set-variables '(package-archives '(("gnu" . "https://elpa.gnu.org/packages/") ("gnu-devel" . "https://elpa.gnu.org/devel/") ("melpa" . "https://melpa.org/packages/") ("nongnu" . "https://elpa.nongnu.org/nongnu/"))) ;; Pin packages to GNU ELPA for info or stability. '(package-pinned-packages '((auctex . "gnu") (compat . "gnu") (consult . "gnu") (engrave-faces . "gnu") (marginalia . "gnu") (org . "gnu-devel") (python . "gnu-devel") (queue . "gnu") (rainbow-mode . "gnu") (spinner . "gnu") (xr . "gnu") (vertico . "gnu")))) #+end_src #+caption[Customize the third set of Emacs variables]: #+caption: Customize the third set of Emacs variables. #+name: lst:3rd-custom-set-variables-call #+begin_src emacs-lisp (custom-set-variables '(package-selected-packages '(async ; asynchroneous processing auctex ; Aalborg University Center TeX company ; complete anything magit ; Git Text-based User Interface no-littering ; keep `user-emacs-directory' clean orderless ; Emacs completion style org ; thought organizer python ; major mode to edit Python files vertico ; VERTical Interactive Completion wgrep ; open a writable grep buffer xr))) ; undo rx to grok regular expressions #+end_src #+caption[Customize the fourth set of Emacs variables]: #+caption: Customize the fourth set of Emacs variables. #+name: lst:4th-custom-set-variables-call #+begin_src emacs-lisp (custom-set-variables '(recentf-mode t) '(save-place-mode t) '(scroll-bar-mode nil) '(tab-always-indent 'complete) '(tab-width 8) '(tool-bar-mode nil) '(url-cookie-trusted-urls nil) '(url-cookie-untrusted-urls '(".*")) '(use-dialog-box nil) '(view-read-only t)) (when (version< "28.0" emacs-version) (custom-set-variables '(mode-line-compact 'long) '(next-error-message-highlight t) '(use-short-answers t))) (when (eq system-type 'darwin) (custom-set-variables '(ns-alternate-modifier nil) '(ns-command-modifier 'meta) '(ns-right-command-modifier 'super))) (when (eq window-system 'ns) (add-to-list 'initial-frame-alist '(height . 51)) (add-to-list 'initial-frame-alist '(width . 180))) #+end_src * [[info:emacs#Package Installation][Install the selected packages (info)]] :PROPERTIES: :CUSTOM_ID: sec:install-selected-packages :END: [[info:emacs#Package Installation][Emacs installs packages]] from archives on the internet. This setup uses three archives: 1. The [[https://elpa.gnu.org/][GNU Emacs Lisp Package Archive]] 2. The [[https://elpa.nongnu.org/][NonGNU Emacs Lisp Package Archive]]. 3. The [[https://melpa.org/#/][Milkypostman's Emacs Lisp Package Archive (MELPA)]]. The code in listing [[lst:install-selected-packages]] assumes that the package system is in a *virgin* state if the package [[https://github.com/emacscollective/no-littering][no-littering]] is not present: 1. It installs and loads [[https://github.com/emacscollective/no-littering][no-littering]] after ensuring refreshing of the contents of available packages. 2. It installs [[https://elpa.gnu.org/devel/org.html][Org (GNU-devel ELPA archive)]] early to shadow the built-in package while preventing collisions between the snapshot and built-in packages. 3. It calls src_emacs-lisp{(package-install-selected-packages)} to check the installation status of all packages in src_emacs-lisp{package-selected-packages} and to install the missing packages after the user has agreed to its prompt. 4. It defines a function to ensure the installation of packages in other source blocks. This allows skipping installation in sections with a =:noexport:= tag by disallowing tangling. In case of normal Emacs usage, src_emacs-lisp{(package-list-packages)} refreshes the contents of packages and allows to update packages to the latest version. #+caption[Install the selected packages]: #+caption: Install the selected packages. #+name: lst:install-selected-packages #+begin_src emacs-lisp (unless noninteractive (unless (require 'no-littering nil 'noerror) (unless (bound-and-true-p package-archive-contents) (package-refresh-contents)) ;; Install and require `no-littering'. (package-install 'no-littering) (require 'no-littering) ;; https://emacs.stackexchange.com/a/45939 answers ;; "How to shadow automatically a built-in package by installing it?" (defun shadow-builtin-by-install (pkg) (when-let ((desc (cadr (assq pkg package-archive-contents)))) (package-install desc 'dont-select))) ;; Shadow built-in `org' by installing `org'. (shadow-builtin-by-install 'org) ;; Shadow built-in `python' by installing `python'. (shadow-builtin-by-install 'python) ;; Install the selected packages. (package-install-selected-packages))) (defun ensure-package-selection (package) "Ensure selection of PACKAGE." (when (and (package-installed-p package) (bound-and-true-p package-selected-packages)) (cl-pushnew package package-selected-packages))) (defun ensure-package-installation (&rest packages) "Ensure installation of all packages in PACKAGES." (let ((ok t)) (dolist (package packages) (unless (package-installed-p package) (package-install package)) (unless (ensure-package-selection package) (setq ok nil))) ok)) #+end_src * [[info:emacs#Faces][Text faces or styles (info)]] :PROPERTIES: :CUSTOM_ID: sec:text-faces-or-styles :END: This setup does not configure [[info:emacs#Custom Themes][custom themes (info)]] in order to prevent endless useless tweaking. See the [[https://protesilaos.com/codelog/2020-09-05-emacs-note-mixed-font-heights/][note on mixed font heights in Emacs]] for how to setup fonts properly. It boils down to two rules: 1. The height of the default face must be an integer number to make the height a physical quantity. 2. The heights of all other faces must be real numbers to scale those heights with respect to the height of the face (those heights default to 1.0 for no scaling). The code in listing [[lst:configure-face-attributes]] source implements those rules. Listing [[lst:set-default-face-height]] shows that font scaling is easy in case of proper initialization of all face heigths. Listing [[lst:fix-gtk-color-for-invert-default-face]], [[lst:shadow-org-font-lock-faces]], and [[lst:shadow-org-font-lock-faces]] show a few tweaks to improve visibility without theming: 1. Fixing the =gtk= background color of the already loaded =region= face. 2. Toggling between a dark and light background by means of src_emacs-lisp{(invert-default-face)}. 3. Shadowing the definition of faces before loading. The last item in the page on [[https://orgmode.org/worg/org-contrib/babel/examples/fontify-src-code-blocks.html#org5c4406f][fontifying Org mode source code blocks]] describes this method. #+caption[Configure =face-attributes=]: #+caption: Configure =face-attributes=. #+name: lst:configure-face-attributes #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; Set face attributes. (cond ((eq system-type 'darwin) (set-face-attribute 'default nil :family "Hack" :height 120) (set-face-attribute 'fixed-pitch nil :family "Hack") (set-face-attribute 'variable-pitch nil :family "FiraGo")) ((eq system-type 'gnu/linux) (set-face-attribute 'default nil :family "Hack" :height 110) (set-face-attribute 'fixed-pitch nil :family "Hack") (set-face-attribute 'variable-pitch nil :family "FiraGo")) (t (set-face-attribute 'default nil :family "Hack" :height 110) (set-face-attribute 'fixed-pitch nil :family "Hack") (set-face-attribute 'variable-pitch nil :family "DejaVu Sans")))) #+end_src #+caption[Implement =set-default-face-height=]: #+caption: Implement =set-default-face-height=. #+name: lst:set-default-face-height #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun set-default-face-height () "Set the default face height in all current and future frames. Scale all other faces with a height that is a real number." (interactive) (let* ((prompt (format "face heigth (%s): " (face-attribute 'default :height))) (choices (mapcar #'number-to-string (number-sequence 50 200 10))) (height (string-to-number (completing-read prompt choices nil 'require-match)))) (message "Setting the height of the default face to %s" height) (set-face-attribute 'default nil :height height)))) #+end_src #+caption[Use =buffer-face-mode= to set fixed or variable pitch face]: #+caption: Use =buffer-face-mode= to set fixed or variable pitch face. #+name: lst:use-buffer-face-mode-for-fixed-or-variable-pitch-face #+begin_src emacs-lisp ;; Use proportional font faces in current buffer (defun set-buffer-variable-pitch-face () "Set a variable width (proportional) font in current buffer." (interactive) (setq buffer-face-mode-face 'variable-pitch) (buffer-face-mode)) ;; Use monospaced font faces in current buffer (defun set-buffer-fixed-pitch-face () "Set a fixed width (monospace) font in current buffer." (interactive) (setq buffer-face-mode-face 'fixed-pitch) (buffer-face-mode)) (add-hook 'magit-mode-hook #'set-buffer-fixed-pitch-face) (add-hook 'prog-mode-hook #'set-buffer-fixed-pitch-face) #+end_src #+caption[Fix a `gtk' color and implement =invert-default-face=]: #+caption: Fix a `gtk' color and implement =invert-default-face=. #+name: lst:fix-gtk-color-for-invert-default-face #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun fix-gtk-region-face-background-color () (when (featurep 'gtk) (set-face-attribute 'region nil :background (cdr (assoc (face-attribute 'default :background) '(("white" . "LightGoldenrod2") ("black" . "blue3"))))))) (defun invert-default-face () "Invert the default face." (interactive) (invert-face 'default) (fix-gtk-region-face-background-color)) (fix-gtk-region-face-background-color)) #+end_src #+caption[Shadow Org font-lock faces to improve the readability]: #+caption: Shadow Org font-lock faces to improve the readability. #+name: lst:shadow-org-font-lock-faces #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; Shadow two definitions in org-faces.el: (defface org-block ;; https://emacs.stackexchange.com/a/9604 answers: ;; How to override a defined face for light and dark backgrounds? `((((background dark)) :inherit (fixed-pitch) ,@(and (>= emacs-major-version 27) '(:extend t)) :background "#444444") (t :inherit (fixed-pitch) ,@(and (>= emacs-major-version 27) '(:extend t)) :background "#FFFFD0")) "My face used for text inside various blocks. It is always used for source blocks. You can refine what face should be used depending on the source block language by setting, `org-src-block-faces', which takes precedence. When `org-fontify-quote-and-verse-blocks' is not nil, text inside verse and quote blocks are fontified using the `org-verse' and `org-quote' faces, which inherit from `org-block'.") (defface org-table ;; https://emacs.stackexchange.com/a/9604 answers: ;; How to override a defined face for light and dark backgrounds? `((((background dark)) :inherit (fixed-pitch) ,@(and (>= emacs-major-version 27) '(:extend t)) :background "#444444") (t :inherit (fixed-pitch) ,@(and (>= emacs-major-version 27) '(:extend t)) :background "#FFFFD0")) "My face for tables.")) #+end_src #+caption[Shadow Emacs font-lock faces to improve the readability]: #+caption: Shadow Emacs font-lock faces to improve the readability. #+name: lst:shadow-emacs-font-lock-faces #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; Shadow one definition in sh-script.el: (defface sh-heredoc '((((class color) (background dark)) (:foreground "yellow")) (((class color) (background light)) (:foreground "magenta")) (t (:weight bold))) "My face to show a here-document.")) #+end_src * [[info:emacs#Windows][Window management (info)]] :PROPERTIES: :CUSTOM_ID: sec:window-management :END: Mickey Peterson's post [[https://www.masteringemacs.org/article/demystifying-emacs-window-manager][Demystifying Emacs's Window Manager]] invites to improve window placement. Listing [[lst:1st-window-management]], [[lst:2nd-window-management]] and [[lst:3rd-window-management]] implement a selection of his recommendations. #+caption[Window management functions and key bindings]: #+caption: Window management functions and key bindings. #+name: lst:1st-window-management #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; https://www.masteringemacs.org/article/demystifying-emacs-window-manager (defun split-root-below (arg) "Split window below from the root or from the parent with ARG." (interactive "P") (split-window (if arg (window-parent (selected-window)) (frame-root-window)) nil 'below nil)) (defun split-root-right (arg) "Split window right from the root or from the parent with ARG." (interactive "P") (split-window (if arg (window-parent (selected-window)) (frame-root-window)) nil 'right nil)) (defun toggle-window-dedication () "Toggles window dedication in the selected window." (interactive) (set-window-dedicated-p (selected-window) (not (window-dedicated-p (selected-window))))) (defun make-display-buffer-matcher-function (major-modes) "Return a lambda function to match a list of MAJOR-MODES." (lambda (buffer-name action) (with-current-buffer buffer-name (apply #'derived-mode-p major-modes)))) (global-set-key (kbd "M-o") #'other-window)) #+end_src #+caption[Window management modes]: #+caption: Window management modes. #+name: lst:2nd-window-management #+begin_src emacs-lisp (with-eval-after-load 'emacs (winner-mode +1)) #+end_src #+caption[Window management variables]: #+caption: Window management variables. #+name: lst:3rd-window-management #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; https://www.masteringemacs.org/article/demystifying-emacs-window-manager (custom-set-variables '(switch-to-buffer-in-dedicated-window 'pop) '(switch-to-buffer-obey-display-actions t)) (add-to-list 'display-buffer-alist `(,(rx (or "*Apropos*" "*Help*" "*info")) (display-buffer-reuse-window display-buffer-pop-up-window) (inhibit-same-window . nil))) (add-to-list 'display-buffer-alist `(,(rx (or "*Occur*" "*grep*" "*xref*")) display-buffer-reuse-window (inhibit-same-window . nil))) (add-to-list 'display-buffer-alist '("\\*compilation\\*" display-buffer-no-window (allow-no-window . t))) (add-to-list 'display-buffer-alist '("^\\*Dictionary\\*" display-buffer-in-side-window (side . left) (window-width . 70)))) #+end_src president * [[info:elisp#Advising Functions][Advising Functions (info)]] :PROPERTIES: :CUSTOM_ID: sec:advising-function :END: #+caption[Tools for advising functions]: #+caption: Tools for advising functions. #+name: lst:advising-tools #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun toggle-advice (symbol where function &optional props) "Toggle between states after `advice-remove' and `advice-add'." (let ((how "%s `%s' advice `%s' %s `%s'")) (if (advice-member-p function symbol) (progn (message how "Removal of" where function "from" symbol) (advice-remove symbol function)) (message how "Addition of" where function "to" symbol) (advice-add symbol where function props))))) #+end_src * [[info:emacs#Dired][Dired: directory editor as file manager (info)]] :PROPERTIES: :CUSTOM_ID: sec:file-manager :END: [[info:emacs#Dired][Dired (info)]] and the [[https://github.com/ranger/ranger#readme][ranger]] file manager offer similar capabilities for copying, deleting, opening, renaming, and viewing files and directories, but the integration of [[info:emacs#Dired][dired (info)]] in Emacs is obviously much better than the integration of [[https://github.com/ranger/ranger#readme][ranger]] in Emacs. For instance, this setup allows to insert an =org-mode= link to an poorly identified file containing a specific image into an =org-mode= buffer by means of the facilities of [[info:emacs#Dired][dired (info)]] as follows: 1. Type {{{kbd(C-x d)}}} to open the directory containing the pooly identified file with the specific image in a =dired-mode= buffer. 2. Start searching for the specific image by navigating to the name of any image file. 3. Type {{{kbd(v)}}} to switch to view the file in an =image-mode= buffer. 4. In the =image-mode= buffer, continue searching for the specific image by typing: - {{{kbd(n)}}} to view the next image in the =dired-mode= buffer, - {{{kbd(p)}}} to view the previous image in the =dired-mode= buffer, and - {{{kbd(q)}}} to quit the =image-mode= buffer and to go back to the =dired-mode= buffer. 5. After finding the specific image, use {{{kbd(C-c l)}}} in the =image-mode= buffer or the =dired-mode= buffer to store the =org-link=. 6. Switch to the =org-mode= buffer and use {{{kbd(C-c C-l)}}} to insert the =org-link= into the buffer. Listing [[lst:customize-dired]] makes the directory editor sort entries alphabetically after grouping the directories before grouping the files by extension. #+caption[Customize =dired=]: #+caption: Customize =dired=. #+name: lst:customize-dired #+begin_src emacs-lisp (with-eval-after-load 'dired (custom-set-variables '(dired-dwim-target t) ;; | switch | action | ;; |--------+----------------------------------------| ;; | -a | also list hidden entries | ;; | -l | use a long listing format | ;; | -X | sort alphabetically by entry extension | ;; | -G | skip long listing format group names | ;; | -1 | list one entry per line | '(dired-listing-switches "-alGX1 --group-directories-first") '(dired-recursive-copies 'always) '(dired-recursive-deletes 'always))) (with-eval-after-load 'files (custom-set-variables ;; Ensure the use of `GNU-ls' from `coreutils' on darwin. '(insert-directory-program (or (executable-find "gls") (executable-find "ls"))))) (with-eval-after-load 'wdired (custom-set-variables '(wdired-allow-to-change-permissions t))) #+end_src Listing [[lst:extra-dired-key-bindings]] adds new key bindings to =dired-mode-map= to: 1. Open files with the [[https://en.wikipedia.org/wiki/Eww_(web_browser)][Emacs Web Wowser]] inside Emacs. 2. Let [[https://en.wikipedia.org/wiki/Rsync][rsync]] copy marked files outside Emacs to a local or remote directory. The link [[https://truongtx.me/tmtxt-dired-async.html][asynchoronous execution library for Emacs Dired]] is the original source for the idea of using [[https://en.wikipedia.org/wiki/Rsync][rsync]] and the blog articles [[https://oremacs.com/2016/02/24/dired-rsync/][using rsync in dired]] and [[https://vxlabs.com/2018/03/30/asynchronous-rsync-with-emacs-dired-and-tramp/][asynchronous rsync with Emacs, dired and tramp]] are vivid recommendations written by experienced Emacs users. #+caption[Extra =dired= key bindings]: #+caption: Extra =dired= key bindings. #+name: lst:extra-dired-key-bindings #+begin_src emacs-lisp (with-eval-after-load 'dired (defun dired-eww-open-file () "In Dired, open the regular file named on this line with eww" (interactive) (let ((file (dired-get-file-for-visit))) (if (file-regular-p file) (eww-open-file file) (error "Eww rejects `%s', since it is not a regular file" file)))) ;; https://truongtx.me/tmtxt-dired-async.html (defun dired-rsync (target) "Copy marked files with `rsync' to TARGET directory." (interactive (list (expand-file-name (read-file-name "Rsync to:" (dired-dwim-target-directory))))) ;; Store all marked files into the `files' list and intialize ;; the `rsync-command'. (let ((files (dired-get-marked-files nil current-prefix-arg)) (rsync-command "rsync -av --progress ")) ;; Add all marked files as arguments to the `rsync-command'. (dolist (file files) (setq rsync-command (concat rsync-command (if (string-match "^/ssh:\\(.*\\)$" file) (format " -e ssh %s" (match-string 1 file)) (shell-quote-argument file)) " "))) ;; Append the destination directory to the `rsync-command'. (setq rsync-command (concat rsync-command (if (string-match "^/ssh:\\(.*\\)$" target) (format " -e ssh %s" (match-string 1 target)) (shell-quote-argument target)))) ;; Run the async shell command. (async-shell-command rsync-command) ;; Finally, switch to that window. (other-window 1))) (define-key dired-mode-map (kbd "E") #'dired-eww-open-file) (define-key dired-mode-map (kbd "Y") #'dired-rsync)) #+end_src * [[info:elisp#Processes][Processes (info)]] :PROPERTIES: :CUSTOM_ID: sec:processes :END: Listing [[lst:process-utilities]] defines a function to run a (command-line) program with arguments and to obtain a list with its numeric exit status as well as its output to =stdout=. #+caption[Process utilities]: #+caption: Process utilities. #+name: lst:process-utilities #+begin_src emacs-lisp ;; https://gitlab.com/howardabrams/spacemacs.d/blob/master/layers/ha-org/funcs.el#L418 (defun shell-command-with-exit-code (program &rest args) "Run PROGRAM with ARGS and return exit-code and output in a list." (with-temp-buffer (list (apply 'call-process program nil (current-buffer) nil args) (buffer-string)))) #+end_src * [[info:emacs#Help][Help (info)]] :PROPERTIES: :CUSTOM_ID: sec:help :END: Table [[tab:help-key-bindings]] lists a number of key bindings to start playing with the help facilities of Emacs. Try {{{kbd(C-h o)}}} instead of {{{kbd(C-h f)}}} or {{{kbd(C-h v)}}}. #+attr_latex: :booktabs yes :float table #+caption[Help key bindings]: #+caption: Help key bindings. #+name: tab:help-key-bindings |------------------------------+----------+------------------| | command | key map | keys | |------------------------------+----------+------------------| | Info-goto-emacs-command-node | help-map | {{{kbd(C-h F)}}} | | describe-function | help-map | {{{kbd(C-h f)}}} | | describe-key | help-map | {{{kbd(C-h k)}}} | | describe-symbol | help-map | {{{kbd(C-h o)}}} | | describe-variable | help-map | {{{kbd(C-h v)}}} | | info | help-map | {{{kbd(C-h i)}}} | |------------------------------+----------+------------------| ** [[info:emacs#Name Help][Shortdoc-display-group (info)]] :PROPERTIES: :CUSTOM_ID: sec:shortdoc-display-group :END: Listing [[lst:configure-shortdoc]] binds {{{kbd(C-h y)}}} to =short-doc-display-group= and defines a short documentation group for functions defined in this Org file. #+caption[Configure =shortdoc=]: #+caption: Configure =shortdoc=. #+name: lst:configure-shortdoc #+begin_src emacs-lisp (when (fboundp 'shortdoc-display-group) (define-key help-map (kbd "y") #'shortdoc-display-group) (with-eval-after-load 'shortdoc ;; Ensure defining the functions before documenting them. (define-short-documentation-group init "Advice" (toggle-advice :no-manual t) "Face" (invert-default-face :no-manual t) (set-default-face-height :no-manual t) "Interaction" (enable-this-command :no-manual t) (narrow-or-widen-dwim :no-manual t) (org-narrow-to-table :no-manual t) (toggle-ilog-timer-function-after :no-manual) "LaTeX" (TeX-brace-count-line-override :no-manual t) (biber-delete-cache :no-manual t) (toggle-TeX-brace-count-line-override :no-manual t) (update-lualatex-opentype-font-name-database :no-manual t) "Org" (by-backend :no-manual t) (by-backend-kbd-org-macro :no-manual t) (org-active-current-time-stamp :nomanual t) (org-babel-execute:latex-extra-header :no-manual t) (org-babel-execute:latex-header :no-manual t) (org-electric-dollar :no-manual t) (org-eval-emacs-lisp-setup-blocks :no-manual t) (org-eval-python-setup-blocks :no-manual t) (org-eval-infixed-blocks :no-manual t) (org-latex-engraved-source-block-filter :no-manual t) (org-inactive-current-time-stamp :nomanual t) (org-syntax-convert-keyword-case-to-lower :no-manual t) (smart-latex-engrave-org-source-blocks :no-manual t) (toggle-engrave-faces-latex-face-apply-override :no-manual t) (toggle-engrave-faces-latex-face-mapper-override :no-manual t) (toggle-org-babel-python-format-session-value-override :no-manual t) "Python" (choose-common-python-interpreter :no-manual t)))) #+end_src ** [[info:info#Top][Info (info)]] :PROPERTIES: :CUSTOM_ID: sec:info :END: Listing [[lst:configure-info]] adds the required paths to the places where =info= looks for files. #+caption[Configure =info=]: #+caption: Configure =info=. #+name: lst:configure-info #+begin_src emacs-lisp (with-eval-after-load 'info ;; Make Emacs find the "*.info" files in `package-user-dir' on Gentoo Linux. (when (eq system-type 'gnu/linux) (dolist (path (nreverse (mapcar (lambda (name) (expand-file-name (file-name-directory name))) (directory-files-recursively package-user-dir "\\.info\\'")))) (add-to-list 'Info-directory-list path nil #'file-equal-p))) ;; Make Emacs find my "python.info" file. (add-to-list 'Info-directory-list (expand-file-name "~/.local/share/info"))) #+end_src * [[info:emacs#Key Bindings][Key bindings (info)]] :PROPERTIES: :CUSTOM_ID: sec:key-bindings :END: #+attr_latex: :booktabs yes :float table #+caption[Basic key bindings]: #+caption: Basic key bindings. #+name: tab:basic-key-bindings |--------------------+------------+------------------------| | command | key map | keys | |--------------------+------------+------------------------| | undo | global-map | {{{kbd(s-z)}}} | | backward-kill-word | global-map | {{{kbd(C-backspace)}}} | | backward-char | global-map | {{{kbd(C-b)}}} | | forward-char | global-map | {{{kbd(C-f)}}} | | backward-word | global-map | {{{kbd(M-b)}}} | | forward-word | global-map | {{{kbd(M-f)}}} | | backward-sentence | global-map | {{{kbd(M-a)}}} | | forward-sentence | global-map | {{{kbd(M-e)}}} | |--------------------+------------+------------------------| ** [[info:emacs#Disabling][Disabling Commands (info)]] :PROPERTIES: :CUSTOM_ID: sec:enable-disabled-commands :END: Execute src_emacs-lisp{(find-library "novice")} to see how Emacs prevents new users from shooting themselves in the feet. Listing [[lst:configure-disabled-command-function]] enables [[https://www.emacswiki.org/emacs/DisabledCommands][disabled commands on the fly]]. #+caption[Configure the =disabled-command-function=]: #+caption: Configure the =disabled-command-function=. #+name: lst:configure-disabled-command-function #+begin_src emacs-lisp (with-eval-after-load 'emacs (setq disabled-command-function (defun enable-this-command (&rest _args) "Called when a disabled command is executed. Enable it and re-execute it." (put this-command 'disabled nil) (message "You typed %s. %s was disabled until now." (key-description (this-command-keys)) this-command) (sit-for 0) (call-interactively this-command)))) #+end_src ** [[https://github.com/michael-heerdegen/interaction-log.el#readme][Interaction-log]] :PROPERTIES: :CUSTOM_ID: sec:interaction-log :END: #+caption[Configure =interaction-log=]: #+caption: Configure =interaction-log=. #+name: lst:configure-interaction-log #+begin_src emacs-lisp (when (and (ensure-package-installation 'interaction-log) (require 'interaction-log nil 'noerror)) ;; https://www.skybert.net/emacs/show-shortcuts-when-giving-presentations/ (defun ilog-ensure-ilog-buffer-window () "Ensure the visibility of the `ilog' buffer, when it exists." (when (and (get-buffer ilog-buffer-name) (not (get-buffer-window ilog-buffer-name))) (display-buffer (get-buffer ilog-buffer-name)))) (define-key help-map (kbd "C-l") #'interaction-log-mode)) (with-eval-after-load 'emacs (defun toggle-ilog-timer-function-after () "Toggle `ilog-timer-function' advice." (interactive) (toggle-advice 'ilog-timer-function :after #'ilog-ensure-ilog-buffer-window)) (toggle-ilog-timer-function-after)) #+end_src ** [[https://github.com/tarsius/keycast#readme][Keycast]] :noexport: :PROPERTIES: :CUSTOM_ID: sec:keycast :header-args:emacs-lisp: :tangle no :END: Listing [[lst:configure-keycast]] configures =keycast=. #+caption[Configure =keycast=]: #+caption: Configure =keycast=. #+name: lst:configure-keycast #+begin_src emacs-lisp ;; Make `keycast-log-update-buffer' use a buffer similar to the ;; control buffer `ediff-setup-windows-plain' returns. (when (and (ensure-package-installation 'keycast) (require 'keycast nil 'noerror)) (custom-set-variables '(keycast-mode-line-window-predicate 'keycast-bottom-right-window-p)) (defun keycast-log-update-buffer-plain () (let ((buffer (get-buffer keycast-log-buffer-name))) (unless (buffer-live-p buffer) (setq buffer (get-buffer-create keycast-log-buffer-name)) (with-current-buffer buffer (setq buffer-read-only t))) (unless (get-buffer-window buffer) (display-buffer buffer '(display-buffer-at-bottom (dedicated . t) (window-height . 10)))) (when-let ((output (keycast--format keycast-log-format))) (with-current-buffer buffer (goto-char (if keycast-log-newest-first (point-min) (point-max))) (let ((inhibit-read-only t)) (when (and (> keycast--command-repetitions 0) (string-match-p "%[rR]" keycast-log-format)) (unless keycast-log-newest-first (backward-char)) (ignore-errors (delete-region (line-beginning-position) (1+ (line-end-position))))) (insert output)) (goto-char (if keycast-log-newest-first (point-min) (point-max))))))) (defun toggle-keycast-log-update-buffer-override () "Toggle `keycast-log-update-buffer' advice." (interactive) (toggle-advice 'keycast-log-update-buffer :override #'keycast-log-update-buffer-plain)) (toggle-keycast-log-update-buffer-override)) #+end_src * [[info:emacs#Emacs Server][Using Emacs as a server (info)]] :PROPERTIES: :CUSTOM_ID: sec:using-emacs-server :END: Emacs can act as a server that listens to a socket to share its state (for instance buffers and command history) with other programs by means of a shell command =emacsclient=. Section [[#sec:latexmk-save-compile-display-loop]] and [[#sec:qutebrowser-userscript]] show how to use ~emacsclient~ to: 1. Install an asynchronous (or background) loop of saving a LaTeX file, compiling it, and redisplaying the output in Emacs. 2. Make [[https://qutebrowser.org][qutebrowser]] send html links with document titles to Emacs. The code in listing [[lst:start-emacs-server]] starts the Emacs server. #+caption[Start the Emacs server]: #+caption: Start the Emacs server. #+name: lst:start-emacs-server #+begin_src emacs-lisp (when window-system (unless (or noninteractive (daemonp)) (add-hook 'after-init-hook #'server-start))) #+end_src ** Latexmk save-compile-display loop :PROPERTIES: :CUSTOM_ID: sec:latexmk-save-compile-display-loop :END: The =latexmk= resource file in the next source code block shows how to use =emacsclient= to (re)display the PDF file in Emacs after each succesful (re)compilation on condition that the settings of the ~compile-command~ local variable in section are compatible. The local variable ~compile-command~ in the [[#sec:local-variables][local variables]] section (only visible in =org= files, but not in =html= and =pdf= files) shows how to use the =latexmkrc= file. #+attr_latex: :options breaklines #+caption[Tangle the =Latexmk= resource file]: #+caption: Tangle the =Latexmk= resource file. #+name: lst:latexmkrc #+begin_src perl :tangle latexmkrc :comments none # pdf creator $pdf_mode = 4; # 4 means lualatex # pdf previewer and update pdf previewer $pdf_previewer = "emacsclient -e '(find-file-other-window %S)'"; $pdf_update_method = 4; # 4 runs $pdf_update_command to force the update $pdf_update_command = "emacsclient -e '(with-current-buffer (find-buffer-visiting %S) (pdf-view-revert-buffer nil t))'"; # see for instance glossary.latexmkrc add_cus_dep( 'acn', 'acr', 0, 'makeglossaries' ); add_cus_dep( 'glo', 'gls', 0, 'makeglossaries' ); # use ".=" to append to $clean_ext $clean_ext .= " acr acn alg bbl dvi glo gls glg ist lol lst"; $clean_ext .= " nav run.xml snm synctex.gz"; sub makeglossaries { my ($name, $path) = fileparse( $$Psource ); return system "makeglossaries -d '$path' '$name'"; } # Emacs looks for "Local variables:" after the last "newline-formfeed". # Local Variables: # mode: perl # End: #+end_src ** [[https://qutebrowser.org/doc/userscripts.html][Qutebrowser userscript]] :PROPERTIES: :CUSTOM_ID: sec:qutebrowser-userscript :END: The next block contains an userscript that sends a [[info:org#The store-link protocol][store-link org-protocol]] message with the url and the title from [[https://qutebrowser.org][qutebrowser]] to =emacsclient=. The function =urlencode= translates the url and the title for the message. The [[info:python#Examples<22>][Python urllib examples]] show how to use =urlencode=. The final =execvp= call deals with a [[https://qutebrowser.org][qutebrowser]] userscript requirement: the =emacsclient= process must get the PID of the userscript that must kill itself after the take-over. Termination of the =emacsclient= process hands control back to [[https://qutebrowser.org][qutebrowser]]. On a [[https://en.wikipedia.org/wiki/POSIX][POSIX]] system, you can run the userscript from [[https://qutebrowser.org][qutebrowser]] or from a terminal to see whether it works. In case you try to run it from Emacs, Emacs may hang or die. #+caption[Tangle a qutebrowser userscript]: #+caption: Tangle a qutebrowser userscript. #+header: :comments none #+header: :tangle-mode (identity #o755) #+name: lst:qutebrowser-userscript #+begin_src python :noeval :tangle org-store-link #!/usr/bin/env python from urllib.parse import urlencode from os import environ, execvp url = environ.get("QUTE_URL", "https://orgmode.org") title = environ.get("QUTE_TITLE", "Org Mode") parameters = urlencode({"url": url, "title": title}) print(payload := f"org-protocol://store-link?{parameters}") execvp("emacsclient", ("-n", payload)) #+end_src ** TODO Look into: org-protocol handling with other browser on Darwin :PROPERTIES: :CUSTOM_ID: sec:org-protocol-darwin :END: 1. [[http://rwx.io/posts/osx-uri-protocol-handler/][Patrick Goddi: macOS URI protocol handler]] and his [[https://github.com/fooqri/uri-handler][URI-Handler]]. 2. [[https://www.hammerspoon.org/][Hammerspoon]] 3. [[https://vritser.github.io/posts/capture-anywhere/][Emacs Capture Anywhere]] #+caption[Ensure =applescript-mode= installation]: #+caption: Ensure =applescript-mode= installation. #+name: lst:ensure-applescript-mode-installation #+begin_src emacs-lisp (when (ensure-package-installation 'applescript-mode)) #+end_src #+caption[Applescript code to register =org-protocol= on Darwin]: #+caption: Applescript code to register =org-protocol= on Darwin. #+name: lst:applescript-org-protocol #+begin_src applescript :tangle no on emacsclient(input) do shell script "/usr/local/bin/emacsclient -n -c '" & input & "'" tell application "Emacs" to activate end emacsclient on open location input emacsclient(input) end open location on open inputs repeat with raw_input in inputs set input to POSIX path of raw_input emacsclient(input) end repeat end open on run do shell script emacsclient("") end run #+end_src * Completion :PROPERTIES: :CUSTOM_ID: sec:completion :END: [[info:vertico#Top][Vertico (info)]] provides a performant and minimalistic vertical completion UI based on the default completion system and behaves therefore correctly under all circumstances. [[https://cestlaz.github.io/post/using-emacs-80-vertico/][Using Vertico, Marginalia, Consult, and Embark]] links to a video demonstration. Vertico integrates well with fully supported complementary packages to enrich the completion UI: 1. [[info:orderless#Top][Orderless (info)]] for an advanced completion style, 2. [[info:embark#Top][Embark (info)]] for minibuffer actions with context menus, 3. [[info:marginalia#Top][Marginalia (info)]] for rich annotations in the minibuffer, and 4. [[info:consult#Top][Consult (info)]] for useful search and navigation commands, where the order is that of [[https://github.com/bdarcus/citar#installation][enhancing citar's experience]] and the configuration steps below. Finally, [[https://company-mode.github.io/][company: a modular complete-anything framework for Emacs]] provides completion in any buffer and [[#sec:minibuffer-history-completion][minibuffer-history-completion]] provides completion on previous input in the minibuffer. ** [[info:vertico#Top][Vertico (info)]] :PROPERTIES: :CUSTOM_ID: sec:vertico-configuration :END: Listing [[lst:enable-vertico-mode]] configures and enables =savehist-mode= and enables =vertico-mode=. The documentation src_emacs-lisp{(describe-function 'savehist-mode)} why it is best to turn on =savehist-mode= in the Emacs init file. #+caption[Enable =savehist-mode= and =vertico-mode=]: #+caption: Enable =savehist-mode= and =vertico-mode=. #+name: lst:enable-vertico-mode #+begin_src emacs-lisp (when (fboundp 'savehist-mode) (savehist-mode +1) (custom-set-variables '(savehist-additional-variables '(eww-history kill-ring regexp-search-string search-ring search-string)))) (when (fboundp 'vertico-mode) (vertico-mode +1)) (with-eval-after-load 'vertico (define-key vertico-map (kbd "RET") #'vertico-directory-enter) (define-key vertico-map (kbd "DEL") #'vertico-directory-delete-char) (define-key vertico-map (kbd "M-DEL") #'vertico-directory-delete-word)) #+end_src #+attr_latex: :booktabs yes :float table #+caption[Vertico key map bindings]: #+caption: Vertico key map bindings. #+name: tab:vertico-keymap-bindings |-------------------------------+----------------------------------+---------------------| | command | remap | keys | |-------------------------------+----------------------------------+---------------------| | vertico-directory-delete-char | | {{{kbd(DEL)}}} | | vertico-directory-delete-word | | {{{kbd(M-DEL)}}} | | vertico-directory-enter | | {{{kbd(RET)}}} | | vertico-exit | exit-minibuffer | {{{kbd(C-j)}}} | | vertico-exit-input | | {{{kbd(C-RET)}}} | | vertico-first | beginning-of-buffer | {{{kbd(M-<)}}} | | vertico-first | minibuffer-beginning-of-buffer | {{{kbd(M-<)}}} | | vertico-insert | | {{{kbd(TAB)}}} | | vertico-last | end-of-buffer | {{{kbd(M->)}}} | | vertico-next-group | forward-paragraph | {{{kbd(C-)}}} | | vertico-next | next-line-or-history-element | {{{kbd()}}} | | vertico-next | next-line | {{{kbd(C-n)}}} | | vertico-previous-group | backward-paragraph | {{{kbd(C-)}}} | | vertico-previous | previous-line-or-history-element | {{{kbd()}}} | | vertico-previous | previous-line | {{{kbd(C-p)}}} | | vertico-save | kill-ring-save | {{{kbd(M-w)}}} | | vertico-scroll-down | scroll-down-command | {{{kbd(M-v)}}} | | vertico-scroll-up | scroll-up-command | {{{kbd(C-v)}}} | |-------------------------------+----------------------------------+---------------------| ** [[info:orderless#Top][Orderless (info)]] :PROPERTIES: :CUSTOM_ID: sec:orderless-configuration :END: Listing [[lst:configure-orderless]] configures [[info:orderless#Company][orderless for company (info)]]. #+caption[Configure =orderless=]: #+caption: Configure =orderless=. #+name: lst:configure-orderless #+begin_src emacs-lisp (when (ensure-package-installation 'marginalia) (with-eval-after-load 'orderless (custom-set-variables '(orderless-component-separator " +")) (defun just-one-face (fn &rest args) (let ((orderless-match-faces [completions-common-part])) (apply fn args))) (advice-add 'company-capf--candidates :around #'just-one-face))) #+end_src ** [[info:embark#Top][Embark (info)]] :PROPERTIES: :CUSTOM_ID: sec:embark-configuration :END: Listing [[lst:configure-embark]] configures =embark= key bindings: 1. =embark-act= prompts the user for an action and performs it. 2. Except for highlighting of email and web URLs, =embark-dwim= englobes the functionality of src_emacs-lisp{(find-library "goto-addr")} that activates mail and web URLs to turn them into clickable buttons. Since =embark-dwim= acts on a superset of target types, it renders =goto-addr= superfluous. See: 1. [[info:emacs#Goto Address mode][Goto Address mode (info)]]. 2. [[info:embark#The default action on a target][The default (embark-dwim) action on a target (info)]]. 3. =embark-bindings= allows to explore all current command key bindings in the minibuffer. 4. The initialization src_emacs-lisp{(setq prefix-help-command #'embark-prefix-help-command)} enables minibuffer help after a prefix key (for instance {{{kbd(C-x)}}} or {{{kbd(C-c)}}}) as typing {{{kbd(C-x C-h)}}} or {{{kbd(C-c C-h)}}} shows. #+caption[Configure =embark=]: #+caption: Configure =embark=. #+name: lst:configure-embark #+begin_src emacs-lisp (when (ensure-package-installation 'embark) (when (fboundp 'embark-act) (global-set-key (kbd "C-,") #'embark-act)) (when (fboundp 'embark-dwim) (global-set-key (kbd "C-:") #'embark-dwim)) (when (fboundp 'embark-bindings) (global-set-key (kbd "C-h B") #'embark-bindings)) (when (fboundp 'embark-prefix-help-command) (setq prefix-help-command #'embark-prefix-help-command))) #+end_src ** [[info:marginalia#Top][Marginalia (info)]] :PROPERTIES: :CUSTOM_ID: sec:marginalia-configuration :END: Listing [[lst:enable-marginalia-mode]] enables =marginalia-mode=. #+caption[Enable =marginalia-mode=]: #+caption: Enable =marginalia-mode=. #+name: lst:enable-marginalia-mode #+begin_src emacs-lisp (when (and (ensure-package-installation 'marginalia) (fboundp 'marginalia-mode)) (marginalia-mode +1)) #+end_src ** [[info:consult#Top][Consult (info)]] :PROPERTIES: :CUSTOM_ID: sec:consult-configuration :END: Consult provides practical commands based on the Emacs minibuffer completion function [[info:elisp#Minibuffer Completion][completing-read]]. Listing [[lst:configure-consult]] configures =consult=. #+attr_latex: :booktabs yes :float table #+caption[Configuration specific key bindings]: #+caption: Configuration specific key-bindings. #+name: tab:configuration-specific-key-bindings |-----------------------------+----------------------+---------------------| | command | key map | keys | |-----------------------------+----------------------+---------------------| | consult-apropos | help-map | {{{kbd( a)}}} | | consult-bookmark | ctl-x-r-keymap | {{{kbd(C-x r b)}}} | | consult-buffer-other-frame | ctl-x-5-keymap | {{{kbd(C-x 5 b)}}} | | consult-buffer-other-window | ctl-x-4-keymap | {{{kbd(C-x 4 b)}}} | | consult-buffer | ctl-x-keymap | {{{kbd(C-x b)}}} | | consult-compile-error | goto-map | {{{kbd(M-g e)}}} | | consult-complex-command | ctl-x-keymap | {{{kbd(C-x M-:)}}} | | consult-find | search-map | {{{kbd(M-s f)}}} | | consult-focus-lines | search-map | {{{kbd(M-s u)}}} | | consult-git-grep | search-map | {{{kbd(M-s g)}}} | | consult-global-mark | goto-map | {{{kbd(M-g k)}}} | | consult-goto-line | goto-map | {{{kbd(M-g M-g)}}} | | consult-goto-line | goto-map | {{{kbd(M-g g)}}} | | consult-history | global-map | {{{kbd(C-c h)}}} | | consult-imenu | goto-map | {{{kbd(M-g i)}}} | | consult-keep-lines | search-map | {{{kbd(M-s k)}}} | | consult-line | search-map | {{{kbd(M-s l)}}} | | consult-mark | goto-map | {{{kbd(M-g m)}}} | | consult-mode-command | global-map | {{{kbd(C-c m)}}} | | consult-multi-occur | search-map | {{{kbd(M-s m)}}} | | consult-outline | goto-map | {{{kbd(M-g o)}}} | | consult-register | ctl-x-r-keymap | {{{kbd(C-x r x)}}} | | consult-yank-pop | global-map | {{{kbd(M-y)}}} | |-----------------------------+----------------------+---------------------| | deadgrep | search-map | {{{kbd(M-s d)}}} | | elfeed | global-map | {{{kbd(C-x w)}}} | | embark-act | global-map | {{{kbd(C-\,)}}} | | embark-bindings | global-map | {{{kbd(C-h B)}}} | | embark-dwim | global-map | {{{kbd(C-:)}}} | | iedit-mode | global-map | {{{kbd(C-;)}}} | | minibuffer-complete-history | minibuffer-local-map | {{{kbd(C-)}}} | | narrow-or-widen-dwim | ctl-x-keymap | {{{kbd(C-x C-n)}}} | | org-agenda | global-map | {{{kbd(C-c a)}}} | | org-capture | global-map | {{{kbd(C-c c)}}} | | org-cite | org-mode-map | {{{kbd(C-c b)}}} | | org-insert-link-global | global-map | {{{kbd(C-c C-l)}}} | | org-narrow-to-table | ctl-x-keymap | {{{kbd(C-x n t)}}} | | org-store-link | global-map | {{{kbd(C-c l)}}} | |-----------------------------+----------------------+---------------------| #+caption[Configure =consult=]: #+caption: Configure =consult=. #+name: lst:configure-consult #+begin_src emacs-lisp (when (ensure-package-installation 'consult) (custom-set-variables '(consult-project-function #'(lambda (_) (vc-root-dir)))) ;; C-c bindings (current-global-map) (global-set-key (kbd "C-c h") #'consult-history) (global-set-key (kbd "C-c m") #'consult-mode-command) ;; C-h bindings (help-map) (define-key help-map (kbd "a") #'consult-apropos) ;; C-x bindings (ctl-x-map) (define-key ctl-x-map (kbd "M-:") #'consult-complex-command) (define-key ctl-x-map (kbd "b") #'consult-buffer) (define-key ctl-x-4-map (kbd "b") #'consult-buffer-other-window) (define-key ctl-x-5-map (kbd "b") #'consult-buffer-other-frame) (define-key ctl-x-r-map (kbd "x") #'consult-register) (define-key ctl-x-r-map (kbd "b") #'consult-bookmark) ;; M-g bindings (goto-map) (define-key goto-map (kbd "g") #'consult-goto-line) (define-key goto-map (kbd "M-g") #'consult-goto-line) (define-key goto-map (kbd "o") #'consult-outline) (define-key goto-map (kbd "m") #'consult-mark) (define-key goto-map (kbd "k") #'consult-global-mark) (define-key goto-map (kbd "i") #'consult-imenu) (define-key goto-map (kbd "e") #'consult-compile-error) ;; M-s bindings (search-map) (define-key search-map (kbd "g") #'consult-git-grep) (define-key search-map (kbd "f") #'consult-find) (define-key search-map (kbd "k") #'consult-keep-lines) (define-key search-map (kbd "l") #'consult-line) (define-key search-map (kbd "m") #'consult-multi-occur) (define-key search-map (kbd "u") #'consult-focus-lines) ;; Other bindings (current-global-map) (global-set-key (kbd "M-y") #'consult-yank-pop)) #+end_src ** [[https://company-mode.github.io/][Company: a modular complete anything framework for Emacs]] :PROPERTIES: :CUSTOM_ID: sec:company-configuration :END: Listing [[lst:configure-company]] configures =company=. #+caption[Configure =company=]: #+caption: Configure =company=. #+name: lst:configure-company #+begin_src emacs-lisp (when (fboundp 'company-mode) (custom-set-variables ;; https://github.com/purcell/emacs.d/issues/778 '(company-transformers '(company-sort-by-occurrence))) (dolist (hook '(LaTeX-mode-hook org-mode-hook emacs-lisp-mode-hook lisp-interaction-mode-hook lisp-mode-hook python-mode-hook ielm-mode-hook sly-mrepl-mode-hook)) (add-hook hook #'company-mode))) #+end_src ** [[https://lists.gnu.org/archive/html/emacs-devel/2021-12/msg00802.html][Minibuffer history completion]] :PROPERTIES: :CUSTOM_ID: sec:minibuffer-history-completion :END: See [[https://lists.gnu.org/archive/html/emacs-devel/2021-12/msg00802.html][Juri Linkov (Emacs Developer mailing list)]] for how to allow completion on previous input in the minibuffer. Listing [[lst:enable-minibuffer-history-completion]] enables minibuffer history completion. #+caption[Enable =minibuffer-history-completion=]: #+caption: Enable =minibuffer-history-completion=. #+name: lst:enable-minibuffer-history-completion #+begin_src emacs-lisp (with-eval-after-load 'minibuffer ;; https://github.com/oantolin/emacs-config/blob/master/init.el#L333 (custom-set-variables '(completion-category-defaults nil) '(completion-category-overrides '((file (styles basic partial-completion)))) '(completion-ignore-case t) '(completion-styles '(orderless basic partial-completion))) (defun minibuffer-setup-history-completions () (unless (or minibuffer-completion-table minibuffer-completion-predicate) (setq-local minibuffer-completion-table (symbol-value minibuffer-history-variable)))) (add-hook 'minibuffer-setup-hook 'minibuffer-setup-history-completions) ;; Stolen from Emacs-28.1 for Emacs-27.2: (unless (fboundp 'minibuffer--completion-prompt-end) (defun minibuffer--completion-prompt-end () (let ((end (minibuffer-prompt-end))) (if (< (point) end) (user-error "Can't complete in prompt") end)))) ;; Adapted from ‘minibuffer-complete’: (defun minibuffer-complete-history () "Allow minibuffer completion on previous input." (interactive) (completion-in-region (minibuffer--completion-prompt-end) (point-max) (symbol-value minibuffer-history-variable) nil)) (define-key minibuffer-local-map (kbd "C-") #'minibuffer-complete-history)) #+end_src * [[info:emacs#Search][Search and replace (info)]] :PROPERTIES: :CUSTOM_ID: sec:search-replace :END: ** [[info:emacs#Regexp Replace][Regexp Replace (info)]] :PROPERTIES: :CUSTOM_ID: sec:regexp-replace :END: Executing {{{kbd(M-x replace-regexp)}}} prompts fo a regular expression =REGEXP= and a substitution =NEWSTRING= to replace =REGEXP= with =NEWSTRING=. The tools in section [[#sec:narrowing][Narrowing]] allow to limit the scope of {{{kbd(M-x replace-regexp)}}}. A list pointing to relevant documentation is: 1. [[info:emacs#Regexp Replace][Regexp Replace (info)]] explains how the substitution handles references to regular expression groups and lisp expressions. 2. [[info:emacs#Regexps][Syntax of Regular Expressions (info)]] describes regular expression features for users. 3. [[info:elisp#Regular Expressions][Emacs Lisp Regular Expressions (info)]] describes regular expression features for programmers. 4. [[https://www.emacswiki.org/][Emacs Wiki]] has an article on [[https://www.emacswiki.org/emacs/ReplaceRegexpWithLispExpressions][replacing regexp with lisp expressions]]. Table [[tab:replace-regexp-tranform]] tabulates how to perfom example tasks by means of {{{kbd(M-x replace-regexp)}}} using =(regular-expression transform)= pairs. #+attr_latex: :booktabs yes :float table #+caption[Example =replace-regexp= (regular-expression substitution) pairs]: #+caption: Example =replace-regexp= (regular-expression substitution) pairs. #+name: tab:replace-regexp-tranform | task | regular expression | substitution | |-----------------------------+---------------------------------+---------------| | move dot two digits forward | =0\.\([[:digit:]][[:digit:]]\)= | =0\1.= | | move dot two digits forward | =0\.\([0-9][0-9]\)= | =0\1.= | | renumber grep/occur matches | =\(.+:\)= | =\,(1+ \#)._= | |-----------------------------+---------------------------------+---------------| ** [[https://github.com/Wilfred/deadgrep#readme][Deadgrep]] :PROPERTIES: :CUSTOM_ID: sec:deadgrep :END: [[https://github.com/Wilfred/deadgrep#readme][Deadgrep]] uses [[https://github.com/BurntSushi/ripgrep#readme][ripgrep]] for superfast text searching in the default directory or the current [[https://en.wikipedia.org/wiki/Version_control][VCS]] directory tree. Listing [[lst:configure-deadgrep]] binds =deadgrep= to {{{kbd(M-s d)}}} and =deadgrep-edit-mode= to {{{kbd(C-c C-w)}}}. #+caption[Configure =deadgrep=]: #+caption: Configure =deadgrep=. #+name: lst:configure-deadgrep #+begin_src emacs-lisp (when (and (ensure-package-installation 'deadgrep) (fboundp 'deadgrep)) (define-key search-map (kbd "d") #'deadgrep) (with-eval-after-load 'deadgrep (define-key deadgrep-mode-map (kbd "C-c C-w") #'deadgrep-edit-mode))) #+end_src ** [[https://www.genivia.com/get-ugrep.html][Ugrep]] :PROPERTIES: :CUSTOM_ID: sec:ugrep :END: [[https://www.genivia.com/get-ugrep.html][Ugrep]] is an ultra fast grep with interactive query UI and fuzzy search. The pages [[https://github.com/Genivia/ugrep#emacs][Using ugrep within Emacs]] and [[https://manueluberti.eu/emacs/2022/08/07/emacs-ugrep/][Ugrep in Emacs]] show how to make Emacs use it with [[info:emacs#Grep Searching][lgrep]] and [[info:emacs#Xref][xref]]. Listing [[lst:use-ugrep]] shows my implementation of the suggestions on those pages. #+caption[Use =ugrep= when available]: #+caption: Use =ugrep= when available. #+name: lst:use-ugrep #+begin_src emacs-lisp (when (executable-find "ugrep") (with-eval-after-load 'grep (custom-set-variables `(grep-template ,(string-join '("ugrep" "--color=always" "--decompress" "--ignore-binary" "--ignore-case" "--include=\"\"" "--line-number" "--null" "--recursive" "--regexp=") " ")))) (with-eval-after-load 'xref (custom-set-variables '(xref-search-program-alist '((grep . "xargs -0 grep --null -snHE -e ") (ripgrep . "xargs -0 rg --null -nH --no-heading --no-messages -g '!*/' -e ") (ugrep . "xargs -0 ugrep --null -ns -e "))) '(xref-search-program 'ugrep)))) #+end_src * [[info:emacs#Version Control][Version Control (info)]] :PROPERTIES: :CUSTOM_ID: sec:version-control :END: ** [[info:ediff#Top][Ediff (info)]] :PROPERTIES: :CUSTOM_ID: sec:ediff :END: Video links to complete the [[info:ediff#Top][ediff (info)]] manual are: 1. [[https://www.youtube.com/watch?v=6ZWp05OW1c0][Emergency Emacs]]. 2. [[https://protesilaos.com/codelog/2020-04-10-emacs-smerge-ediff/][Use =smerge= and =ediff= to resolve file conflicts]]. Listing [[lst:configure-ediff]] configures =ediff= to display all its buffers in a single frame and to make all text visible prior to ediffing Org buffers. #+caption[Configure =ediff=]: #+caption: Configure =ediff=. #+name: lst:configure-ediff #+begin_src emacs-lisp (with-eval-after-load 'emacs (custom-set-variables '(ediff-merge-split-window-function #'split-window-horizontally) '(ediff-split-window-function #'split-window-horizontally) '(ediff-window-setup-function #'ediff-setup-windows-plain))) (with-eval-after-load 'org ;; https://github.com/oantolin/emacs-config#readme (defun ediff-with-org-show-all () "Expand all headings prior to ediffing org buffers." (add-hook 'ediff-prepare-buffer-hook #'org-show-all nil t)) (add-hook 'org-mode-hook #'ediff-with-org-show-all)) #+end_src * Reading :PROPERTIES: :CUSTOM_ID: sec:reading :END: ** Reading [[https://en.wikipedia.org/wiki/DjVu][DjVu]] files :PROPERTIES: :CUSTOM_ID: sec:reading-djvu-files :END: This setup relies on [[info:emacs#Document View][Document View (info)]] to facilitate reading [[https://en.wikipedia.org/wiki/DjVu][DjVu]] files. Reading the code shown by src_emacs-lisp{(find-function 'doc-view-djvu->tiff-converter-ddjvu)} shows that reading [[https://en.wikipedia.org/wiki/DjVu][DjVu]] files requires the command line [[https://en.wikipedia.org/wiki/DjVu][DjVu]] decoder =ddjvu= from the [[http://djvu.sourceforge.net/][DjVuLibre]] utilities. ** Reading EPUB files :PROPERTIES: :CUSTOM_ID: sec:reading-epub-files :END: The package [[https://depp.brause.cc/nov.el/][nov.el]] provides a major mode for reading EPUB files in Emacs. Listing [[lst:configure-nov]] configures [[https://depp.brause.cc/nov.el/][nov.el]]. #+caption[Configure =nov=]: #+caption: Configure =nov=. #+name: lst:configure-nov #+begin_src emacs-lisp (when (and (ensure-package-installation 'nov) (fboundp 'nov-mode)) (add-to-list 'auto-mode-alist `(,(rx ".epub" eos) . nov-mode))) #+end_src ** Reading PDF files :PROPERTIES: :CUSTOM_ID: sec:reading-pdf-files :END: The [[https://github.com/vedang/pdf-tools][pdf-tools]] package exploits the [[https://github.com/freedesktop/poppler][poppler]] library to render and to let you annotate [[https://en.wikipedia.org/wiki/PDF][PDF]] files. It also exploits the [[https://wiki.contextgarden.net/SyncTeX][SyncTeX]] library to link anchors in [[https://en.wikipedia.org/wiki/PDF][PDF]] files produced with LaTeX to the original LaTeX sources. The [[https://github.com/nicolaisingh/saveplace-pdf-view#readme][saveplace-pdf-view]] package saves =pdf-view= and =doc-view= places. In order to use [[https://github.com/vedang/pdf-tools][pdf-tools]], you have to type {{{kbd(M-x pdf-tools-install)}}} after installation of [[https://github.com/vedang/pdf-tools][pdf-tools]] from [[https://melpa.org/][MELPA]] or after each update of [[https://github.com/freedesktop/poppler][poppler]] to build or rebuild the =epdfinfo= executable that serves the [[https://en.wikipedia.org/wiki/PDF][PDF]] files to Emacs. #+caption[Configure =pdf-tools=]: #+caption: Configure =pdf-tools=. #+name: lst:configure-pdf-tools #+begin_src emacs-lisp (when (and (ensure-package-installation 'pdf-tools 'saveplace-pdf-view) (fboundp 'pdf-loader-install)) ;; `pdf-loader-install' is the lazy equivalent of `pdf-tools-install': ;; see the README file. (pdf-loader-install) (with-eval-after-load 'pdf-outline ;; Unmask the `image-save' key binding in `pdf-view-mode-map' and ;; in `image-mode-map' (by parenthood). (define-key pdf-outline-minor-mode-map (kbd "o") nil) (define-key pdf-outline-minor-mode-map (kbd "O") #'pdf-outline)) (with-eval-after-load 'pdf-view (custom-set-variables '(pdf-view-display-size 'fit-page) `(pdf-view-use-scaling ,(eq system-type 'darwin))) (require 'saveplace-pdf-view nil 'noerror))) #+end_src * Writing :PROPERTIES: :CUSTOM_ID: sec:writing :END: ** Writing LaTeX files :PROPERTIES: :CUSTOM_ID: sec:writing-latex-files :END: Loading =tex.el= immediately instead of lazily ensures proper initialization of [[https://en.wikipedia.org/wiki/AUCTeX][AUCTeX]]. For instance, the ~TeX-master~ safe local variable in the =tex.el= elisp library file has no autoload cookie. Without prior loading of =tex.el=, Emacs will complain that ~TeX-master~ is no safe local variable in case it reads a LaTeX file that sets ~TeX-master~. Listing [[lst:require-auctex]] initializes [[https://en.wikipedia.org/wiki/AUCTeX][AUCTeX]] properly for LuaTeX or LuaLaTeX. In case the output of =LuaLaTeX= has missing fonts, listing [[lst:update-lualatex-opentype-font-name-database]] defines a function to update the =OpenType Font= name database for =LuaLaTeX=. Finally, out of the box, [[https://en.wikipedia.org/wiki/AUCTeX][AUCTeX]] does not indent text between square brackets. The code in listing [[lst:configure-auctex]] corrects this by advising to override ~TeX-brace-count-line~ with ~TeX-brace-count-line-advice~. #+caption[Require =AUCTeX=]: #+caption: Require =AUCTeX=. #+name: lst:require-auctex #+begin_src emacs-lisp ;; Use `require' to make `TeX-master' a safe local variable. (when (require 'tex nil 'noerror) (custom-set-variables '(TeX-auto-save t) '(TeX-engine 'luatex) '(TeX-install-font-lock #'font-latex-setup) '(TeX-parse-self t) ;; Disable `TeX-electric-math' to prevent collisions with `smartparens'. '(TeX-electric-math nil))) #+end_src #+caption[Update the =LuaLaTeX OpenType Font= name database]: #+caption: Update the =LuaLaTeX= =OpenType Font= name database. #+name: lst:update-lualatex-opentype-font-name-database #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun update-lualatex-opentype-font-name-database () "Update the \"OpenType Font\" name database for \"LuaLaTeX\"." (interactive) (cl-destructuring-bind (exit-code output) (shell-command-with-exit-code "luaotfload-tool" "-vv" "--update" "--force") (if (= 0 exit-code) (message "%s" (string-trim output)) (error "%s" (string-trim output)))))) #+end_src #+caption[Configure =AUCTeX=]: #+caption: Configure =AUCTeX=. #+name: lst:configure-auctex #+begin_src emacs-lisp (when (require 'tex nil 'noerror) ;; https://emacs.stackexchange.com/a/35507 answers: ;; How to indent between square brackets? (defun TeX-brace-count-line-override () "Count number of open/closed braces." (save-excursion (let ((count 0) (limit (line-end-position)) char) (while (progn (skip-chars-forward "^{}[]\\\\" limit) (when (and (< (point) limit) (not (TeX-in-comment))) (setq char (char-after)) (forward-char) (cond ((eq char ?\{) (setq count (+ count TeX-brace-indent-level))) ((eq char ?\}) (setq count (- count TeX-brace-indent-level))) ((eq char ?\[) (setq count (+ count TeX-brace-indent-level))) ((eq char ?\]) (setq count (- count TeX-brace-indent-level))) ((eq char ?\\) (when (< (point) limit) (forward-char) t)))))) count))) (defun toggle-TeX-brace-count-line-override () "Toggle `TeX-brace-count-line-override' advice." (interactive) (toggle-advice 'TeX-brace-count-line :override #'TeX-brace-count-line-override)) (toggle-TeX-brace-count-line-override)) #+end_src Listing [[lst:configure-bibtex]] configures the Emacs =bibtex= library to use the LaTeX =BiBTeX= dialect for backwards compatibility. Listing [[lst:configure-font-latex]] disables font scaling of section titles. Listing [[lst:configure-latex]] configures =latex= for a full featured =LaTeX-section-command=. #+caption[Configure =bibtex=]: #+caption: Configure =bibtex=. #+name: lst:configure-bibtex #+begin_src emacs-lisp (with-eval-after-load 'bibtex (custom-set-variables '(bibtex-dialect 'BibTeX))) #+end_src #+caption[Configure =font-latex=]: #+caption: Configure =font-latex=. #+name: lst:configure-font-latex #+begin_src emacs-lisp (with-eval-after-load 'font-latex (custom-set-variables '(font-latex-fontify-sectioning 1.0))) #+end_src #+caption[Configure =latex=]: #+caption: Configure =latex=. #+name: lst:configure-latex #+begin_src emacs-lisp (with-eval-after-load 'latex (custom-set-variables '(LaTeX-electric-left-right-brace t) '(LaTeX-section-hook '(LaTeX-section-heading LaTeX-section-title LaTeX-section-toc LaTeX-section-section LaTeX-section-label)))) #+end_src *** [[https://gitlab.com/matsievskiysv/math-preview/-/blob/master/README.md][Math-preview]] :PROPERTIES: :CUSTOM_ID: sec:math-preview :END: [[https://gitlab.com/matsievskiysv/math-preview/-/blob/master/README.md][Math-preview]] uses [[https://docs.mathjax.org/en/latest/][Mathjax-3]] to display [[https://www.latex-project.org/][LaTeX]], [[https://www.w3.org/Math/][MathML]],and [[http://asciimath.org/][asciimath]] in Emacs buffers with help of an external [[https://nodejs.org][node.js]] program. #+caption[Configure =math-preview=]: #+caption: Configure =math-preview=. #+name: lst:configure-math-preview #+begin_src emacs-lisp (when (ensure-package-installation 'math-preview) (with-eval-after-load 'math-preview ;; https://docs.mathjax.org/en/latest/input/tex/extensions/physics.html (let ((physics (split-string " abs absolutevalue acomm acos acosecant acosine acot acotangent acsc admat anticommutator antidiagonalmatrix arccos arccosecant arccosine arccot arccotangent arccsc arcsec arcsecant arcsin arcsine arctan arctangent asec asecant asin asine atan atangent bmqty bqty Bqty bra braket comm commutator cos cosecant cosh cosine cot cotangent coth cp cross crossproduct csc csch curl dd derivative det determinant diagonalmatrix diffd differential div divergence dmat dotproduct dv dyad erf ev eval evaluated exp expectationvalue exponential expval fderivative fdv flatfrac functionalderivative grad gradient gradientnabla hypcosecant hypcosine hypcotangent hypsecant hypsine hyptangent identitymatrix Im imaginary imat innerproduct ip ket ketbra laplacian ln log logarithm matrixdeterminant matrixel matrixelement matrixquantity mdet mel mqty naturallogarithm norm op order outerproduct partialderivative paulimatrix pb pderivative pdv pmat pmqty Pmqty poissonbracket pqty Pr principalvalue Probability pv PV qall qand qas qassume qc qcc qcomma qelse qeven qfor qgiven qif qin qinteger qlet qodd qor qotherwise qq qqtext qsince qthen qty quantity qunless qusing rank Re real Res Residue sbmqty sec secant sech sin sine sinh smallmatrixquantity smdet smqty spmqty sPmqty svmqty tan tangent tanh tr Tr trace Trace va var variation vb vdot vectorarrow vectorbold vectorunit vmqty vnabla vqty vu xmat xmatrix zeromatrix zmat"))) (cl-pushnew `("physics" . ,physics) math-preview-tex-packages-autoload-packages)) (setq math-preview-raise 0.5 math-preview-scale 1 math-preview-tex-default-packages '("autoload" "ams" "physics")) (let ((command (executable-find "~/node_modules/.bin/math-preview"))) (if command (setq math-preview-command command) ;; https://stackoverflow.com/a/17509764 answers: ;; How to install an npm package from github directly? (unless (file-directory-p "~/node_modules") (make-directory "~/node_modules")) (cl-destructuring-bind (exit-code output) (shell-command-with-exit-code "npm" "install" "git+https://gitlab.com/matsievskiysv/math-preview.git") (if (= 0 exit-code) (message "%s" (string-trim output)) (error "%s" (string-trim output)))))))) #+end_src *** TODO Improve the AUCTeX configuration slowly :PROPERTIES: :CUSTOM_ID: sec:configure-auctex-slowly :END: [[https://github.com/thisirs/dotemacs/blob/master/lisp/init-auctex.el][AUCTeX setup of an experienced user]] ** Writing [[https://www.markdownguide.org/][Markdown]] files :PROPERTIES: :CUSTOM_ID: sec:writing-markdown-files :END: #+caption[Configure =markdown-mode=]: #+caption: Configure =markdown-mode=. #+name: lst:configure-markdown-mode #+begin_src emacs-lisp (when (ensure-package-installation 'markdown-mode)) #+end_src ** Writing Org files :PROPERTIES: :CUSTOM_ID: sec:writing-org-files :END: *** [[info:org#Activation][Org activation (info)]] :PROPERTIES: :CUSTOM_ID: sec:activate-org :END: #+caption[Activate =Org=]: #+caption: Activate =Org=. #+name: lst:activate-org #+begin_src emacs-lisp (when (cl-every #'fboundp '(org-agenda org-capture)) (global-set-key (kbd "C-c a") #'org-agenda) (global-set-key (kbd "C-c c") #'org-capture) (with-eval-after-load 'ol (global-set-key (kbd "C-c l") #'org-store-link) (global-set-key (kbd "C-c C-l") #'org-insert-link-global))) #+end_src *** Org customization :PROPERTIES: :CUSTOM_ID: sec:customize-org :END: Listing [[lst:customize-org-babel]], [[lst:customize-org]], [[lst:customize-org-link]] does basic customization of [[https://orgmode.org/][Org-mode]] variables. In addition, listing [[lst:customize-org-babel]] selects the Python interpreter by means of src_emacs-lisp{(choose-common-python-interpreter)} defined in listing [[lst:choose-common-python-interpreter]]. Listing [[lst:customize-org-for-lualatex-export]], and [[lst:customize-ox-latex-for-lualatex-export]] configure [[https://orgmode.org/][Org-mode]] for export to LuaLaTeX. Listing [[lst:customize-ob-python]] allows to pretty-print Python session source block values with [[https://github.com/psf/black#readme][black]] instead of [[https://docs.python.org/3/library/pprint.html][pprint]]. Listing [[lst:customize-org-link]] configures =org-link= to use relative file path links. Listing [[lst:customize-org-latex-classes]] defines [[info:org#LaTeX specific export settings][org-latex-classes (info)]] for backward compatibility. See table [[tab:org-latex-class-tag-placeholder]] and type {{{kbd(C-h v org-latex-classes)}}} for an explanation of the code in listing [[lst:customize-org-latex-classes]]. #+attr_latex: :booktabs yes :float table #+caption[The relation tag-placeholder in listing [[lst:customize-org-latex-classes]]]: #+caption: The relation tag-placeholder in listing [[lst:customize-org-latex-classes]]. #+name: tab:org-latex-class-tag-placeholder | tag | placeholder | |-----+-----------------------| | +1 | [DEFAULT-PACKAGES] | | +2 | [PACKAGES] | | +3 | [EXTRA] | | -1 | [NO-DEFAULT-PACKAGES] | | -2 | [NO-PACKAGES] | | -3 | [NO-EXTRA] | #+caption[Customize =org-babel=]: #+caption: Customize =org-babel=. #+name: lst:customize-org-babel #+begin_src emacs-lisp (with-eval-after-load 'ob-core (custom-set-variables '(org-confirm-babel-evaluate nil))) (with-eval-after-load 'ob-latex (custom-set-variables '(org-babel-latex-preamble (lambda (_) "\\documentclass[preview]{standalone}\n")) '(org-babel-latex-begin-env (lambda (_) "\\begin{document}\n")) '(org-babel-latex-end-env (lambda (_) "\\end{document}\n")))) (with-eval-after-load 'ob-lisp (with-eval-after-load 'sly (custom-set-variables '(org-babel-lisp-eval-fn #'sly-eval)))) (with-eval-after-load 'ob-python (choose-common-python-interpreter 'python)) #+end_src #+caption[Customize =ob-python=]: #+caption: Customize =ob-python=. #+name: lst:customize-ob-python #+begin_src emacs-lisp (with-eval-after-load 'ob-python (defun org-babel-python-format-session-value-override (src-file result-file result-params) "Return Python code to evaluate SRC-FILE and write result to RESULT-FILE. Use `black' instead of `pprint' when \"pp\" is a member of RESULT-PARAMS." (format "\ import ast with open('%s') as __org_babel_python_tmpfile: __org_babel_python_ast = ast.parse(__org_babel_python_tmpfile.read()) __org_babel_python_final = __org_babel_python_ast.body[-1] if isinstance(__org_babel_python_final, ast.Expr): __org_babel_python_ast.body = __org_babel_python_ast.body[:-1] exec(compile(__org_babel_python_ast, '', 'exec')) __org_babel_python_final = eval( compile(ast.Expression(__org_babel_python_final.value), '', 'eval') ) with open('%s', 'w') as __org_babel_python_tmpfile: if %s: import black __org_babel_python_tmpfile.write( black.format_str(repr(__org_babel_python_final), mode=black.Mode()) ) else: __org_babel_python_tmpfile.write(str(__org_babel_python_final)) else: exec(compile(__org_babel_python_ast, '', 'exec')) __org_babel_python_final = None" (org-babel-process-file-name src-file 'noquote) (org-babel-process-file-name result-file 'noquote) (if (member "pp" result-params) "True" "False")))) (with-eval-after-load 'emacs (defun toggle-org-babel-python-format-session-value-override () "Toggle `org-babel-python-format-session-value' advice." (interactive) (toggle-advice 'org-babel-python-format-session-value :override #'org-babel-python-format-session-value-override)) (toggle-org-babel-python-format-session-value-override)) #+end_src #+caption[Customize =Org=]: #+caption: Customize =Org=. #+name: lst:customize-org #+begin_src emacs-lisp (with-eval-after-load 'org (custom-set-variables `(org-babel-load-languages (delq nil '((C . t) (calc . t) ,(when (fboundp 'grapviz-dot-mode) '(dot . t)) (emacs-lisp . t) (eshell . t) ,(when (fboundp 'fennel-mode) '(fennel . t)) (fortran . t) ,(when (fboundp 'gnuplot-mode) '(gnuplot . t)) (js . t) (latex . t) (lisp . t) ,(when (fboundp 'lua-mode) '(lua . t)) ,(when (fboundp 'maxima-mode) '(maxima . t)) (org . t) (perl . t) (python . t) (shell . t)))) '(org-export-backends '(ascii beamer html icalendar latex odt texinfo)) '(org-file-apps '((auto-mode . emacs) (directory . emacs) ("\\.mm\\'" . default) ("\\.x?html?\\'" . default) ("\\.pdf\\'" . emacs))) '(org-modules '(ol-bibtex ol-doi ol-eww ol-info org-id org-protocol org-tempo)) '(org-structure-template-alist '(("a" . "export ascii") ("c" . "center") ("C" . "comment") ("e" . "example") ("E" . "export") ("h" . "export html") ("l" . "export latex") ("q" . "quote") ("s" . "src") ("p" . "src python :session") ("v" . "verse"))))) #+end_src #+caption[Configure =org-mode-map=]: #+caption: Configure =org-mode-map=. #+name: lst:configure-org-mode-map #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; From: "Nicolas Richard" ;; Date: Fri, 08 Mar 2013 16:23:02 +0100 [thread overview] ;; Message-ID: <87vc913oh5.fsf@yahoo.fr> (raw) (defun org-electric-dollar () "When called once, insert \\(\\) and leave point in between. When called twice, replace the previously inserted \\(\\) by one $." (interactive) (if (and (looking-at "\\\\)") (looking-back "\\\\(" (- (point) 2))) (progn (delete-char 2) (delete-char -2) (insert "$")) (insert "\\(\\)") (backward-char 2))) (defun org-active-current-time-stamp () "Insert an active date-time stamp of the current time." (interactive) (if (fboundp 'org-insert-time-stamp) (org-insert-time-stamp (current-time) 'with-hm) (let ((stamp (format-time-string "<%Y-%m-%d %a %H:%M>" (current-time)))) (insert stamp) stamp))) (defun org-inactive-current-time-stamp () "Insert an inactive date-time stamp of the current time." (interactive) (if (fboundp 'org-insert-time-stamp) (org-insert-time-stamp (current-time) 'with-hm 'inactive) (let ((stamp (format-time-string "[%Y-%m-%d %a %H:%M]" (current-time)))) (insert stamp) stamp))) (with-eval-after-load 'org (define-key org-mode-map (kbd "C-c ") #'org-inactive-current-time-stamp) (define-key org-mode-map (kbd "C-c C-") #'org-active-current-time-stamp) (define-key org-mode-map (kbd "$") #'org-electric-dollar) (define-key org-mode-map (kbd "M-q") #'org-fill-paragraph))) #+end_src #+caption[Customize =org-link=]: #+caption: Customize =org-link=. #+name: lst:customize-org-link #+begin_src emacs-lisp (with-eval-after-load 'ol (custom-set-variables '(org-link-file-path-type 'relative))) #+end_src #+caption[Customize =org-export=]: #+caption: Customize =org-export=. #+name: lst:customize-org-export #+begin_src emacs-lisp (with-eval-after-load 'ox (custom-set-variables '(org-export-dispatch-use-expert-ui t))) #+end_src #+caption[Customize =org= for export to LuaLaTeX]: #+caption: Customize =org= for export to LuaLaTeX. #+name: lst:customize-org-for-lualatex-export #+begin_src emacs-lisp (with-eval-after-load 'org ;; https://list.orgmode.org/87o84fd4oi.fsf@posteo.net/ (add-to-list 'org-preview-latex-process-alist '(luamagick :programs ("lualatex" "convert") :description "pdf > png" :message "you need to install lualatex and imagemagick." :image-input-type "pdf" :image-output-type "png" :image-size-adjust (1.0 . 1.0) :post-clean nil :latex-header nil :latex-compiler ("lualatex -interaction nonstopmode -output-directory %o %f") :image-converter ("convert -density %D -trim -antialias %f -quality 100 %O"))) (custom-set-variables '(org-preview-latex-default-process 'luamagick) '(org-latex-default-packages-alist '(("" "fontspec" t ("lualatex")) ("AUTO" "inputenc" t ("pdflatex")) ("T1" "fontenc" t ("pdflatex")) ("" "graphicx" t) ("" "longtable" nil) ("" "wrapfig" nil) ("" "rotating" nil) ("normalem" "ulem" t) ("" "amsmath" t) ("" "amssymb" t) ("" "capt-of" nil) ("" "hyperref" nil))))) #+end_src #+caption[Customize =ox-latex= for export to LuaLaTeX]: #+caption: Customize =ox-latex= for export to LuaLaTeX. #+name: lst:customize-ox-latex-for-lualatex-export #+begin_src emacs-lisp (with-eval-after-load 'ox-latex (custom-set-variables '(org-latex-pdf-process ;; https://tecosaur.github.io/emacs-config/#compiling `(,(concat "latexmk -f -pdf -%latex" " -interaction=nonstopmode -shell-escape -outdir=%o %f"))) '(org-latex-compiler "lualatex") '(org-latex-hyperref-template "\\hypersetup{ pdfauthor={%a}, pdftitle={%t}, pdfkeywords={%k}, pdfsubject={%d}, pdfcreator={%c}, pdflang={%L}, citecolor=blue, colorlinks=true, filecolor=blue, hyperfootnotes=false, linkcolor=blue, unicode=true, urlcolor=blue, }\n") '(org-latex-listings 'minted) '(org-latex-minted-langs '((cc "c++") (conf "text") (cperl "perl") (diff "diff") (shell-script "bash") (json "json") (org "text") (toml "toml"))) '(org-latex-minted-options '(("bgcolor" "LightGoldenrodYellow"))) `(org-latex-logfiles-extensions ',(cl-union '("lof" "lot") org-latex-logfiles-extensions :test #'equal)) '(org-latex-prefer-user-labels t) '(org-latex-subtitle-separate t))) #+end_src #+caption[Customize =org-latex-classes= for backwards compatibility]: #+caption: Customize =org-latex-classes= for backwards compatibility. #+name: lst:customize-org-latex-classes #+begin_src emacs-lisp (with-eval-after-load 'ox-latex (mapc (function (lambda (element) (add-to-list 'org-latex-classes element))) (nreverse (quote (("elsarticle-1+2+3" ; Elsevier journals "\\documentclass{elsarticle} [NO-DEFAULT-PACKAGES] [PACKAGES] [EXTRA]" ("\\section{%s}" . "\\section*{%s}") ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}") ("\\paragraph{%s}" . "\\paragraph*{%s}") ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) ("article-1+2+3" "\\documentclass{article} [NO-DEFAULT-PACKAGES] [PACKAGES] [EXTRA]" ("\\section{%s}" . "\\section*{%s}") ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}") ("\\paragraph{%s}" . "\\paragraph*{%s}") ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) ("report-1+2+3" "\\documentclass[11pt]{report} [NO-DEFAULT-PACKAGES] [PACKAGES] [EXTRA]" ("\\part{%s}" . "\\part*{%s}") ("\\chapter{%s}" . "\\chapter*{%s}") ("\\section{%s}" . "\\section*{%s}") ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}")) ("book-1+2+3" "\\documentclass[11pt]{book} [NO-DEFAULT-PACKAGES] [PACKAGES] [EXTRA]" ("\\part{%s}" . "\\part*{%s}") ("\\chapter{%s}" . "\\chapter*{%s}") ("\\section{%s}" . "\\section*{%s}") ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))))))) #+end_src *** [[https://github.com/bdarcus/citar][Citar: citing bibliography]] with [[https://orgmode.org/][Org Mode]] :PROPERTIES: :CUSTOM_ID: sec:citing-bibliography :END: [[https://github.com/bdarcus/citar][Citar]] is a completing-read front-end to browse and act on BibTeX, BibLaTeX, as well as CSL JSON bibliographic data with LaTeX, markdown, and org-cite editing support. In combination with vertico, orderless, embark, marginalia, and consult, [[https://github.com/bdarcus/citar][Citar]] provides quick filtering and selecting of bibliographic entries from the minibuffer, as well as the option to run different commands on those selections. The article [[https://kristofferbalintona.me/posts/202206141852/][Citations in org-mode: Org-cite and Citar]] tries to walk you from understanding the general context (bibliography producer, text processor, text to product convertor) to an Emacs setup. Listing [[lst:configure-oc-cite+citar]] shows my =org-cite=, =citar=, and =org= configuration. #+caption[Configure =org-cite= with =citar=]: #+caption: Configure =oc-cite= with =citar=. #+name: lst:configure-oc-cite+citar #+begin_src emacs-lisp (with-eval-after-load 'oc ;; Org-9.5 needs the requirements, but Org-9.6 does not. (require 'oc-biblatex) (require 'oc-csl)) (with-eval-after-load 'org (define-key org-mode-map (kbd "C-c b") #'org-cite-insert)) (when (ensure-package-installation 'citar 'citar-embark) (with-eval-after-load 'embark (when (fboundp 'citar-embark-mode) (citar-embark-mode +1))) (with-eval-after-load 'oc (custom-set-variables '(org-cite-export-processors '((latex biblatex) (t csl))) '(org-cite-global-bibliography '("~/VCS/research/refs.bib"))) (when (require 'citar nil 'noerror) (custom-set-variables '(org-cite-activate-processor 'citar) '(org-cite-follow-processor 'citar) '(org-cite-insert-processor 'citar)))) (with-eval-after-load 'org (when (require 'citar nil 'noerror) (custom-set-variables '(citar-bibliography '("~/VCS/research/refs.bib")) '(citar-library-file-extensions '("djvu" "pdf")) '(citar-library-paths '("~/VCS/research/papers/")))))) #+end_src Ref. [cite:@Schulte.MCSE.2011.41] shows that [[https://orgmode.org/][Org-mode]] is a simple, plain-text markup language for hierarchical documents allowing intermingling of data, code, and prose. It serves as an example link to to show how to use [[https://github.com/bdarcus/citar][Citar]] within this setup, provided that =citar-bibliography= and =citar-library-paths= point to valid directories and files. In an [[https://orgmode.org/][Org-mode]] buffer this setup allows to: 1. Insert one or more [[https://orgmode.org/][Org-mode]] cite links: 1. Type {{{kbd(C-c b)}}} or {{{kbd(M-x org-cite-insert)}}}. 2. Navigate to a bibliographic entry to insert: 1. Select it with {{{kbd(TAB)}}} to select more entries. 2. Select it with {{{kbd(RET)}}} to select the last entry. 2. View an electronic copy of an [[https://orgmode.org/][Org-mode]] cite link: 1. Move point to the [[https://orgmode.org/][Org-mode]] cite link. 2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}. 3. Navigate to the corresponding library file. 4. Select it. 3. Open the DOI of an [[https://orgmode.org/][Org-mode]] cite link: 1. Move point to the [[https://orgmode.org/][Org-mode]] cite link. 2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}. 3. Navigate to the corresponding link. 4. Select it. *** TODO Compare bibtex and biblatex 1. [[https://www.economics.utoronto.ca/osborne/latex/BIBTEX.HTM][Using bibtex: a short guide]] 2. [[https://www.tug.org/texlive//devsrc/Master/texmf-dist/doc/latex/biblatex/biblatex.pdf][The biblatex package]] 3. [[https://github.com/yuchenlin/rebiber][Rebiber: A tool for normalizing bibtex with official info]] 4. [[https://github.com/josephwright/biblatex-phys][A biblatex implementation of the AIP and APS bibliography style]] #+caption[Delete =Biber= cache when =Biber= fails to make a bibliography]: #+caption: Delete =Biber= cache when =Biber= fails to make a bibliography. #+name: lst:delete-biber-cache #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; https://tex.stackexchange.com/a/579356 answers ;; "How to solve Biber exiting with error code 2 but no error messages?" (defun biber-delete-cache () "Delete the `Biber' cache to get rid of `Biber' exit code 2." (interactive) (cl-destructuring-bind (exit-code output) (shell-command-with-exit-code "rm" "-rf" "$(biber --cache)") (if (= 0 exit-code) (message "%s" (string-trim output)) (error "%s" (string-trim output)))))) #+end_src *** [[https://github.com/tecosaur/engrave-faces#readme][Engrave Faces]] :PROPERTIES: :CUSTOM_ID: sec:engrave-faces :END: This package aims to produce a versatile generic core which can process a fontified buffer and pass the data to any number of backends to deal with specific output formats and it should work with =org-mode=. *Thanks to the listings below*, [[https://github.com/tecosaur/engrave-faces#readme][Engrave Faces]] and [[info:org#Source blocks in LaTeX export][Org source block export to LaTeX (info)]] *are capable of handling this [[file:README.org]] file:* 1. Listing [[lst:ensure-engrave-faces-with-latex-face-mapper-fix]] ensures installation of =engrave-faces= and makes =engrave-faces-latex-face-mapper= handle multi-line documentation strings. 2. Listing [[lst:ensure-engrave-faces-with-latex-face-apply-fix]] ensures installation of =engrave-faces= and makes =engrave-faces-latex-face-apply= handle symbolic color name strings (in addition to the hexadecimal strings). 3. The =org-latex-engraved-source-block-filter= in listing [[lst:org-latex-engraved-source-block-filter]] and the =org-latex-engraved-preamble= customization in listing [[lst:smart-latex-engrave-org-source-blocks]] allow to engrave =org-mode= source blocks to "floating unbreakable" or "non-floating breakable" LaTeX environments. 4. Listing [[lst:ox-engraved-emacs-lisp-setup]] shows how to use this configuration. #+caption[Ensure =engrave-faces= installation and fix multiline docstrings]: #+caption: Ensure =engrave-faces= installation and fix multiline docstrings. #+name: lst:ensure-engrave-faces-with-latex-face-mapper-fix #+begin_src emacs-lisp (when (and (ensure-package-installation 'engrave-faces) (require 'engrave-faces-latex nil t)) (defun engrave-faces-latex-face-mapper-override (faces content) "Create a LaTeX representation of CONTENT With FACES applied." (let* ((style (engrave-faces-preset-style faces)) (protected-content (funcall (if (and engrave-faces-latex-mathescape (eq 'font-lock-comment-face (car style))) #'engrave-faces-latex--protect-content-mathescape #'engrave-faces-latex--protect-content) content))) ;; Wrap groups of "words joined by blank characters" in LaTeX commands. ;; Do not wrap newlines and other whitespace between those groups. (let ((regexp (rx (or (group-n 1 (+ graph ) (* (+ blank) (+ graph))) (group-n 2 (+ (any "\n" space)))))) (slug (when (and style (eq engrave-faces-latex-output-style 'preset)) (plist-get (cdr style) :slug))) (start 0) (stack)) (while (string-match regexp protected-content start) (setq start (match-end 0)) (when-let ((pc (match-string 1 protected-content))) (if (stringp slug) (push (concat "\\EF" slug "{" pc "}") stack) (push (engrave-faces-latex-face-apply faces pc) stack))) (when-let ((pc (match-string 2 protected-content))) (push pc stack))) (apply #'concat (nreverse stack)))))) (with-eval-after-load 'emacs (defun toggle-engrave-faces-latex-face-mapper-override () "Toggle `engrave-faces-latex-face-mapper' advice." (interactive) (toggle-advice 'engrave-faces-latex-face-mapper :override #'engrave-faces-latex-face-mapper-override)) (toggle-engrave-faces-latex-face-mapper-override)) #+end_src #+caption[Ensure =engrave-faces= installation and fix symbolic colors]: #+caption: Ensure =engrave-faces= installation and fix symbolic colors. #+name: lst:ensure-engrave-faces-with-latex-face-apply-fix #+begin_src emacs-lisp (when (and (ensure-package-installation 'engrave-faces) (require 'engrave-faces-latex nil t)) (defun engrave-faces-latex--color (color) "Convert COLOR loosely to a string of six hexadecimal digits." (if (char-equal ?# (aref color 0)) (substring color 1 7) (apply 'format "%02x%02x%02x" (mapcar (lambda (c) (ash c -8)) (color-values color))))) (defun engrave-faces-latex-face-apply-override (faces content) "Convert attributes of FACES to LaTeX commands applied to CONTENT." (let ((attrs (engrave-faces-merge-attributes faces))) (let ((bg (plist-get attrs :background)) (fg (plist-get attrs :foreground)) (it (eql (plist-get attrs :slant) 'italic)) (bl (member (plist-get attrs :weight) '(bold extra-bold))) (st (plist-get attrs :strike-through))) (concat (when bg (concat "\\colorbox[HTML]{" (engrave-faces-latex--color bg) "}{")) (when fg (concat "\\textcolor[HTML]{" (engrave-faces-latex--color fg) "}{")) (when st "\\sout{") (when bl "\\textbf{") (when it "\\textit{") content (when bg "}") (when fg "}") (when st "}") (when bl "}") (when it "}")))))) (with-eval-after-load 'emacs (defun toggle-engrave-faces-latex-face-apply-override () "Toggle `engrave-faces-latex-face-apply' advice." (interactive) (toggle-advice 'engrave-faces-latex-face-apply :override #'engrave-faces-latex-face-apply-override)) (toggle-engrave-faces-latex-face-apply-override)) #+end_src #+caption[Engrave to floating unbreakable or non-floating breakable environments]: #+caption: Define an =org-export= filter function to engrave =org-src-mode= #+caption: blocks to floating unbreakable LaTeX environments or non-floating #+caption: breakable LaTeX environments. #+name: lst:org-latex-engraved-source-block-filter #+begin_src emacs-lisp :results silent (defun org-latex-engraved-source-block-filter (data _backend _info) "Replace \"Code\" with \"Breakable\" in non-floating environments. Customize `org-latex-engraved-preamble' to define a Breakable (non-floating) environment and an unbreakable Code (floating) environment." (unless (string-match "^\\\\DeclareTColorBox\\[\\]{Breakable}" org-latex-engraved-preamble) (user-error "`org-latex-engraved-preamble' defines no `Breakable' environment")) (when (eq org-latex-src-block-backend 'engraved) (let ((enter "^\\\\begin{Code}\n\\\\begin{Verbatim}") (leave "^\\\\end{Verbatim}\n\\\\end{Code}")) ;; Transform only blocks matching the enter regexp at position 0. (when (and (string-match enter data) (eql 0 (match-beginning 0))) (setq data (replace-match "\\begin{Breakable}\n\\begin{Verbatim}" t t data)) (when (string-match leave data (match-end 0)) (setq data (replace-match "\\end{Verbatim}\n\\end{Breakable}" t t data)) (when (string-match enter data) (user-error "The `enter' regexp `%s' should not match" enter)) (when (string-match leave data) (user-error "The `leave' regexp `%s' should not match" leave)) data))))) #+end_src #+caption[Enable smart LaTeX engraving of =org-src-mode= blocks]: #+caption: Enable smart LaTeX engraving of =org-src-mode= blocks. #+name: lst:smart-latex-engrave-org-source-blocks #+begin_src emacs-lisp (defun smart-latex-engrave-org-source-blocks () "Enable smart LaTeX engraving of `org-src-mode' blocks. Sets backend and preamble locally to support floating unbreakable LaTeX environments and non-floating breakable LaTeX environments by means of `org-latex-engraved-source-block-filter'." (interactive) (autoload 'org-latex-src-block-backend "ox-latex" nil 'noerror) (setq-local org-latex-src-block-backend 'engraved org-latex-engraved-preamble "\\usepackage{fvextra} [FVEXTRA-SETUP] % Make code and line numbers normalsize. Make line numbers grey. \\renewcommand\\theFancyVerbLine{ \\normalsize\\color{black!40!white}\\arabic{FancyVerbLine}} % In case engrave-faces-latex-gen-preamble has not been run. \\providecolor{EfD}{HTML}{f7f7f7} \\providecolor{EFD}{HTML}{28292e} % To use \\DeclareTColorBox from the tcolorbox package: \\usepackage[breakable,xparse]{tcolorbox} % Define a Breakable environment to fontify code outside floats. \\DeclareTColorBox[]{Breakable}{o}{ colback=EfD, colframe=EFD, colupper=EFD, fontupper=\\normalsize\\setlength{\\fboxsep}{0pt}, IfNoValueTF={#1}{ boxsep=1pt, arc=1pt, outer arc=1pt, boxrule=0.5pt, }{ boxsep=1pt, arc=0pt, outer arc=0pt, boxrule=0pt, leftrule=1pt }, left=2pt, right=2pt, top=1pt, bottom=1pt, breakable } % Define an unbreakable Code environment to fontify code inside floats. \\DeclareTColorBox[]{Code}{o}{ colback=EfD, colframe=EFD, colupper=EFD, fontupper=\\normalsize\\setlength{\\fboxsep}{0pt}, IfNoValueTF={#1}{ boxsep=1pt, arc=1pt, outer arc=1pt, boxrule=0.5pt }{ boxsep=1pt, arc=0pt, outer arc=0pt, boxrule=0pt, leftrule=1pt }, left=2pt, right=2pt, top=1pt, bottom=1pt, } [LISTINGS-SETUP]")) #+end_src #+caption[Emacs setup to use =engrave-faces-latex= in =org-mode= smartly]: #+caption: Emacs setup to use =engrave-faces-latex= in =org-mode= smartly. #+name: lst:ox-engraved-emacs-lisp-setup #+begin_src emacs-lisp :tangle no (with-eval-after-load 'ox (make-variable-buffer-local 'org-export-filter-src-block-functions) (add-to-list 'org-export-filter-src-block-functions 'org-latex-engraved-source-block-filter) (when (fboundp 'smart-latex-engrave-org-source-blocks) (smart-latex-engrave-org-source-blocks))) #+end_src *** [[info:org#Adding Hyperlink Types][Making Org hyperlink types (info)]] :PROPERTIES: :CUSTOM_ID: sec:making-org-hyperlink-types :END: The listings below implement four groups of =org-link= types: 1. Listing [[lst:org-ref-like-org-link-types]] defines =org-link= types for backwards compatibility with [[https://github.com/jkitchin/org-ref][org-ref]]. 2. Listing [[lst:define-org-pdfview-link-type]] uses ideas from the definition of =docview-org-link= and =doi-org-link= types to define an =pdfview-org-link= type for use with [[https://github.com/vedang/pdf-tools][pdf-tools]]. 3. Listing [[lst:define-org-yt-link-type]] reimplements the code of the post [[https://bitspook.in/blog/extending-org-mode-to-handle-youtube-links/][Extending org-mode to handle YouTube links]] allowing to open the YouTube link [[yt://www.youtube.com/watch?v=eaZUZCzaIgw][Extending org-mode to handle YouTube links]] link. 4. Listing [[lst:patch-org-info-link-type]] patches the function =org-info-export= and listing [[lst:emacs-lisp-setup-buffer-local-ol-info]] sets the constants ~org-info-emacs-documents~ and ~org-info-other-documents~ as buffer local variables in order to export the =info-org-link= types in this document to =html= and LaTeX correctly. #+caption[Define =org-link= types for backwards compatibility with =org-ref=]: #+caption: Define =org-link= types for backwards compatibility with =org-ref=. #+name: lst:org-ref-like-org-link-types #+begin_src emacs-lisp (with-eval-after-load 'ol (org-link-set-parameters "ac*" :export #'org-ref-ac*-export) (org-link-set-parameters "cite" :export #'org-ref-cite-export) (org-link-set-parameters "eqref" :export #'org-ref-eqref-export) (org-link-set-parameters "hyperlink" :export #'org-ref-hyperlink-export) (org-link-set-parameters "label" :export #'org-ref-label-export) (org-link-set-parameters "ref" :export #'org-ref-ref-export) (defun org-ref-ac*-export (path _desc backend _info) (pcase backend (`latex (format "\\gls*{%s}" path)) (_ path))) (defun org-ref-cite-export (path _desc backend _info) (pcase backend (`latex (format "\\cite{%s}" path)) (_ path))) (defun org-ref-eqref-export (path _desc backend _info) (pcase backend (`latex (format "\\eqref{%s}" path)) (_ path))) (defun org-ref-hyperlink-export (path desc backend _info) (pcase backend (`latex (format "\\hyperlink{%s}{%s}" path desc)) (_ path))) (defun org-ref-label-export (path _desc backend _info) (pcase backend (`latex (format "\\label{%s}" path)) (_ path))) (defun org-ref-ref-export (path _desc backend _info) (pcase backend (`latex (format "\\ref{%s}" path)) (_ path)))) #+end_src #+caption[Define an =org-link= type for =pdf-tools=]: #+caption: Define an =org-link= type for =pdf-tools=. #+name: lst:define-org-pdfview-link-type #+begin_src emacs-lisp (with-eval-after-load 'ol (autoload 'pdf-view-goto-page "pdf-view" nil t) (org-link-set-parameters "pdfview" :follow #'org-pdfview-open :export #'org-pdfview-export :store #'org-pdfview-store-link) (defun org-pdfview-export (link description backend _) "Export a \"pdfview\" type link. The paths of the links export as file relative paths in order to facilate moving single directories or whole directory trees." (let ((path (if (string-match "\\(.+\\)::.+" link) (match-string 1 link) link)) (desc (or description link))) (when (stringp path) (setq path (file-relative-name path)) (pcase backend (`html (format "%s" path desc)) (`latex (format "\\href{%s}{%s}" path desc)) (`ascii (format "%s (%s)" desc path)) (_ path))))) (defun org-pdfview-open (link _) "Open a \"pdfview\" type link." (string-match "\\(.*?\\)\\(?:::\\([0-9]+\\)\\)?$" link) (let ((path (match-string 1 link)) (page (and (match-beginning 2) (string-to-number (match-string 2 link))))) ;; Let Org mode open the file (in-emacs = 1) to ensure ;; org-link-frame-setup is respected. (org-open-file path 1) (when page (pdf-view-goto-page page)))) (defun org-pdfview-store-link () "Store a \"pdfview\" type link." (when (eq major-mode 'pdf-view-mode) (let* ((path buffer-file-name) (page (pdf-view-current-page)) (link (concat "pdfview:" path "::" (number-to-string page)))) (org-link-store-props :type "pdfview" :link link :description path))))) #+end_src #+caption[Define an =org-link= type for =YouTube=]: #+caption: Define an =org-link= type for =YouTube=. #+name: lst:define-org-yt-link-type #+begin_src emacs-lisp (with-eval-after-load 'ol ;; https://bitspook.in/blog/extending-org-mode-to-handle-youtube-links/ (org-link-set-parameters "yt" :follow #'org-yt-open :export #'org-yt-export) (defun org-yt-open (path prefix) "Open PATH with \"emms\", \"mpv\", or `browse-url' (when PREFIX)." (let ((url (format "https:%s" path))) (cond (prefix (browse-url url)) ((require 'emms nil 'noerror) (emms-add-url url) (with-current-emms-playlist (save-excursion (emms-playlist-last) (emms-playlist-mode-play-current-track))) ) ((executable-find "mpv") (let ((display-buffer-alist `((,shell-command-buffer-name-async . (display-buffer-no-window))))) (async-shell-command (format "\"%s\" \"%s\"" url))) (message "Launched mpv with \"%s\"" url)) (t (user-error "Can't open `%s': install `emms' and/or `mpv'" url))))) (defun org-yt-export (path desc backend _) "Export an \"yt\" link." (pcase backend (`html (let* ((video-id (cadar (url-parse-query-string path))) (url (if (string-empty-p video-id) path (format "//youtube.com/embed/%s" video-id)))) (format (concat "") url desc))) (`latex (format "\\href{https:%s}{%s}" path desc)) (_ path)))) #+end_src #+caption[Patch =ol-info=]: #+caption: Patch =ol-info=. #+name: lst:patch-org-info-link-type #+begin_src emacs-lisp :exports code :results silent (with-eval-after-load 'ol-info (defun org-info-export (path desc format) "Export an info link. See `org-link-parameters' for details about PATH, DESC and FORMAT." (let* ((parts (split-string path "#\\|::")) (manual (car parts)) (node (or (nth 1 parts) "Top"))) (pcase format (`html (format "%s" (org-info-map-html-url manual) (org-info--expand-node-name node) (or desc path))) (`latex (format "\\href{%s\\#%s}{%s}" (org-info-map-html-url manual) (org-info--expand-node-name node) (or desc path))) (`texinfo (let ((title (or desc ""))) (format "@ref{%s,%s,,%s,}" node title manual))) (_ nil))))) #+end_src #+attr_latex: :options breaklines #+caption[Patch buffer local =ol-info=]: #+caption: Patch buffer local =ol-info=. #+name: lst:emacs-lisp-setup-buffer-local-ol-info #+begin_src emacs-lisp :exports code :silent :tangle no (with-eval-after-load 'ol-info (make-variable-buffer-local 'org-info-emacs-documents) (setq org-info-emacs-documents (delete "org" org-info-emacs-documents)) (make-variable-buffer-local 'org-info-other-documents) (setq org-info-other-documents (cl-union '(("consult" . "https://github.com/minad/consult") ("embark" . "https://github.com/oantolin/embark") ("marginalia" . "https://github.com/minad/marginalia") ("maxima" . "https://maxima.sourceforge.io/docs/manual/maxima_singlepage.html") ("org" . "https://orgmode.org/org.html") ("orderless" . "https://github.com/oantolin/orderless") ("sly" . "https://joaotavora.github.io/sly/") ("vertico" . "https://github.com/minad/vertico")) org-info-other-documents :test #'equal))) #+end_src *** [[https://tecosaur.github.io/emacs-config/#translate-capital-keywords][Translate capital keywords (old) to lower case (new)]] :PROPERTIES: :CUSTOM_ID: sec:convert-upper-to-lower-case-keywords :END: #+caption[Convert upper to lower case keywords]: #+caption: Convert upper to lower case keywords. #+name: lst:convert-upper-to-lower-case-keywords #+begin_src emacs-lisp (with-eval-after-load 'emacs ;; https://tecosaur.github.io/emacs-config/#translate-capital-keywords (defun org-syntax-convert-keyword-case-to-lower () "Convert all #+KEYWORDS to #+keywords." (interactive) (when (derived-mode-p 'org-mode) (save-excursion (goto-char (point-min)) (let ((count 0) (case-fold-search nil)) (while (re-search-forward "^[ \t]*#\\+[A-Z_]+" nil t) (unless (s-matches-p "RESULTS" (match-string 0)) (replace-match (downcase (match-string 0)) t) (setq count (1+ count)))) (message "Replaced %d keywords" count)))))) #+end_src *** [[https://lists.gnu.org/archive/html/emacs-orgmode/2016-07/msg00394.html][Evaluate specific source blocks at load-time]] :PROPERTIES: :CUSTOM_ID: sec:load-time-specific-source-block-evaluation :END: [[https://emacs.stackexchange.com/questions/12938/how-can-i-evaluate-elisp-in-an-orgmode-file-when-it-is-opened][How to do load time source block evaluation]] #+caption[Evaluate specific source blocks at load-time]: #+caption: Evaluate specific source blocks at load-time. #+name: lst:load-time-specific-source-block-evaluation #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun org-eval-named-blocks-with-infix (infix) "Evaluate all source blocks having INFIX in their name." (when (eq major-mode 'org-mode) (let ((blocks (org-element-map (org-element-parse-buffer 'greater-element nil) 'src-block (lambda (block) (when-let ((name (org-element-property :name block))) (when (string-match-p infix name) block)))))) (dolist (block blocks) (goto-char (org-element-property :begin block)) (org-babel-execute-src-block))))) (defun org-eval-emacs-lisp-setup-blocks () "Evaluate all source blocks having \"emacs-lisp-setup\" in their name." (interactive) (org-eval-named-blocks-with-infix "emacs-lisp-setup")) (defun org-eval-python-setup-blocks () "Evaluate all source blocks having \"python-setup\" in their name." (interactive) (org-eval-named-blocks-with-infix "python-setup")) ;; Emacs looks for "Local variables:" after the last "newline-formfeed". (add-to-list 'safe-local-eval-forms '(org-eval-emacs-lisp-setup-blocks)) (add-to-list 'safe-local-eval-forms '(org-eval-python-setup-blocks))) #+end_src *** [[info:org#LaTeX header and sectioning][Easy LaTeX preamble editing]] :PROPERTIES: :CUSTOM_ID: sec:easy-latex-preamble-editing :END: There are at least two ways (new and old) to edit the LateX preamble =latex_header= and =latex-extra_header= export options easily in LaTeX source or export blocks. This [[info:org#Top][Org (info)]] file uses the new way, but keeps the old way for backwards compatibility. The new way -- exploiting an idea of [[https://www.matem.unam.mx/~omar/][Omar Antolin Camarena]] -- is to code new [[info:org#Editing Source Code][-modes]] allowing to edit in LaTeX mode and to export to LaTeX code with [[info:org#LaTeX specific export settings][correct LaTeX preamble export setting prefixes]]. Here, are links to three posts exposing his idea: 1. [[https://www.reddit.com/r/orgmode/comments/7u2n0h/tip_for_defining_latex_macros_for_use_in_both/][Export LaTeX macros to LaTeX and HTML/MathJax preambles (reddit)]], 2. [[https://www.reddit.com/r/orgmode/comments/5bi6ku/tip_for_exporting_javascript_source_block_to/][Export JavaScript source blocks to script tags in HTML (reddit)]], 3. [[https://emacs.stackexchange.com/questions/28301/export-javascript-source-block-to-script-tag-in-html-when-exporting-org-file-to][Export JavaScript source blocks to script tags in HTML (SX)]]. Listing [[lst:org-babel-latex-header-blocks]] implements this way by means of two new [[info:org#Editing Source Code][-modes]]: =latex-header= and =latex-extra-header=. #+caption[New =-modes= to edit the LaTeX preamble easily]: #+caption: Add =latex-header= and =latex-extra-header= language modes to edit #+caption: LaTeX preamble =latex_header= and =latex_extra_header= export options #+caption: easily. #+name: lst:org-babel-latex-header-blocks #+begin_src emacs-lisp :exports code :silent (with-eval-after-load 'emacs (defun prefix-all-lines (prefix body) (with-temp-buffer (insert body) (string-insert-rectangle (point-min) (point-max) prefix) (buffer-string))) (defun org-babel-execute:latex-extra-header (body _params) "Execute a block of LaTeX extra header lines with org-babel. This function is called by `org-babel-execute-src-block' and prefixes all lines with \"#+latex_extra_header: \"." (prefix-all-lines "#+latex_extra_header: " body)) (defun org-babel-execute:latex-header (body _params) "Execute a block of LaTeX header lines with org-babel. This function is called by `org-babel-execute-src-block' and prefixes all lines with \"#+latex_header: \"." (prefix-all-lines "#+latex_header: " body)) (defvar org-babel-default-header-args:latex-extra-header '((:exports . "results") (:results . "raw"))) (defvar org-babel-default-header-args:latex-header '((:exports . "results") (:results . "raw"))) (with-eval-after-load 'org-src (custom-set-variables '(org-src-window-setup 'current-window)) (add-to-list 'org-src-lang-modes '("toml" . conf-toml)) (add-to-list 'org-src-lang-modes '("latex-header" . latex)) (add-to-list 'org-src-lang-modes '("latex-extra-header" . latex)))) #+end_src The old way is to use a special export attribute as in the function =org-latex-header-blocks-filter= in [[https://git.sr.ht/~bzg/org-contrib/tree/master/item/lisp/ox-extra.el][ox-extra.el]]. Apparently, nobody is using this broken function (broken, since it relies on support only in org-mode before =2014-11-11=). Listing [[lst:org-latex-header-blocks-filter]] proposes a fix for =org-latex-header-blocks-filter=. #+caption[Convert marked LaTeX export blocks to LaTeX header lines]: #+caption: Convert marked LaTeX export blocks to LaTeX header lines. #+name: lst:org-latex-header-blocks-filter #+begin_src emacs-lisp (with-eval-after-load 'ox (defun org-latex-header-blocks-filter (backend) "Convert marked LaTeX export blocks to \"#+latex_header: \" lines. The marker is a line \"#+header: :header yes\" preceding the block. For instance, the LaTeX export block ,#+header: :header yes ,#+begin_export latex % This line converts to a LaTeX header line. ,#+end_export converts to \"#+latex_header: % This line converts to a LaTeX header line.\"." (when (org-export-derived-backend-p backend 'latex) (let ((blocks (org-element-map (org-element-parse-buffer 'greater-element nil) 'export-block (lambda (block) (let ((type (org-element-property :type block)) (header (org-export-read-attribute :header block :header))) (when (and (string= type "LATEX") (string= header "yes")) block)))))) (mapc (lambda (block) ;; Set point to where to insert LaTeX header lines ;; after deleting the block. (goto-char (org-element-property :post-affiliated block)) (let ((lines (split-string (org-element-property :value block) "\n"))) (delete-region (org-element-property :begin block) (org-element-property :end block)) (dolist (line lines) (insert (concat "#+latex_header: " (replace-regexp-in-string "\\` *" "" line) "\n"))))) ;; Reverse to go upwards to avoid wrecking the list of ;; block positions in the file that would occur in case ;; of going downwards. (reverse blocks))))) ;; Push the filter on the hook. (cl-pushnew #'org-latex-header-blocks-filter org-export-before-parsing-hook)) #+end_src This file uses the new way, while keeping the old way for backwards compatibility, because the new way feels less hackish than the old way. A practical difference is that new way source blocks (contrary to old way export blocks) do not work in [[info:org#Export Settings][#+SETUPFILE: ]], but only in [[info:org#Export Settings][#+INCLUDE: ]] files. *** [[info:org#Export Settings][#+INCLUDE: (info)]] :PROPERTIES: :CUSTOM_ID: sec:include-file-usage :END: Listing [[lst:source-file-export-keyword-settings]] shows the preamble lines of this [[file:README.org]] file. The last line shows that [[file:include.org][include.org]] is the argument for [[info:org#Export Settings][#+INCLUDE: ]]. #+caption[Source file export keyword settings]: #+caption: The preamble lines of README.org containing the export keyword #+caption: settings. #+name: lst:source-file-export-keyword-settings #+include: "README.org" src org :lines "1-11" Listing [[lst:by-backend-kbd-org-macro]] defines the tools for the definition of the [[https://orgmode.org/][Org mode]] =kbd= macro on the fifth line of listing [[lst:source-file-export-keyword-settings]]. #+attr_latex: :options breaklines #+caption[Define the tools of the =Org-mode= =kbd= macro]: #+caption: Define the tools for the =Org-mode= =kbd= macro. #+name: lst:by-backend-kbd-org-macro #+begin_src emacs-lisp (with-eval-after-load 'emacs (when (ensure-package-installation 'htmlize) (autoload 'htmlize-protect-string "htmlize" nil t)) ;; https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-LaTeX.html (defmacro by-backend (&rest body) "Help for org-export backend dependent execution." `(cl-case ',(bound-and-true-p org-export-current-backend) ,@body)) (defun by-backend-kbd-org-macro (keys) "Help for an org-export backend dependent \"#+macro: kbd\"." (by-backend (html (format "@@html:%s@@" (htmlize-protect-string keys))) (latex (format "@@latex:\\colorbox{PowderBlue}{\\texttt{%s}}@@" keys))))) #+end_src Listing [[lst:use-latex-header-1]], [[lst:use-latex-header-2]], [[lst:use-latex-header-3]], [[lst:use-latex-header-4]], and [[lst:use-latex-header-5]] tangle into the [[file:include.org][include.org]] file in order to create the [[https://www.latex-project.org/][LaTeX]] preamble. #+caption[LaTeX preamble: replacing the =Org-mode= default packages]: #+caption: LaTeX preamble: replacing the =Org-mode= default packages. #+name: lst:use-latex-header-1 #+begin_src org ,#+begin_src latex-header % LuaLaTeX-, PdfLaTeX-, or XeTeX-COMPILER COMPATIBILITY: % Prevent collisions by using font packages before compiler specific packages. \usepackage{ifthen,ifluatex,ifxetex} \ifthenelse{\boolean{luatex}}{ \usepackage{fontspec} % lualatex }{\ifthenelse{\boolean{xetex}}{ \usepackage{mathspec} % xetex }{ \usepackage[T1]{fontenc} % pdflatex \usepackage[utf8]{inputenc} % pdflatex } } \usepackage{amsmath} \usepackage{amssymb} \usepackage{pifont} % check mark (\ding{52}) and cross mark (\ding{56}) \usepackage{textcomp} % \texttimes \usepackage{wasysym} % \diameter % Org-mode REQUIREMENTS: \usepackage{graphicx} \usepackage{longtable} \usepackage{wrapfig} \usepackage{rotating} \usepackage[normalem]{ulem} \usepackage{capt-of} \usepackage{hyperref} ,#+end_src #+end_src #+caption[LaTeX preamble: language, lists and floats]: #+caption: LaTeX preamble: language, lists and floats. #+name: lst:use-latex-header-2 #+begin_src org ,#+begin_src latex-header % LANGUAGE: \usepackage{babel} \usepackage{fvextra} \usepackage{csquotes} % LISTS: \usepackage{enumitem} \setlist{noitemsep} % LISTINGS: % Section 2.6 of caption-eng.pdf (texdoc caption) explains that the sign % of "skip" depends on the assumption "position=above" or "position=below". % The assumption should match the real caption position in the LaTeX code. \usepackage{caption} \usepackage[newfloat]{minted} \captionsetup[listing]{position=below,skip=0em} \usemintedstyle{xcode} % TABLES: % https://tex.stackexchange.com/questions/341205/ % what-is-the-difference-between-tabular-tabular-and-tabularx-environments % https://emacs.stackexchange.com/questions/26179/ % change-org-mode-table-style-just-for-latex-export % https://tex.stackexchange.com/questions/468585/ % table-formatting-using-siunitx \usepackage{booktabs} \usepackage{colortbl} \usepackage{tabularx} % DANGER: beware of Org table :width and :align options! ,#+end_src #+end_src #+caption[LaTeX preamble: page layout]: #+caption: LaTeX preamble: page layout. #+name: lst:use-latex-header-3 #+begin_src org ,#+begin_src latex-header % PAGE LAYOUT: \usepackage{fancyhdr} \usepackage{lastpage} \usepackage[ headheight=20mm, top=40mm, bottom=20mm, left=0.1\paperwidth, right=0.1\paperwidth, heightrounded, verbose, ]{geometry} % TECHNICS: \usepackage{siunitx} \usepackage{tikz} ,#+end_src #+end_src #+caption[LaTeX preamble: float barriers]: #+caption: LaTeX preamble: float barriers. #+name: lst:use-latex-header-4 #+begin_src org ,#+begin_src latex-header % FLOAT BARRIERS: % https://tex.stackexchange.com/questions/118662/use-placeins-for-subsections % Make section an implicit float barrier: \usepackage[section]{placeins} % Make subsection an implicit float barrier: \makeatletter \AtBeginDocument{% \expandafter\renewcommand\expandafter\subsection\expandafter{% \expandafter\@fb@secFB\subsection }% } \makeatother % Make subsubsection an implicit float barrier: \makeatletter \AtBeginDocument{% \expandafter\renewcommand\expandafter\subsubsection\expandafter{% \expandafter\@fb@secFB\subsubsection }% } \makeatother ,#+end_src #+end_src #+caption[LaTeX preamble: fancy headers and footers]: #+caption: LaTeX preamble: fancy headers and footers. #+name: lst:use-latex-header-5 #+begin_src org ,#+begin_src latex-header % FANCY HEADERS AND FOOTERS: % Add fancy headers and footers to normal pages. \pagestyle{fancy} \fancyhf{} \renewcommand{\footrulewidth}{0.4pt} \fancyfoot[C]{\emph{ Emacs setup for use with \LaTeX{}, Org, and Python -- Gerard Vermeulen}} \renewcommand{\headrulewidth}{0.4pt} \fancyhead[L]{\includegraphics[height=1.8cm]{Org-mode-unicorn.png}} \fancyhead[C]{ Page: \thepage/\pageref{LastPage} \\ \text{ } \\ \text{ } \\ DRAFT } \fancyhead[R]{\includegraphics[height=1.8cm]{Emacs-logo.png}} % Add fancy header and footer to custom titlepage. % https://tex.stackexchange.com/questions/506102/ % adding-header-and-footer-to-custom-titlepage \fancypagestyle{titlepage}{% \fancyhf{} \renewcommand{\footrulewidth}{0.4pt} \fancyfoot[C]{\emph{ Emacs setup for use with \LaTeX{}, Org, and Python -- Gerard Vermeulen}} \renewcommand{\headrulewidth}{0.4pt} \fancyhead[L]{\includegraphics[height=1.8cm]{Org-mode-unicorn.png}} \fancyhead[C]{ \pageref{LastPage} pages \\ \text{ } \\ \text{ } \\ DRAFT } \fancyhead[R]{\includegraphics[height=1.8cm]{Emacs-logo.png}} } % #+latex_header: END. ,#+end_src #+end_src *** [[info:org#LaTeX specific export settings][Advanced LaTeX export settings]] :PROPERTIES: :CUSTOM_ID: sec:advanced-latex-export-settings :END: Listing [[lst:ox-latex-emacs-lisp-setup]] initializes the buffer local variables =org-latex-classes=, =org-latex-title-command=, =org-latex-toc-command=, and =org-latex-subtitle-format=. Listing [[lst/title-page]] is a template to initialize =org-latex-title-command=. Type {{{kbd(C-h v org-latex-classes)}}}, {{{kbd(C-h v org-latex-subtitle-format)}}}, {{{kbd(C-h v org-latex-title-command)}}}, and {{{kbd(C-h v org-latex-toc-command)}}} to read how those variables control exporting from Org-mode to LaTeX. #+caption[Define buffer local =ox-latex= variables]: #+caption: Define buffer local =-ox-latex= variables. #+header: :var title-page=lst/title-page #+name: lst:ox-latex-emacs-lisp-setup #+begin_src emacs-lisp :results silent :tangle no (when (require 'ox-latex nil 'noerror) ;; https://emacs.stackexchange.com/questions/47347/ ;; customizing-org-latex-title-command-to-edit-title-page (make-variable-buffer-local 'org-latex-classes) (cl-pushnew '("article-local" "\\documentclass[11pt]{article} [NO-DEFAULT-PACKAGES] [PACKAGES] [EXTRA]" ("\\section{%s}" . "\\section*{%s}") ("\\subsection{%s}" . "\\subsection*{%s}") ("\\subsubsection{%s}" . "\\subsubsection*{%s}") ("\\paragraph{%s}" . "\\paragraph*{%s}") ("\\subparagraph{%s}" . "\\subparagraph*{%s}")) org-latex-classes :key #'car :test #'equal) (make-variable-buffer-local 'org-latex-title-command) (setq org-latex-title-command (concat title-page)) (make-variable-buffer-local 'org-latex-toc-command) (setq org-latex-toc-command " \\tableofcontents\\label{toc} \\listoflistings \\listoftables \\newpage ") (make-variable-buffer-local 'org-latex-subtitle-format) (setq org-latex-subtitle-format "")) #+end_src #+caption[Show a title-page example for =org-latex-title-command=]: #+caption: Show a title-page example for =org-latex-title-command=. #+name: lst/title-page #+begin_src latex :exports code :results silent :tangle no \begin{titlepage} %% https://tex.stackexchange.com/questions/506102/ %% adding-header-and-footer-to-custom-titlepage \thispagestyle{titlepage} \begin{center} %% Title \begin{Huge} {\bf %t} \\ \vspace{1em} \end{Huge} %% Author \begin{Large} {\bf %a} \\ \vspace{1em} \end{Large} \end{center} \end{titlepage} #+end_src *** [[https://orgmode.org/worg/dev/org-syntax-edited.html][Org Syntax]] :PROPERTIES: :CUSTOM_ID: sec:org-syntax :END: Two tools to grok how [[https://orgmode.org/worg/dev/org-element-api.html][Org mode parsing]] works are the [[https://orgmode.org/worg/dev/org-syntax-edited.html][Org Syntax]] specification and the [[http://xahlee.info/emacs/emacs/elisp_parse_org_mode.html][Org mode parser tutorial]]. The [[https://orgmode.org/worg/dev/org-element-api.html][Org element parsing API]] boils down to three functions: 1. The function [[https://orgmode.org/worg/dev/org-element-api.html#global][~org-element-parse-buffer~]] implements a fully recursive buffer parser that returns an abstract syntax tree. 2. The functions [[https://orgmode.org/worg/dev/org-element-api.html#local][~org-element-at-point~ and ~org-element-context~]] return information on the document structure around point either at the element level or at the object level in case of ~org-element-context~. Listing [[lst:grok-org-element-tree]] improves the [[http://xahlee.info/emacs/emacs/elisp_parse_org_mode.html][Org mode parser tutorial]] by defining interactive wrappers that pretty print the results of those non-interactive =org-element= functions to an =Emacs-lisp= buffer. #+caption[Grok how =org-element= parses your document]: #+caption: Grok how =org-element= parses your document. #+name: lst:grok-org-element-tree #+begin_src emacs-lisp (with-eval-after-load 'org-element (when (require 'pp nil 'noerror) (defconst grok-org-output "*Grok Org Element Output*" "Grok Org output buffer name.") (defun grok-org-element-at-point () (interactive) (pp-display-expression (org-element-at-point) grok-org-output)) (defun grok-org-element-context () (interactive) (pp-display-expression (org-element-context) grok-org-output)) (defun grok-org-element-parse-buffer () (interactive) (let ((what (completing-read "granularity: " '(headline element greater-element object) nil 'require-match))) (pp-display-expression (org-element-parse-buffer what) grok-org-output))) (defun grok-org-heading-components () (interactive) (pp-display-expression (org-heading-components) grok-org-output)))) #+end_src ** Grammar, spelling, and style tools :PROPERTIES: :CUSTOM_ID: sec:writing-tools :END: *** [[info:emacs#Abbrevs][Abbrevs (info)]] :PROPERTIES: :CUSTOM_ID: sec:writing-abbreviations :END: [[https://www.masteringemacs.org/][Mickey Peterson]] has posted [[https://www.masteringemacs.org/article/correcting-typos-misspellings-abbrev][Correcting Typos and Misspellings with Abbrev]] showing how to use [[info:emacs#Keyboard Macros][Keyboard Macros (info)]] to exploit [[https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines][Wikipedia's list of common misspellings for machines]]. Listing [[lst:misspellings-abbrev]] defines his keyboard macro under the name =misspellings-abrev=. I have used those directions to define src_emacs-lisp{global-abbrev-table} and to store it in src_emacs-lisp{abbrev-file-name} for git management. I can change the abbreviation definitions in this file by means of: 1. Execute src_emacs-lisp{(edit-abbrevs)} to alter abbreviation definitions by editing an =*Abbrevs*= buffer. 2. Add, edit, or remove definitions of the form ="source" 1 "target"= under the global or a mode-specific table. 3. Execute src_emacs-lisp{(abbrev-edit-save-buffer)} to save all user abbreviation definitions in the current buffer. #+caption[Definition of the =misspellings-abbrev= keyboard macro]: #+caption: Definition of the =misspellings-abbrev= keyboard macro. #+name: lst:misspellings-abbrev #+begin_src emacs-lisp (with-eval-after-load 'emacs (fset 'misspellings-abbrev (kmacro-lambda-form [?\C-s ?- ?> return backspace backspace ?\C-k ?\C-x ?a ?i ?g ?\C-y return] 0 "%d")) (setq-default abbrev-mode t)) #+end_src Listing [[lst:word-games]] defines the =anagram-p= function that migth be used for a better exploitation of [[https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines][Wikipedia's list of common misspellings for machines]] in the future. #+caption[Better parsing of the common misspellings list]: #+caption: Better parsing of the common misspellings list. #+name: lst:better-misspellings #+begin_src emacs-lisp (with-eval-after-load 'emacs (defun browse-common-misspellings () "Open the Wikipedia page of common misspellings for machines in EWW." (interactive) (eww (concat "https://en.wikipedia.org/wiki/Wikipedia" ":Lists_of_common_misspellings/For_machines"))) (defun wordnet-check (word) "Check whether WORD occurs in the wordnet lexical database." (cl-destructuring-bind (exit-code output) (shell-command-with-exit-code "wn" word "-grepn" "-grepv" "-grepa" "-grepr") (if (= 0 exit-code) (< 0 (length (string-trim output))) (error "%s" (string-trim output))))) (defun better-misspellings () "Pick the best from each common misspelling multiple choice of corrections." (interactive) (let (start end lines) (save-excursion (if (re-search-forward (rx bol "abandon")) (setq start (match-beginning 0)) (user-error "Failed to find beginning of misspellings")) (if (re-search-forward (rx bol "Retrieved from")) (setq end (match-beginning 0)) (user-error "Failed to find end of misspellings"))) (dolist (line (split-string (buffer-substring-no-properties start end) "\n")) (pcase-let ((`(,lhs . (,rhs . ,rest)) (split-string line "->"))) (when (and (stringp rhs) (string-match ", " rhs)) (message "%s -> %s" lhs rhs) (let ((words (split-string rhs ", ")) (stack)) (dolist (word words) (when (wordnet-check word) (message "wordnet finds: %s" word) (push word stack)))))))))) #+end_src #+caption[Word games]: #+caption: Word games. #+name: lst:word-games #+begin_src emacs-lisp ;; https://funcall.blogspot.com/2022/07/lets-play-wordle.html ;; https://github.com/tabatkins/wordle-list (defun anagram-p (evil vile) "Check whether strings EVIL and VILE are anagrams of each other." (if (string= evil vile) nil (string= (cl-sort evil #'<) (cl-sort vile #'<)))) ;; https://funcall.blogspot.com/2020/01/palindromes-redux-and-sufficiently.html ;; https://irreal.org/blog/?p=8570 (defun palindrome-p (word) "Check whether the string WORD is a palindrome." (cl-do ((head 0 (1+ head)) (tail (1- (length word)) (1- tail)) (ok t)) ((or (not ok) (>= head tail) ok) (setq ok (= (aref word head) (aref word tail)))))) #+end_src *** [[https://dict.org/bin/Dict][DICT.org]] :PROPERTIES: :CUSTOM_ID: sec:writing-dict :END: Evaluating src_emacs-lisp{(dictionary)} connects to a local or remote =dictd= server. The following links explain how to configure and use =dictd=: 1. [[https://jpmens.net/2020/03/08/looking-up-words-with-dict/][Looking up words with DICT]] 2. [[https://www.rfc-editor.org/rfc/rfc2229.html][RFC 2229: A Dictionary Server Protocol]] 3. [[https://www.masteringemacs.org/article/wordsmithing-in-emacs][Wordsmithing in Emacs]] I am using the following Debian Bullseye dictionaries on Darwin and Gentoo: 1. [[http://ftp.fr.debian.org/debian/pool/main/d/dict-gcide/dict-gcide_0.48.5+nmu1_all.deb][dict-gcide_0.48.5+nmu1_all.deb]] 2. [[http://ftp.fr.debian.org/debian/pool/main/d/dict-devil/dict-devil_1.0-13.1_all.deb][dict-devil_1.0-13.1_all.deb]] 3. [[http://ftp.fr.debian.org/debian/pool/main/d/dict-foldoc/dict-foldoc_20201018-1_all.deb][dict-foldoc_20201018-1_all.deb]] 4. [[http://ftp.fr.debian.org/debian/pool/main/d/dict-jargon/dict-jargon_4.4.7-3.1_all.deb][dict-jargon_4.4.7-3.1_all.deb]] 5. [[http://ftp.fr.debian.org/debian/pool/main/v/vera/dict-vera_1.24-1_all.deb][dict-vera_1.24-1_all.deb]] 6. [[http://ftp.fr.debian.org/debian/pool/main/w/wordnet/dict-wn_3.0-36_all.deb][dict-wn_3.0-36_all.deb]] #+caption[Resource file for =dict= on =Darwin=]: #+caption: Resource file for =dict= on =Darwin=. #+name: lst:darwin-dict-resource-file #+header: :tangle (if (eq 'darwin system-type) "~/.dictrc" "no") #+begin_src conf # https://jpmens.net/2020/03/08/looking-up-words-with-dict/ server 127.0.0.1 { port 2628 } # Local Variables: # mode: conf-unix # End: #+end_src #+caption[Make a configuration file for =dictd= on =Darwin=]: #+caption: Make a configuration file for =dictd= on =Darwin=. #+name: lst:dictd-configuration-file #+begin_src shell :eval (if (eq 'darwin system-type) "yes" "never") :results silent cat > ~/.dictd.conf <