File: preview.el.html

This style is for the "seamless" embedding of generated images into LaTeX source code. Please see the README and INSTALL files for further instruction.

Please use the usual configure script for installation: more than just Elisp files are involved: a LaTeX style, icon files, startup code and so on.

Quite a few things with regard to preview-latex's operation can be configured by using M-x customize-group RET preview RET

Please report bugs with M-x preview-report-bug RET.

Defined variables (82)

TeX-active-tempdirList of directory name, top directory name and reference count.
preview-LaTeX-commandCommand used for starting a preview.
preview-LaTeX-command-replacementsReplacement for ‘preview-LaTeX-command’.
preview-LaTeX-disable-pdfoutputThis replacement places ‘"\pdfoutput=0 "’ after the options
preview-TeX-bb-borderAdditional space in pt around Bounding Box from TeX.
preview-TeX-style-dirThis variable contains the location of uninstalled TeX styles.
preview-abort-flagCause ongoing preview generation to abort.
preview-auto-cache-preambleWhether to generate a preamble cache format automatically.
preview-auto-revealCause previews to open automatically when entered.
preview-auto-reveal-commandsList of commands that may cause a preview to be revealed.
preview-bb-filesizeSize of file area scanned for bounding box information.
preview-change-listList of tentatively changed overlays.
preview-colorsColor setup list.
preview-current-regionCons cell (begin . end) tracking the region currently being previewed.
preview-default-document-ptAssumed document point size for ‘preview-scale-from-face’.
preview-default-option-listSpecifies default options to pass to preview package.
preview-default-preambleSpecifies default preamble code to add to a LaTeX document.
preview-document-pt-listHow ‘preview-document-pt’ figures out the document size.
preview-dump-replacementsGenerate a dump command from the usual preview command.
preview-dump-thresholdRegexp denoting end of preamble.
preview-dumped-alistAlist of dumped masters.
preview-dvi*-commandCommand used for converting to separate PNG images.
preview-dvi*-image-typeImage type that dvi conversion produces.
preview-dvipng-commandCommand used for converting to separate PNG images.
preview-dvipng-image-typeImage type that dvi conversion produces.
preview-dvips-commandCommand used for converting to separate EPS images.
preview-equality-transformsTransformation functions for region changes.
preview-error-conditionLast error raised and to be reported.
preview-error-iconThe icon used for PostScript errors.
preview-error-icon-specsThe icon used for PostScript errors.
preview-expandable-stringType to be used for ‘preview-string-expand’.
preview-fast-conversionSet this for single-file PostScript conversion.
preview-fast-dvips-commandCommand used for converting to a single PS file.
preview-find-end-functionFunction used to compute the end position for a new overlay.
preview-format-extensionsPossible extensions for format files.
preview-format-nameFormat name when enabling preamble cache.
preview-gs-answerAccumulated answer of Ghostscript process.
preview-gs-commandHow to call gs for conversion from EPS. See also ‘preview-gs-options’.
preview-gs-dscParsed DSC information.
preview-gs-image-typeImage type for gs produced images.
preview-gs-image-type-alistAlist of image types and corresponding Ghostscript options.
preview-gs-init-stringGhostscript setup string.
preview-gs-optionsOptions with which to call gs for conversion from EPS.
preview-gs-outstandingOverlays currently processed.
preview-gs-outstanding-limitNumber of requests allowed to be outstanding.
preview-gs-queueList of overlays to convert using gs.
preview-gs-sequencePair of sequence numbers for gs produced images.
preview-iconThe icon used for an open preview.
preview-icon-specsThe icon used for an open preview.
preview-image-creatorsDefine functions for generating images.
preview-image-typeImage type to be used in images.
preview-inner-environmentsEnvironments not to be previewed on their own.
preview-last-counterLast counter information.
preview-last-locationRestored cursor position marker for reopened previews.
preview-leave-open-previews-visibleWhether to leave previews visible when they are opened.
preview-markerMarker for fake intangibility.
preview-min-specValue to filter out too large icons.
preview-nonready-iconThe icon used for previews to be generated.
preview-nonready-icon-specsThe icon used for previews to be generated.
preview-parsed-countersCounters as parsed from the log of LaTeX run.
preview-parsed-font-sizeFont size as parsed from the log of LaTeX run.
preview-parsed-magnificationMagnification as parsed from the log of LaTeX run.
preview-parsed-pdfoutputPDFoutput as parsed from the log of LaTeX run.
preview-parsed-tightpageTightpage as parsed from the log of LaTeX run.
preview-pdf-color-adjust-methodMethod to adjust colors of images generated from PDF.
preview-pdf2dsc-commandCommand used for generating dsc from a PDF file.
preview-prefer-TeX-bbPrefer TeX bounding box to EPS one if available.
preview-preprocess-functionsList of functions used to preprocess region before previewing.
preview-preserve-countersTry preserving counters for partial runs if set.
preview-preserve-indentationWhether to keep additional whitespace at the left of a line.
preview-protect-pointTemporarily open new previews that would obscure point.
preview-ps-filePostScript file name for fast conversion.
preview-query-replace-revealMake ‘query-replace’ autoreveal previews.
preview-required-option-listSpecifies required options passed to the preview package.
preview-resolutionScreen resolution where rendering started.
preview-scaleScreen scale of images.
preview-scale-functionScale factor for included previews.
preview-temp-dirsList of top level temporary directories in use from preview.
preview-transparent-borderWidth of transparent border for previews in pt.
preview-transparent-colorColor to appear transparent in previews.
preview-undump-replacementsUse a dumped format for reading preamble.
preview-versionPreview version.

Defined functions (156)

LaTeX-preview-setup()
TeX-inline-preview-internal(COMMAND FILE PR-FILE COMMANDBUFF DUMPED-CONS MASTER GEOMETRY &optional STR)
desktop-buffer-preview(FILE-NAME BUFFER-NAME MISC)
desktop-buffer-preview-misc-data(&rest IGNORED)
preview--convert-^^ab(STRING)
preview--counter-information(BEGIN)
preview--decode-^^ab(STRING CODING-SYSTEM)
preview--delete-overlay-files(OVR)
preview--open-for-replace(BEG END &rest _)
preview--skip-preamble-region(REGION-TEXT REGION-OFFSET)
preview-TeX-bb(LIST)
preview-TeX-inline-sentinel(PROCESS NAME)
preview-TeX-style-cooked()
preview-active-contents(OV)
preview-active-string(OV)
preview-add-urgentization(FUN OV &rest REST)
preview-ascent-from-bb(BB)
preview-at-point()
preview-attach-filename(ATTACHED FILE)
preview-auctex-font-size()
preview-auto-reveal-p(MODE DISTANCE)
preview-back-command(&optional NOCOMPLEX)
preview-buffer()
preview-buffer-restore(BUFFER-MISC)
preview-buffer-restore-internal(BUFFER-MISC)
preview-cache-preamble(&optional FORMAT-CONS)
preview-cache-preamble-off(&optional OLD-FORMAT)
preview-call-hook(SYMBOL &rest REST)
preview-canonical-spaces(ARG)
preview-check-changes()
preview-clean-subdir(DIR)
preview-clean-topdir(TOPDIR)
preview-cleanout-tempfiles()
preview-clearout(&optional START END TIMESTAMP EXCEPTION)
preview-clearout-at-point()
preview-clearout-buffer(&optional BUFFER)
preview-clearout-document()
preview-clearout-section()
preview-context-menu(OV EV)
preview-copy-mml(OV)
preview-copy-region-as-mml(START END)
preview-copy-text(OV)
preview-counter-find(BEGIN)
preview-create-icon(FILE TYPE ASCENT BORDER)
preview-create-icon-1(FILE TYPE ASCENT BORDER)
preview-create-subdirectory()
preview-delete(OVR &rest IGNORED)
preview-delete-file(FILE)
preview-disable(OVR)
preview-disabled-string(OV)
preview-do-replacements(STRING REPLACEMENTS)
preview-document()
preview-document-pt()
preview-dsc-parse(FILE)
preview-dump-file-name(FILE)
preview-dump-state(BUFFER)
preview-dvi*-abort()
preview-dvi*-close(PROCESS CLOSEDATA)
preview-dvi*-place-all()
preview-dvi*-process-setup()
preview-dvi*-process-setup-1(IMG-TYPE START SENTINEL)
preview-dvi*-sentinel(PROCESS COMMAND &optional PLACEALL)
preview-dvipng-abort()
preview-dvipng-close(PROCESS CLOSEDATA)
preview-dvipng-color-string(COLORS RES)
preview-dvipng-place-all()
preview-dvipng-process-setup()
preview-dvipng-sentinel(PROCESS COMMAND &optional PLACEALL)
preview-dvips-abort()
preview-dvisvgm-command(&optional CMD)
preview-environment(COUNT)
preview-error-quote(STRING)
preview-extract-bb(FILENAME)
preview-extract-counters(CTR)
preview-filter-specs(SPEC-LIST)
preview-filter-specs-1(SPECS)
preview-format-kill(FORMAT-CONS)
preview-format-mml(OV &optional DONT-ASK)
preview-generate-preview(FILE COMMAND)
preview-get-colors()
preview-get-geometry()
preview-get-heuristic-mask()
preview-get-magnification()
preview-goto-info-page()
preview-gs-behead-outstanding(ERR)
preview-gs-close(PROCESS CLOSEDATA)
preview-gs-color-string(COLORS &optional SUPPRESS-FGBG)
preview-gs-color-value(VALUE)
preview-gs-dsc-cvx(PAGE DSC)
preview-gs-dvips-process-setup()
preview-gs-dvips-sentinel(PROCESS COMMAND &optional GSSTART)
preview-gs-filter(PROCESS STRING)
preview-gs-flag-error(OV ERR)
preview-gs-open(&optional SETUP)
preview-gs-place(OV SNIPPET BOX RUN-BUFFER TEMPDIR PS-FILE IMAGETYPE)
preview-gs-queue-empty()
preview-gs-restart()
preview-gs-sentinel(PROCESS STRING)
preview-gs-transact(PROCESS ANSWER)
preview-gs-urgentize(OV BUFF)
preview-handle-insert-behind(OV AFTER-CHANGE BEG END &optional LENGTH)
preview-handle-insert-in-front(OV AFTER-CHANGE BEG END &optional LENGTH)
preview-handle-modification(OV AFTER-CHANGE BEG END &optional LENGTH)
preview-hook-enquiry(HOOK)
preview-icon-copy(ICON)
preview-import-image(IMAGE)
preview-inactive-string(OV)
preview-inherited-face-attribute(FACE ATTRIBUTE &optional INHERIT)
preview-install-styles(DIR &optional FORCE-OVERWRITE FORCE-SAVE)
preview-kill-buffer-cleanup(&optional BUF)
preview-log-error(ERR CONTEXT &optional PROCESS)
preview-make-clickable(&optional MAP GLYPH HELPSTRING CLICK1 CLICK2)
preview-make-filename(FILE TEMPDIR)
preview-make-image(SYMBOL)
preview-mark-point()
preview-mode-setup()
preview-mouse-open-eps(FILE &optional POSITION)
preview-mouse-open-error(STRING)
preview-move-point()
preview-next-border(BACKWARDS)
preview-open-overlays(LIST &optional POS)
preview-parse-counters(STRING)
preview-parse-messages(OPEN-CLOSURE)
preview-parse-tightpage(STRING)
preview-pdf-color-string(COLORS)
preview-pdf2dsc-sentinel(PROCESS COMMAND &optional GSSTART)
preview-place-preview(SNIPPET START END BOX COUNTERS TEMPDIR PLACE-OPTS)
preview-preamble-changed-function(OV AFTER-CHANGE BEG END &optional LENGTH)
preview-prepare-fast-conversion()
preview-ps-quote-filename(STR &optional NONREL)
preview-regenerate(OVR)
preview-region(BEGIN END)
preview-register-change(OV)
preview-reinstate-preview(TEMPDIRLIST TIMESTAMP START END IMAGE FILENAME &optional COUNTERS)
preview-relaxed-string=(&rest ARGS)
preview-remove-urgentization(OV)
preview-replace-active-icon(OV REPLACEMENT)
preview-report-bug()
preview-reraise-error(&optional PROCESS)
preview-restore-position(OV WINDOW)
preview-scale-from-face()
preview-section()
preview-set-geometry(GEOMETRY)
preview-set-texinputs(&optional REMOVE)
preview-specs-setter(SYMBOL VALUE)
preview-start-dvi*()
preview-start-dvipng()
preview-start-dvips(&optional FAST)
preview-start-pdf2dsc()
preview-start-process(NAME COMMAND)
preview-string-expand(ARG &optional SEPARATOR)
preview-supports-image-type(IMAGETYPE)
preview-toggle(OV &optional ARG EVENT)
preview-unwatch-preamble(FORMAT-CONS)
preview-walk-document(FUNC)
preview-watch-preamble(FILE COMMAND FORMAT-CONS &optional OUT-FILE)

Defined faces (2)

preview-faceFace to use for the preview source.
preview-reference-faceFace consulted for colors and scale of active previews. Fallback to :inherit and \='default implemented.