[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/auctex-cont-latexmk 2893258541 010/100: docs
From: |
ELPA Syncer |
Subject: |
[elpa] externals/auctex-cont-latexmk 2893258541 010/100: docs |
Date: |
Thu, 6 Jun 2024 03:57:50 -0400 (EDT) |
branch: externals/auctex-cont-latexmk
commit 2893258541723b1306f732b408e3450dbfde505f
Author: Paul Nelson <ultrono@gmail.com>
Commit: Paul Nelson <ultrono@gmail.com>
docs
---
README.org | 23 +++++++++++++++++++++++
czm-tex-compile.el | 4 ++--
2 files changed, 25 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..f43bd2fce5
--- /dev/null
+++ b/README.org
@@ -0,0 +1,23 @@
+#+title: czm-preview.el: Convenience functions for compiling LaTeX
+#+author: Paul Nelson
+
+* Overview
+This package provides convenience functions that support a LaTeX workflow
where =latexmk= continuously compiles the document in the background.
+
+* 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
+ :bind
+ ("C-c k" . czm-tex-compile)
+ ("s-]" . czm-tex-compile-next-error)
+ ("s-[" . czm-tex-compile-previous-error))
+#+end_src
+Replace the keybindings with whatever you prefer (or delete them and just run
the commands via =M-x=).
+
+* Usage
+
+- If you run =czm-tex-compile= in a TeX buffer visiting "foo.tex", it starts
an =eshell= buffer =*eshell-foo*= in the background that continuously compiles
the current document. Use =M-x customize-variable czm-tex-compile-command= to
customize the compilation command. If you run the same command again, then it
switches to the =eshell= buffer.
+- =czm-tex-compile-next-error= and =czm-tex-compile-previous-error= navigate
the error and warning messages encountered in the log file produced by
=latexmk=, jumping to the corresponding positions in the tex buffer.
+
+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
th [...]
diff --git a/czm-tex-compile.el b/czm-tex-compile.el
index 3d20563403..6f7786c60c 100644
--- a/czm-tex-compile.el
+++ b/czm-tex-compile.el
@@ -1,11 +1,11 @@
-;;; czm-tex-compile.el --- Convenience functions compiling LaTeX -*-
lexical-binding: t; -*-
+;;; czm-tex-compile.el --- Convenience functions for compiling LaTeX -*-
lexical-binding: t; -*-
;; Copyright (C) 2023 Paul D. Nelson
;; Author: Paul D. Nelson <nelson.paul.david@gmail.com>
;; Version: 0.0
;; URL: https://github.com/ultronozm/czm-tex-compile.el
-;; Package-Requires: ((emacs "29.1") (auctex "11.86.1"))
+;; Package-Requires: ((emacs "29.1"))
;; Keywords: tex
;; This program is free software; you can redistribute it and/or modify
- [elpa] externals/auctex-cont-latexmk 45bd7a6c32 012/100: switch back to previous reverse-direction style, (continued)
- [elpa] externals/auctex-cont-latexmk 45bd7a6c32 012/100: switch back to previous reverse-direction style, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk c2d7e5cb90 015/100: delete resolved TODO from comments, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk d052e767e6 016/100: Add synctex=1 to default compile command, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 8633c833d9 020/100: Update README.org, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 6cd49a0317 027/100: about to hack stuff up, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 2762ee8084 037/100: polish, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk e5cce65c36 040/100: readme tweaks, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 989be1a7a9 043/100: flycheck warnings, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 7e2cbfbc88 046/100: fix defcustom groups, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 2639003039 059/100: tweaks, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 2893258541 010/100: docs,
ELPA Syncer <=
- [elpa] externals/auctex-cont-latexmk b5bd4c5257 024/100: indentation, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk e20b97607e 026/100: got it in OK shape, still quite rough tho, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 1384905db7 050/100: rearrange, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 7c7fcc15a9 053/100: mild factoring, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk b082dacb78 054/100: some good clean-up, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 62c2eb652a 031/100: print entire warning message (not every warning is a LaTeX warning), ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 5473521164 036/100: tweak readme, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 6cbd9d1493 067/100: respect TeX-output-dir, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 8333451e17 028/100: re-implement main logic using TeX-parse-all-errors, ELPA Syncer, 2024/06/06
- [elpa] externals/auctex-cont-latexmk 1aee5cc114 049/100: add "ignored" user option, started rearranging, ELPA Syncer, 2024/06/06