Integration on GalleyPDF

URL Scheme

Mon, 01 Jan 0001 00:00:00 +0000

URL Scheme (`galleypdf://`)#

Galley registers a custom URL scheme with macOS LaunchServices for zero-overhead, instantaneous communication with external editors and scripts.

Force Reload#

open -g "galleypdf://reload"

Forward Search#

open -g "galleypdf://forward?line=<line>&pdfpath=<absolute_pdf_path>"

open -g "galleypdf://forward?line=<line>&pdfpath=<absolute_pdf_path>&srcpath=<absolute_src_path>"

open -g "galleypdf://forward?line=<line>&column=<column>&pdfpath=<absolute_pdf_path>&srcpath=<absolute_src_path>"

line is required. column is optional but improves jump accuracy. srcpath is optional and is needed only when SyncTeX cannot determine the source from the PDF alone (multi-file projects).

SyncTeX “Column 0” Workaround

Many PDF viewers have a known SyncTeX issue where forward search from column 0 incorrectly jumps to the end of the previous line. Galley detects column=0 and automatically shifts the search target to line + 1 to avoid this.

AUCTeX (Emacs)

Mon, 01 Jan 0001 00:00:00 +0000

AUCTeX#

For AUCTeX users, add the following to your init.el or .emacs:

;; Enable SyncTeX correlation
(setq TeX-source-correlate-mode t)
(setq TeX-source-correlate-start-server t)

;; Define %c to get the current column for precise Forward Search
(add-to-list 'TeX-expand-list
 '("%c" (lambda () (number-to-string (current-column)))))

;; Register Galley as a custom PDF viewer
(add-to-list 'TeX-view-program-list
 '("Galley" "open -g \"galleypdf://forward?line=%n&column=%c&pdfpath=%o&srcpath=%b\""))

;; Set Galley as the default viewer for PDF output
(setq TeX-view-program-selection '((output-pdf "Galley")))

Execute Forward Search in AUCTeX with C-c C-v (or C-c C-c and select View).

YaTeX (Emacs)

Mon, 01 Jan 0001 00:00:00 +0000

YaTeX#

For YaTeX users, add the following function to your init.el or .emacs:

(defun YaTeX:galley-forward-search ()
 "Perform a precise Forward Search using Galley's URL scheme."
 (interactive)
 (require 'url-util)
 (let* ((line (number-to-string (save-restriction
 (widen)
 (count-lines (point-min) (point)))))
 (column (number-to-string (current-column)))
 (pdf-file (expand-file-name
 (concat (file-name-sans-extension
 (or YaTeX-parent-file
 (save-excursion
 (YaTeX-visit-main t)
 buffer-file-name)))
 ".pdf")))
 (tex-file buffer-file-name)
 (url (format "galleypdf://forward?line=%s&column=%s&pdfpath=%s&srcpath=%s"
 line column
 (url-hexify-string pdf-file)
 (url-hexify-string tex-file))))
 (start-process "galley-forward" nil "open" "-g" url)))

;; Shortcut key configuration for YaTeX (e.g., prefix + C-j)
(add-hook 'yatex-mode-hook
 (lambda ()
 (YaTeX-define-key "\C-j" 'YaTeX:galley-forward-search)))

Visual Studio Code

Mon, 01 Jan 0001 00:00:00 +0000

Visual Studio Code#

For LaTeX Workshop users, add the following to your settings.json:

{
 // Enable SyncTeX
 "latex-workshop.synctex.afterBuild.enabled": true,

 // Register Galley as an external viewer
 "latex-workshop.view.pdf.viewer": "external",
 "latex-workshop.view.pdf.external.synctex.command": "open",
 "latex-workshop.view.pdf.external.synctex.args": [
 "-g",
 "galleypdf://forward?line=%LINE%&column=0&pdfpath=%PDF%&srcpath=%TEX%"
 ]
}

Execute Forward Search with Cmd + Opt + J (or run LaTeX Workshop: SyncTeX from cursor from the Command Palette).

Integration on GalleyPDF

URL Scheme

URL Scheme (galleypdf://)#

Force Reload#

Forward Search#

AUCTeX (Emacs)

AUCTeX#

YaTeX (Emacs)

YaTeX#

Visual Studio Code

Visual Studio Code#

URL Scheme (`galleypdf://`)#