Fixes TeX module for Emacs

Adds support for changing the org and tex config file path. Also makes
extra packages needed by org and tex customizable outside of the
module definition.

Additionally this makes the launchd service for Emacs on darwin use
the finalPackge output instead of package. This improves compatibility
with existing home-manager modules as well as my additions for
controlling whether or not org and tex are configured.
This commit is contained in:
willemml 2023-11-08 13:32:52 -08:00
parent 5689e42246
commit a7c69788b0
Signed by: willemml
GPG key ID: C3DE5DF6198DACBD
9 changed files with 343 additions and 326 deletions

View file

@ -0,0 +1,47 @@
{
pkgs,
lib,
config,
...
}: let
inherit (lib.types) path str anything either package listOf;
inherit (lib) mkIf mkEnableOption mkOption;
cfg = config.programs.emacs;
configFileOption = mkOption {
type = either path str;
default = "";
};
fileFromPathOrText = input:
if (builtins.typeOf input) == "path"
then {
source = input;
}
else {
text = input;
};
in {
options.programs.emacs = {
enableOrgTex = mkEnableOption "Enable Emacs Org and LaTeX configuration";
texPackages = mkOption {
type = listOf package;
default = [];
};
texEmacsPackages = lib.mkOption {
type = anything;
default = epkgs: [];
};
orgTexConfigFile = configFileOption;
initFile = configFileOption;
earlyInitFile = configFileOption;
};
config = {
home.packages = mkIf cfg.enableOrgTex cfg.texPackages;
programs.emacs.extraPackages = mkIf cfg.enableOrgTex cfg.texEmacsPackages;
home.file.".emacs.d/org-tex-cfg.el" = mkIf cfg.enableOrgTex (fileFromPathOrText cfg.orgTexConfigFile);
home.file.".emacs.d/early-init.el" = fileFromPathOrText cfg.earlyInitFile;
home.file.".emacs.d/init.el" = fileFromPathOrText cfg.initFile;
};
}

View file

@ -1,287 +0,0 @@
{
pkgs,
lib,
config,
...
}: let
enabled = config.custom.enableOrgTex;
in {
options.custom.enableOrgTex = lib.mkEnableOption "Enable Emacs Org and LaTeX configuration";
config = lib.mkIf enabled (let
aspellPackage = pkgs.aspellWithDicts (d: [d.en d.en-science d.en-computers d.fr]);
texliveset = pkgs.texlive.combine {
inherit
(pkgs.texlive)
scheme-basic
babel
amscls
amsmath
biber
biblatex
biblatex-mla
block
cancel
caption
capt-of
csquotes
enotez
enumitem
etex
etoolbox
fancyhdr
float
fontaxes
graphics
hanging
hyperref
latex
latexindent
latexmk
logreq
metafont
mlacls
newtx
pdflscape
pdfpages
preprint
psnfss
ragged2e
titlesec
tools
translations
ulem
url
wrapfig
xstring
xkeyval
;
};
in {
home.packages = with pkgs; [
texliveset
aspellPackage
gnuplot
plantuml
];
programs.emacs.extraPackages = let
org-auctex = pkgs.emacsPackages.trivialBuild rec {
pname = "org-auctex";
version = "e1271557b9f36ca94cabcbac816748e7d0dc989c";
buildInputs = [pkgs.emacsPackages.auctex];
src = pkgs.fetchFromGitHub {
owner = "karthink";
repo = pname;
rev = version;
sha256 = "sha256-cMAhwybnq5HA1wOaUqDPML3nnh5m1iwEETTPWqPbAvw=";
};
};
in (with pkgs.emacsPackages; [
org-auctex
auctex
cdlatex
citeproc
graphviz-dot-mode
ivy-bibtex
gnuplot
htmlize
org-auctex
org-contrib
org-download
pdf-tools
plantuml-mode
]);
home.file.".emacs.d/org-init.el".text =
/*
elisp
*/
''
(require 'cdlatex)
(require 'citeproc)
(require 'gnuplot)
(require 'gnuplot-context)
(require 'graphviz-dot-mode)
(require 'htmlize)
(require 'ivy-bibtex)
(require 'ob-dot)
(require 'ob-emacs-lisp)
(require 'ob-gnuplot)
(require 'ob-matlab)
(require 'ob-python)
(require 'ob-shell)
(require 'oc)
(require 'oc-basic)
(require 'oc-csl)
(require 'oc-natbib)
(require 'org-auctex)
(require 'org-contrib)
(require 'org-download)
(require 'ox-latex)
(require 'ox-publish)
(require 'pdf-tools)
(require 'plantuml-mode)
(require 'tex)
(autoload 'gnuplot-mode "gnuplot" "Gnuplot major mode" t)
(autoload 'gnuplot-make-buffer "gnuplot" "open a buffer in gnuplot-mode" t)
(setq auto-mode-alist (append '(("\\.gp$" . gnuplot-mode)) auto-mode-alist))
(define-key graphviz-dot-mode-map (kbd "C-c C-y") 'graphviz-dot-indent-graph)
(defvar zotero-bibliography (expand-file-name "zotero.bib" org-directory))
(defvar ivy-bibtex-bibliography (list zotero-bibliography))
(setq reftex-default-bibliography (list zotero-bibliography))
(setq bibtex-completion-pdf-field "file")
(add-hook 'LaTeX-mode-hook 'turn-on-cdlatex)
(add-hook 'LaTeX-mode (lambda ()
(turn-on-reftex)))
(setq TeX-PDF-mode t
TeX-auto-save t
TeX-parse-self t)
(setq org-babel-octave-shell-command "octave -q")
(setq org-babel-python-command "python3.10")
(setq-default python-indent-guess-indent-offset-verbose nil)
(defun my/org-babel-execute:python-session (body params)
"Initiate a python session before executing org babel blocks that use sessions.
BODY is the content of the org-babel block and PARAMS are any parameters specified."
(let ((session-name (cdr (assq :session params))))
(when (not (eq session-name "none"))
(org-babel-python-initiate-session session-name))))
(advice-add #'org-babel-execute:python :before #'my/org-babel-execute:python-session)
(defun my/indent-org-block-automatically ()
"Indent the current org code block."
(interactive)
(when (org-in-src-block-p)
(org-edit-special)
(indent-region (point-min) (point-max))
(org-edit-src-exit)))
(defun my/org-force-open-current-window ()
"Open a link using 'org-open-at-point' in current window."
(interactive)
(let ((org-link-frame-setup
(quote
((vm . vm-visit-folder)
(vm-imap . vm-visit-imap-folder)
(gnus . gnus)
(file . find-file)
(wl . wl)))
))
(org-open-at-point)))
(defun my/follow-org-link (arg)
"Follow a link in orgmode If ARG is given.
Opens in new window otherwise opens in current window."
(interactive "P")
(if arg
(org-open-at-point)
(my/org-force-open-current-window)))
(defun krofna-hack ()
"Toggle latex fragments after exiting closing them."
(when (looking-back (rx "$ "))
(save-excursion
(backward-char 1)
(org-latex-preview))))
(global-set-key (kbd "C-c n a") 'org-agenda)
(setq org-agenda-start-on-weekday nil)
(define-key org-mode-map (kbd "C-c C-o") 'my/follow-org-link)
(define-key org-mode-map (kbd "C-c C-y") 'my/indent-org-block-automatically)
(define-key org-mode-map (kbd "C-c ]") 'org-cite-insert)
(add-hook 'org-babel-after-execute-hook 'org-redisplay-inline-images)
(add-hook 'org-mode-hook 'visual-line-mode)
(add-hook 'org-mode-hook 'org-cdlatex-mode)
(add-hook 'org-mode-hook
(lambda ()
(add-hook 'post-self-insert-hook #'krofna-hack 'append 'local)))
(add-to-list 'org-latex-classes
'("mla"
"\\documentclass{mla}"
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
("\\paragraph{%s}" . "\\paragraph*{%s}")
("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
(add-to-list 'org-latex-classes
'("letter"
"\\documentclass{letter}"
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
(plist-put org-format-latex-options :scale 3)
(setq org-agenda-files (list org-directory (expand-file-name "ubc" org-directory)))
(setq org-agenda-tags-column 0)
(setq org-auto-align-tags nil)
(setq org-fold-catch-invisible-edits 'show-and-error)
(setq org-cite-export-processors '((t basic)))
(setq org-cite-global-bibliography (list zotero-bibliography))
(setq org-confirm-babel-evaluate nil)
(setq org-ellipsis "")
(setq org-export-with-tags nil)
(setq org-hide-emphasis-markers t)
(setq org-highlight-latex-and-related '(latex))
(setq org-html-head-include-default-style nil)
(setq org-html-head-include-scripts nil)
(setq org-html-validation-link nil)
(setq org-image-actual-width 300)
(setq org-insert-heading-respect-content t)
(setq org-latex-pdf-process '("latexmk -pdflatex='pdflatex -interaction nonstopmode' -pdf -bibtex -f %f"))
(setq org-pretty-entities t)
(setq org-preview-latex-default-process 'dvisvgm)
(setq org-special-ctrl-a/e t)
(setq org-src-fontify-natively t)
(setq org-src-preserve-indentation t)
(setq org-src-tab-acts-natively t)
(setq org-src-window-setup 'current-window)
(setq org-tags-column 0)
(setq org-agenda-time-grid
'((daily today require-timed)
(800 1000 1200 1400 1600 1800 2000)
" " ""))
(setq org-exports-dir (expand-file-name "exports" org-directory))
(setq org-publish-project-alist
(list (cons "html"
(list :base-directory org-directory
:base-extension "org"
:htmlized-source t
:recursive t
:publishing-directory org-exports-dir
:publishing-function 'org-html-publish-to-html))
(cons "pdf"
(list :base-directory org-directory
:base-extension "org"
:recursive t
:publishing-directory org-exports-dir
:publishing-function 'org-latex-publish-to-pdf))
(cons "all" '(:components ("html" "pdf")))))
(add-hook 'org-mode-hook 'org-auctex-mode)
(add-hook 'dired-mode-hook 'org-download-enable)
(setq-default org-download-image-dir (expand-file-name "images" org-directory))
(add-hook 'org-mode-hook 'org-modern-mode)
(setq-default pdf-view-display-size 'fit-width)
(defvar pdf-annot-activate-created-annotations t)
(setq plantuml-default-exec-mode 'executable)
'';
});
}

View file

@ -24,8 +24,6 @@ in rec {
};
};
custom.enableOrgTex = lib.mkDefault true;
home.file = {
".config/nixpkgs/config.nix".text = ''
# -*-nix-*-

View file

@ -13,7 +13,7 @@ in {
enable = true;
config = {
ProgramArguments = [
"${config.programs.emacs.package}/bin/emacs"
"${config.programs.emacs.finalPackage}/bin/emacs"
"--fg-daemon"
];
KeepAlive = true;

View file

@ -75,7 +75,6 @@ in {
sqlite
stylua
texinfo
texliveset
tldr
units
unp

View file

@ -1,11 +1,17 @@
{
config,
pkgs,
lib,
...
}: let
emacsPackage =
(pkgs.emacsPackagesFor pkgs.emacs29).emacsWithPackages
(epkgs:
}: {
programs.emacs = {
earlyInitFile = ./early-init.el;
initFile = ./init.el;
enable = true;
package = pkgs.emacs29;
extraPackages = epkgs:
(with epkgs; let
company-mode = epkgs.trivialBuild rec {
pname = "company-mode";
@ -18,23 +24,6 @@
sha256 = "sha256-6aX2S4cUop1rdxweIF5f1qrgNmYd1mtWgT9T1Q1s2h8=";
};
};
lean4-mode = epkgs.trivialBuild rec {
pname = "lean4-mode";
version = "d1c936409ade7d93e67107243cbc0aa55cda7fd5";
buildInputs = [epkgs.dash epkgs.f epkgs.magit-section epkgs.lsp-mode epkgs.s epkgs.flycheck];
postInstall = ''
cp -r data $out/share/emacs/site-lisp/data
'';
src = pkgs.fetchFromGitHub {
owner = "leanprover";
repo = pname;
rev = version;
sha256 = "sha256-tD5Ysa24fMIS6ipFc50OjabZEUge4riSb7p4BR05ReQ=";
};
};
in [
all-the-icons
all-the-icons-dired
@ -48,9 +37,7 @@
flycheck
format-all
ivy
lean4-mode
lsp-mode
lua-mode
magit
magit-section
meow
@ -70,16 +57,10 @@
])
++ (with pkgs; [
sqlite
]));
in {
home.file.".emacs.d/early-init.el".source = ./early-init.el;
home.file.".emacs.d/init.el".source = ./init.el;
]);
};
programs.emacs.enable = true;
programs.emacs.package = emacsPackage;
services.emacs = pkgs.lib.mkIf pkgs.stdenv.isLinux {
services.emacs = lib.mkIf pkgs.stdenv.isLinux {
enable = true;
client.enable = true;
startWithUserSession = true;

View file

@ -67,7 +67,6 @@
(require 'eglot)
(require 'format-all)
(require 'ivy)
(require 'lean4-mode)
(require 'magit)
(require 'meow)
(require 'nix-mode)
@ -80,7 +79,7 @@
(require 'swiper)
(require 'yasnippet)
(let ((org-config (expand-file-name "~/.emacs.d/org-init.el")))
(let ((org-config (expand-file-name "~/.emacs.d/org-tex-cfg.el")))
(when (file-exists-p org-config)
(load-file org-config))
)

View file

@ -0,0 +1,183 @@
(require 'cdlatex)
(require 'citeproc)
(require 'gnuplot)
(require 'gnuplot-context)
(require 'graphviz-dot-mode)
(require 'htmlize)
(require 'ivy-bibtex)
(require 'ob-dot)
(require 'ob-emacs-lisp)
(require 'ob-gnuplot)
(require 'ob-matlab)
(require 'ob-python)
(require 'ob-shell)
(require 'oc)
(require 'oc-basic)
(require 'oc-csl)
(require 'oc-natbib)
(require 'org-auctex)
(require 'org-contrib)
(require 'org-download)
(require 'ox-latex)
(require 'ox-publish)
(require 'pdf-tools)
(require 'plantuml-mode)
(require 'tex)
(autoload 'gnuplot-mode "gnuplot" "Gnuplot major mode" t)
(autoload 'gnuplot-make-buffer "gnuplot" "open a buffer in gnuplot-mode" t)
(setq auto-mode-alist (append '(("\\.gp$" . gnuplot-mode)) auto-mode-alist))
(define-key graphviz-dot-mode-map (kbd "C-c C-y") 'graphviz-dot-indent-graph)
(defvar zotero-bibliography (expand-file-name "zotero.bib" org-directory))
(defvar ivy-bibtex-bibliography (list zotero-bibliography))
(setq reftex-default-bibliography (list zotero-bibliography))
(setq bibtex-completion-pdf-field "file")
(add-hook 'LaTeX-mode-hook 'turn-on-cdlatex)
(add-hook 'LaTeX-mode (lambda ()
(turn-on-reftex)))
(setq TeX-PDF-mode t
TeX-auto-save t
TeX-parse-self t)
(setq org-babel-octave-shell-command "octave -q")
(setq org-babel-python-command "python3.10")
(setq-default python-indent-guess-indent-offset-verbose nil)
(defun my/org-babel-execute:python-session (body params)
"Initiate a python session before executing org babel blocks that use sessions.
BODY is the content of the org-babel block and PARAMS are any parameters specified."
(let ((session-name (cdr (assq :session params))))
(when (not (eq session-name "none"))
(org-babel-python-initiate-session session-name))))
(advice-add #'org-babel-execute:python :before #'my/org-babel-execute:python-session)
(defun my/indent-org-block-automatically ()
"Indent the current org code block."
(interactive)
(when (org-in-src-block-p)
(org-edit-special)
(indent-region (point-min) (point-max))
(org-edit-src-exit)))
(defun my/org-force-open-current-window ()
"Open a link using 'org-open-at-point' in current window."
(interactive)
(let ((org-link-frame-setup
(quote
((vm . vm-visit-folder)
(vm-imap . vm-visit-imap-folder)
(gnus . gnus)
(file . find-file)
(wl . wl)))
))
(org-open-at-point)))
(defun my/follow-org-link (arg)
"Follow a link in orgmode If ARG is given.
Opens in new window otherwise opens in current window."
(interactive "P")
(if arg
(org-open-at-point)
(my/org-force-open-current-window)))
(defun krofna-hack ()
"Toggle latex fragments after exiting closing them."
(when (looking-back (rx "$ "))
(save-excursion
(backward-char 1)
(org-latex-preview))))
(global-set-key (kbd "C-c n a") 'org-agenda)
(setq org-agenda-start-on-weekday nil)
(define-key org-mode-map (kbd "C-c C-o") 'my/follow-org-link)
(define-key org-mode-map (kbd "C-c C-y") 'my/indent-org-block-automatically)
(define-key org-mode-map (kbd "C-c ]") 'org-cite-insert)
(add-hook 'org-babel-after-execute-hook 'org-redisplay-inline-images)
(add-hook 'org-mode-hook 'visual-line-mode)
(add-hook 'org-mode-hook 'org-cdlatex-mode)
(add-hook 'org-mode-hook
(lambda ()
(add-hook 'post-self-insert-hook #'krofna-hack 'append 'local)))
(add-to-list 'org-latex-classes
'("mla"
"\\documentclass{mla}"
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
("\\paragraph{%s}" . "\\paragraph*{%s}")
("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
(add-to-list 'org-latex-classes
'("letter"
"\\documentclass{letter}"
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
(plist-put org-format-latex-options :scale 3)
(setq org-agenda-files (list org-directory (expand-file-name "ubc" org-directory)))
(setq org-agenda-tags-column 0)
(setq org-auto-align-tags nil)
(setq org-fold-catch-invisible-edits 'show-and-error)
(setq org-cite-export-processors '((t basic)))
(setq org-cite-global-bibliography (list zotero-bibliography))
(setq org-confirm-babel-evaluate nil)
(setq org-ellipsis "")
(setq org-export-with-tags nil)
(setq org-hide-emphasis-markers t)
(setq org-highlight-latex-and-related '(latex))
(setq org-html-head-include-default-style nil)
(setq org-html-head-include-scripts nil)
(setq org-html-validation-link nil)
(setq org-image-actual-width 300)
(setq org-insert-heading-respect-content t)
(setq org-latex-pdf-process '("latexmk -pdflatex='pdflatex -interaction nonstopmode' -pdf -bibtex -f %f"))
(setq org-pretty-entities t)
(setq org-preview-latex-default-process 'dvisvgm)
(setq org-special-ctrl-a/e t)
(setq org-src-fontify-natively t)
(setq org-src-preserve-indentation t)
(setq org-src-tab-acts-natively t)
(setq org-src-window-setup 'current-window)
(setq org-tags-column 0)
(setq org-agenda-time-grid
'((daily today require-timed)
(800 1000 1200 1400 1600 1800 2000)
" ┄┄┄┄┄ " "┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄"))
(setq org-exports-dir (expand-file-name "exports" org-directory))
(setq org-publish-project-alist
(list (cons "html"
(list :base-directory org-directory
:base-extension "org"
:htmlized-source t
:recursive t
:publishing-directory org-exports-dir
:publishing-function 'org-html-publish-to-html))
(cons "pdf"
(list :base-directory org-directory
:base-extension "org"
:recursive t
:publishing-directory org-exports-dir
:publishing-function 'org-latex-publish-to-pdf))
(cons "all" '(:components ("html" "pdf")))))
(add-hook 'org-mode-hook 'org-auctex-mode)
(add-hook 'dired-mode-hook 'org-download-enable)
(setq-default org-download-image-dir (expand-file-name "images" org-directory))
(add-hook 'org-mode-hook 'org-modern-mode)
(setq-default pdf-view-display-size 'fit-width)
(defvar pdf-annot-activate-created-annotations t)
(setq plantuml-default-exec-mode 'executable)

View file

@ -0,0 +1,97 @@
{
pkgs,
lib,
...
}: {
programs.emacs = {
orgTexConfigFile = ./org-tex-cfg.el;
enableOrgTex = lib.mkDefault true;
texEmacsPackages = epkgs: (let
org-auctex = epkgs.trivialBuild rec {
pname = "org-auctex";
version = "e1271557b9f36ca94cabcbac816748e7d0dc989c";
buildInputs = [epkgs.auctex];
src = pkgs.fetchFromGitHub {
owner = "karthink";
repo = pname;
rev = version;
sha256 = "sha256-cMAhwybnq5HA1wOaUqDPML3nnh5m1iwEETTPWqPbAvw=";
};
};
in (with epkgs; [
org-auctex
auctex
cdlatex
citeproc
graphviz-dot-mode
ivy-bibtex
gnuplot
htmlize
org-auctex
org-contrib
org-download
pdf-tools
plantuml-mode
]));
texPackages = let
aspellPackage = pkgs.aspellWithDicts (d: [d.en d.en-science d.en-computers d.fr]);
texliveset = pkgs.texlive.combine {
inherit
(pkgs.texlive)
scheme-basic
babel
amscls
amsmath
biber
biblatex
biblatex-mla
block
cancel
caption
capt-of
csquotes
enotez
enumitem
etex
etoolbox
fancyhdr
float
fontaxes
graphics
hanging
hyperref
latex
latexindent
latexmk
logreq
metafont
mlacls
newtx
pdflscape
pdfpages
preprint
psnfss
ragged2e
titlesec
tools
translations
ulem
url
wrapfig
xstring
xkeyval
;
};
in
with pkgs; [
texliveset
aspellPackage
gnuplot
plantuml
];
};
}