xdvir (version 0.1-2)

TeXengine: Define a TeX Engine.

Description

Define and register a TeX engine for authoring, typesetting, and rendering LaTeX documents.

Usage

TeXengine(name,
          version,
          command,
          isEngine,
          fontFile,
          glyphIndex,
          options=NULL,
          preamble="",
          dviSuffix=".dvi")
registerEngine(engine)

Value

TeXengine() returns a "TeXengine" object.

Arguments

name

Character name for the engine.

version

A function with no arguments that returns the engine version as a character value.

command

The command used to typeset a latex document with this engine.

isEngine

A function with one argument, a "DVI" object, that returns a logical indicating whether this engine was used to generate that DVI output.

fontFile

A function with one argument, a font description from a font definition opertaion in DVI output, that returns a path to the appropriate font file.

glyphIndex

A function with one argument, a raw vector of bytes from a set char operation in DVI output, that returns an integer index of the appropriate glyph.

options

Any required options to command to ensure that the engine generates DVI output.

preamble

A preamble that is added during authoring of a complete LaTeX document from a LaTeX snippet. See author and grid.latex.

dviSuffix

The file suffix used for DVI files that are generated by this engine.

engine

A "TeXengine" object, as generated by TeXengine().

Author

Paul Murrell

Details

TeXengine() can be used to create a typesetting engine for use with, e.g., grid.latex. Registering the engine via registerEngine() means that the engine can be specified by name.