branch: externals/auctex-cont-latexmk
commit 79948cf6519f7326a6dda8724e6bcfa9388fad99
Author: Paul Nelson <ultr...@gmail.com>
Commit: Paul Nelson <ultr...@gmail.com>
tweaks, docs
---
README.org | 8 ++++++--
tex-continuous.el | 15 ++++++++-------
2 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
index 1791d77e03..c6abe8c0ed 100644
--- a/README.org
+++ b/README.org
@@ -13,8 +13,6 @@ Download this repository, install using =M-x
package-install-file= (or package-v
#+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
tex-continuous-command=.
-
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 [...]
@@ -30,3 +28,9 @@ The way the Flymake backend works, it will update only when
the latexmk process
#+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
[...]
+
+* Customization
+- You can tweak the underlying =latexmk= command via =M-x customize-variable
tex-continuous-command=.
+
+* Troubleshooting
+- The compilation takes place in a buffer *pvc-filename*, so look there if you
need to see the output.
diff --git a/tex-continuous.el b/tex-continuous.el
index ce1b7cd059..62fcfe6e5f 100644
--- a/tex-continuous.el
+++ b/tex-continuous.el
@@ -32,6 +32,9 @@
;;
;; Customize the variable `tex-continuous-command' to change the
;; compilation command.
+;;
+;; The compilation takes place in a buffer *pvc-filename*, so look
+;; there if you need to see the output.
;;; Code:
@@ -44,19 +47,17 @@
(defcustom tex-continuous-report-multiple-labels t
"Non-nil means report multiple label errors via flymake."
- :type 'boolean
- :group 'tex-continuous)
+ :type 'boolean)
(defcustom tex-continuous-command
"latexmk -pvc -shell-escape -pdf -view=none -e '$pdflatex=q/pdflatex %O
-synctex=1 -interaction=nonstopmode %S/'"
"Command to compile LaTeX documents."
- :type 'string
- :group 'tex-continuous)
+ :type 'string)
(defun tex-continuous-process-item (type file line message offset _context
search-string
_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
+The arguments are as in `TeX-error-list'. Return either nil or a
triple (ERROR-P DESCRIPTION (BEG . END)), where ERROR-P is non-nil if it
is an error rather than a warning."
(and
@@ -160,8 +161,8 @@ latexmk compilation is in a \"Watching\" state."
(defun tex-continuous-flymake (report-fn &rest _args)
"Flymake backend for LaTeX based on latexmk.
-Save REPORT-FN in a local variable, called by
-e`tex-continuous--timer' to report diagnostics."
+Save REPORT-FN in a local variable, called by `tex-continuous--timer' to
+report diagnostics."
(when tex-continuous-mode
(setq tex-continuous--report-fn report-fn)))
