branch: externals/auctex-cont-latexmk
commit f16d095aad6951f84ddcbb81278d8e3fb38bf42c
Author: Paul Nelson <ultr...@gmail.com>
Commit: Paul Nelson <ultr...@gmail.com>
rename, tweak
---
README.org | 19 ++++++-------------
czm-tex-compile.el => tex-continuous.el | 17 +++++++----------
2 files changed, 13 insertions(+), 23 deletions(-)
diff --git a/README.org b/README.org
index c8fd05aa1d..1791d77e03 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,4 @@
-#+title: czm-tex-compile.el: run latexmk continuously, report errors via
flymake
+#+title: tex-continuous.el: run latexmk continuously, report errors via flymake
#+author: Paul Nelson
* Overview
@@ -7,33 +7,26 @@ This package provides a minor mode where
[[https://ctan.org/pkg/latexmk?lang=en]
* Configuration
Download this repository, install using =M-x package-install-file= (or
package-vc-install, straight, elpaca, ...), and add something like the
following to your [[https://www.emacswiki.org/emacs/InitFile][init file]]:
#+begin_src elisp
-(use-package czm-tex-compile
+(use-package tex-continuous
:bind
- ("C-c k" . czm-tex-compile-toggle))
+ ("C-c k" . tex-continuous-toggle))
#+end_src
Replace the keybinding with whatever you prefer (or delete it and just run the
command via =M-x=).
-You can tweak the underlying =latexmk= command via =M-x customize-variable
czm-tex-compile-command=.
+You can tweak the underlying =latexmk= command via =M-x customize-variable
tex-continuous-command=.
-The command =czm-tex-compile-toggle= behaves the way that I prefer -- it
enables both =czm-tex-compile-mode= and =flymake-mode=, restricting the
backends for the latter to those coming from the former. Depending upon your
preferences, you may wish to write your own "wrapper" for
=czm-tex-compile-mode= akin to =czm-tex-compile-toggle=.
+The command =tex-continuous-toggle= behaves the way that I prefer -- it
enables both =tex-continuous-mode= and =flymake-mode=, restricting the backends
for the latter to those coming from the former. Depending upon your
preferences, you may wish to write your own "wrapper" for =tex-continuous-mode=
akin to =tex-continuous-toggle=.
-The way the Flymake backend works, it will update only when the latexmk
process reaches a "watching for changes" state and the buffer is unmodified.
The workflow is thus to save the file, wait a few seconds for the compilation
to complete, and then to use Flymake to navigate the errors. I configure
Flymake to use =M-n= and =M-p= for navigation, and also use =(setq
flymake-show-diagnostics-at-end-of-line t)=, which displays the error/warning
messages in the buffer itself rather than jus [...]
+The way the Flymake backend works, it will update only when the latexmk
process reaches a "watching for changes" state and the buffer is unmodified.
The workflow is thus to save the file, wait a few seconds for the compilation
to complete, and then to use Flymake to navigate the errors. I configure
Flymake to use =M-n= and =M-p= for navigation, and also use =(setq
flymake-show-diagnostics-at-end-of-line t)=, which displays the error/warning
messages in the buffer itself rather than jus [...]
#+begin_src elisp
(use-package flymake
- :elpaca nil
:custom
(flymake-show-diagnostics-at-end-of-line t)
:bind
(:map flymake-mode-map
("M-n" . flymake-goto-next-error)
("M-p" . flymake-goto-prev-error)))
-
-(use-package czm-tex-compile
- :elpaca (:host github :repo "ultronozm/czm-tex-compile.el"
- :depth nil)
- :bind
- ("C-c k" . czm-tex-compile-toggle))
#+end_src
That's all. I prefer this workflow to the alternative in which one compiles
the document manually via =TeX-command-master= (=C-c C-c=) and navigates the
warning/error messages using =next-error= (=M-n=) and =previous-error= (=M-p=).
It also gives a handy way to keep the .aux files up-to-date; I take advantage
of this feature in the packages
[[https://github.com/ultronozm/czm-preview.el][czm-preview.el]] and
[[https://github.com/ultronozm/czm-tex-fold.el][czm-tex-fold.el]] to annotate t
[...]
diff --git a/czm-tex-compile.el b/tex-continuous.el
similarity index 95%
rename from czm-tex-compile.el
rename to tex-continuous.el
index 84a27790ae..ce1b7cd059 100644
--- a/czm-tex-compile.el
+++ b/tex-continuous.el
@@ -24,17 +24,14 @@
;;; Commentary:
;; This package provides a minor mode that compiles a LaTeX document
-;; via latexmk, reporting errors via `flymake'. Customize the
-;; variable `tex-continuous-command' to change the command used to
-;; compile the document.
+;; via latexmk, reporting errors via `flymake'.
;;
-;; My use-package declaration:
+;; Use M-x tex-continuous-toggle to toggle the minor mode and set up
+;; flymake. If you use flymake in tex documents for other reasons,
+;; then you should instead use M-x tex-continuous-mode.
;;
-;; (use-package tex-continuous
-;; :elpaca (:host github :repo "ultronozm/tex-continuous.el"
-;; :depth nil)
-;; :bind
-;; ("C-c k" . tex-continuous-toggle))
+;; Customize the variable `tex-continuous-command' to change the
+;; compilation command.
;;; Code:
@@ -57,7 +54,7 @@
:group 'tex-continuous)
(defun tex-continuous-process-item (type file line message offset _context
search-string
- _line-end bad-box _error-point
ignore)
+ _line-end bad-box _error-point ignore)
"Process an error or warning for the current TeX document.
The arguments are as in in `TeX-error-list'. Return either nil or a
triple (ERROR-P DESCRIPTION (BEG . END)), where ERROR-P is non-nil if it
