This help file documents Yap 0.97.

Introduction	What is Yap?
Opening Files	How to open a DVI file
Printing	Printing DVI documents
DVI Search	Forward and inverse DVI search
Graphics	Graphics
Tools	Yap tools
Keyboard	Keyboard interface
Customizing Yap	How to customize Yap
Logbook	The logbook
Command Line	Command line switches
Specials	Specials
Copyright	Yap copyright
Troubleshooting	Troubleshooting
Index	Index

1. What is Yap?

You use Yap(1) to view a DVI file compiled by TeX. Yap tries hard to follow the WYSIWYG-principle: what you see (on screen) is what you get (when you take the paper out of the tray).

This document will explain

• how to open a DVI file (see section 2. How to open a DVI file)
• how to send a DVI file to the printer (see section 3. Printing DVI Documents)
• how to associate Yap with a TeX editor (see section 4. Forward and Inverse Search).
• how to include graphics (see section 5. Graphics Inclusions)
• how to make use of the magnifying glass and other tools (see section 6. Yap Tools)
• how to use the keyboard to navigate through a DVI file (see section 7. Keyboard Map)
• how to customize Yap (see section 8. Customizing Yap)

2. How to open a DVI file

You can open a DVI file

• by double-clicking its icon in a Windows Explorer window
• by invoking Yap from the command line (see section 10. Command line switches).
• via Drag&Drop
• with the command `File|Open'
• by selecting an MRU(2) entry from the File menu

3. Printing DVI Documents

There are two different methods to send a DVI document to the printer:

1. By means of the standard print command (`File|Print...').
2. By means of Dvips (`File|Print PostScript...').

The Dvips interface also works in conjunction with non-PostScript printers, provided that you have GhostScript installed on your workstation.

Standard Printing	Standard Print Command
Dvips Interface	Printing using Dvips

3.1 Standard Print Command

The command `File|Print...' opens the standard Print Setup dialog box.

3.2 Printing using Dvips

The command `File|Print PostScript...' opens the Print PostScript dialog box.

Dvips Dialog Box	Print PostScript Dialog Box

3.2.1 Print PostScript Dialog Box

This dialog box allows you select various Dvips options.

GhostScript device

Check this button if you want to pipe the Dvips output through the GhostScript interpreter (gswin32c.exe). GhostScript will be invoked with the following options:

-sDEVICE=device

Output goese to the specified device.

-dBATCH

Causes GhostScript to quit when the document has been printed.

-dNOPAUSE

Disables the prompt and the pause at the end of each page.

-dSAFER

Disables unsafe operators.

PS File

Check this button if you want to send the Dvips output to a PostScript printer or if you want to save the output in a PostScript file. Enter a port name (such as `lpt1' or `\\servername\printer') or a file name.

Print range

Select the pages that you want to print.

Extra Dvips options

You can enter additional Dvips options here.

Reconfirm command line

Check this button if you want to inspect the Dvips command line.

4. Forward and Inverse Search

Yap is capable of searching the DVI file for so called source specials. This feature can help you to optimize the edit-compile-view cycle:

• While editing a TeX source, issue an appropriate command that invokes Yap to display the TeXed document. Yap will indicate it's idea of the current edit position by drawing a small circle. This is called forward search.
• While viewing the TeXed document with Yap, move the mouse cursor over a paragraph that you want to edit next. Double-click to jump to the editor. Yap will try to move the text cursor to the correct source line. This is called inverse search.

Inserting Source Specials	How to enrich your document with source specials
Forward Search	How to search forward
Inverse Search	Initiating Inverse Search

4.1 How to enrich your document with source specials

TeX inserts source specials into the DVI file, if you specify the command-line switch `--src-specials'. You simply can say

tex --src-specials mybook.tex

You can control the frequency of embedded source specials by specifying where to insert the specials into the DVI file:

tex --src-specials=where mybook.tex

cr

Causes TeX to insert one source special at the end of each table row.

display

Causes TeX to insert one source special at the beginning of each display.

hbox

Causes TeX to insert one source special at the beginning of each hbox.

math

Causes TeX to insert one source special upon entry to math mode.

par

Causes TeX to insert one source special at the beginning of each paragraph.

vbox

Causes TeX to insert one source special at the beginning of each vbox.

4.2 How to search forward

Forward search is initiated by specifying --find-src-special on the Yap command-line (see section 10. Command line switches).

But initiating forward search from the command-line is rather invonvenient. It makes more sense to initiate forward search out of the text editor. The editor must be capable of starting Yap with a correct --find-src-special directive. Two popular text editors which are capable to initiate forward search are GNU Emacs and WinEdt.

Emacs	Configuring Emacs for forward search.

4.2.1 Configuring Emacs

You will need the Emacs package Auc-TeX, which provides an enhanced TeX environment.

The following code should be added to your `.emacs':

(setq TeX-command-list
      '(("TeX" "tex --src \"\\nonstopmode\\input %t\""
         TeX-run-TeX nil t)
	("LaTeX" "%l --src \"\\nonstopmode\\input{%t}\""
         TeX-run-LaTeX nil t)
	("View" "yap -1 -s \"%n %t\" %d"
         TeX-run-discard nil nil)
	("BibTeX" "bibtex %s" TeX-run-BibTeX nil nil)
	("Index" "makeindex %s" TeX-run-command nil t)))

`View' starts Yap (if it is not already running) and moves the focus to the corresponding DVI location.

4.3 Initiating Inverse Search

Provided that the DVI document contains source file information (see section 4.1 How to enrich your document with source specials), you can initiate inverse search by double-clicking inside the Yap document window.

5. Graphics Inclusions

Yap supports the following graphics formats:

EMF

Enhanced Metafiles (*.emf).

WMF

Windows Metafiles (*.wmf).

BMP

Device-independant Bitmap (*.bmp).

EPS

Encapsulated PostScript (*.eps); requires GhostScript.

GIF, PNG, TIFF, ...

All graphics formats that are supported by the netpbm graphics suite.

WMF	Windows Metafiles
BMP	Windows Bitmap (BMP) Files
EPS	Encapsulated PostScript
Other Formats	Other Graphics Formats

5.1 Windows Metafiles

Yap has built-in support for Windows Metafiles (WMF) and Enhanced Metafiles (EMF).

Example

You can use the `graphicx' package to include WMF/EMF files. For example, the following LaTeX code will include the WMF file drawing.wmf:

\usepackage{graphicx}
\DeclareGraphicsRule{.wmf}{bmp}{}{}% declare WMF filename extension
\begin{document}
\includegraphics[width=2in,height=1in]{drawing.wmf}
\end{document}

5.2 Windows Bitmap (BMP) Files

Yap has built-in support for Windows Bitmap Files.

Example

You can use the `graphicx' package to include BMP files. For example, the following LaTeX code will include the BMP file picture.bmp:

\usepackage{graphicx}
\begin{document}
\includegraphics[width=2in,height=1in]{picture.bmp}
\end{document}

5.3 Encapsulated PostScript

Yap displays EPS figures with the help of GhostScript, which must be installed on your computer.

Example

You can use the `graphicx' package to include EPS files. For example, the following LaTeX code will include the EPS file drawing.eps:

\usepackage{graphicx}
\begin{document}
\includegraphics{drawing.eps}
\end{document}

5.4 Other Graphics Formats

Yap can convert almost any graphics file into an equivalent Windows Bitmap (BMP) file, provided that a suitable filter program is available. The BMP file will then be displayed instead of the original file.

Many filters are included in the netpbm graphics suite, which can be downloaded from the CTAN directory systems/win32/miktex/util.

Example

You can use the `graphicx' package to include graphics files. For example, the following LaTeX code will include the GIF file picture.gif:

\usepackage{graphicx}
\DeclareGraphicsRule{.gif}{bmp}{}{}% declare GIF filename extension
\begin{document}
\includegraphics[width=2in,height=1in]{picture.gif}
\end{document}

Filters	Specifying filters

5.4.1 Specifying filters

• `.xxx' is the original filename extension
• `command' is the command line, which converts an XXX file into a BMP file.

`%i'

The name of the input file which has to be converted.

`%o'

The name of the output (BMP) file.

Example

The following specification defines a GIF filter:

[Graphics]
.gif.bmp=giftopnm %i | ppmtobmp -windows > %o

1. giftopnm is used to convert the .gif file into a portable bitmap, which is written to a pipe (`|')
2. ppmtobmp is used to convert the portable bitmap, which is read from the pipe, into the final BMP file.

6. Yap Tools

Yap provides several tools for browsing the DVI document.

src Browser	Browsing Source Specials
Hand Tool	Hand Tool
Magnifying Glasses	Magnifying Glasses

6.1 Browsing Source Specials

The command `Tools|Source Specials...' opens the the Source Specials windows.

Source Specials Window	Source Specials Window

6.1.1 Source Specials Window

This window lists all source specials found in the current DVI document.

Goto

Edit Source

Close

6.2 Hand Tool

The hand tool allows you to scroll the page by moving the cursor while the left mouse button is pressed. You select the Hand Tool with the command `Tools|Hand Tool' or by clicking the corresponding button in the toolbar.

6.3 Magnifying Glasses

The Magnifying Glass allows you to view a small part of the unshrunk page. You select this tool with the command `Tools|Magnifying Glass' or by clicking the corresponding button in the toolbar.

You can choose between three sizes:

1. Pressing the left mouse button activates the small magnifying glass.
2. Pressing the left mouse button in combination with the Shift key activates the medium sized magnifying glass.
3. Pressing the left mouse button in combination with the Control key activates the large magnifying glass.

You can specify the power of the magnifying glass by entering a numerical prefix argument. The argument is interpreted as a shrink factor for the text inside the magnifying glass. A shrink factor of 1 (the default) results in a maximum magnification.

7. Keyboard Map

Numerical Prefix

0

1

2

3

4

5

6

7

8

9

Adds a digit to the numerical prefix.

BACK

Removes the last digit from the numerical prefix.

-

Negates the numerical prefix.

Zooming

prefix++

Zooms in (unshrinks the page).

prefix+-

Zooms out (shrinks the page).

Navigation

prefix+g

Opens the Goto Page dialog box if no prefix argument was entered. Otherwise goes to the specified page.

prefix+PgUp

prefix+b

prefix+p

prefix+h

prefix+Back

prefix+Del

Goes to previous page.

prefix+PgDn

prefix+f

prefix+n

Goes to the next page.

Alt+Left

Return to the last page.

Alt+Right

Go to the page you viewed before clicking Back.

Ctrl+Home

Goes to the first page.

Ctrl+End

Goes to the last page.

Scrolling

End

Scrolls the window to the bottom of the page.

Home

^

Scrolls the window to the top of the page.

Left

Scrolls the windows left a little bit.

Shift+Left

l

Scrolls the window left.

Right

Scrolls the window right a little bit.

Shift+Right

r

Scrolls the window right.

Space

Scrolls the window down. Goes to the next page, if at the bottom of the current page.

Up

Scrolls the windows up a little bit.

Shift+Up

u

Scrolls the window up.

Down

Scrolls the windows down a little bit.

Shift+Down

d

Scrolls the window down.

Misc

?

Show the keyboard map.

e

Start a text editor to edit the TeX source under the mouse cursor (i. e. perform an inverse search).

F

Ctrl+O

Open a new DVI Document.

Ctrl+P

Send the DVI document to the printer.

q

Ctrl+c

Ctrl+d

Quit the application.

8. Customizing Yap

Options	Options Dialog Box
PostScript Fonts	Telling Yap About PostScript Fonts

8.1 Options Dialog Box

UI	User Interface Property Page
Magnifying Glass	Magnifying Glass Property Page
Display Settings	Display Property Page
Printer Settings	Printer Property Page
Inverse Search Settings	Inverse Search Property Page
GhostScript	GhostScript Property Page
Security	Security Property Page
Advanced Options	Advanced Property Page

8.1.1 User Interface Property Page

The User Interface property page allows you to customize the Look & Feel of Yap.

Maintain vertical position

Select this checkbox to cause Yap to keep the vertical scroll position at a change of page.

Maintain horizontal position

Select this checkbox to cause Yap to keep the horizontal scroll position at a change of page.

8.1.2 Magnifying Glass Propery Page

This property page allows you to customize the three magnifying glasses.

Hide mouse cursor

Check this button if the mouse cursor should not be visible while a magnifying glass is open.

Width

Height

Shrink Factor

8.1.3 Display Property Page

The Display property page allows you to change various display settings.

Mode

The Mode list field contains a list of known METAFONT modes. This information is needed, when new PK fonts are to be generated. In principle, it doesn't matter what mode name you select here. But it's recommended, that you use the same mode name as for the printer, since this reduces the invocations of the font-generator.

Shrink Factor

Paper Size

Orientation

Enable colored text

8.1.4 Printer Property Page

The Printer property page allows yoy to change various printer settings.

Mode

The Mode list field contains a list of known METAFONT modes. This information is needed, when new PK fonts are to be generated. You must select a mode, that matches your printer resolution.

x-shift, y-shift

For some old printer models it may be necessary to adjust the the print offset (i.e. the position, where printing begins). x-shift/y-shift gives the amount of pixels, an output page has to be shifted right/down.

8.1.5 Inverse Search Property Page

Program

Specify the program Yap shall execute to do the inverse DVI search.

Command line

Specify the command line Yap shall execute to do the inverse DVI search.

The command line may contain the following placeholders:

%f

Expands to the name of the source file.

%l

Expands to the line number in the source file.

8.1.6 GhostScript Property Page

This property page allows you to configure PostScript support.

Disable PostScript interpretation

Check this button, if you want Yap to ignore all PostScript specials.

Draft mode (no anti-aliasing)

Check this button to disable anti-aliasing for PostScript graphics. This speeds up the interpretation of PostScript specials at the expense of output quality.

8.1.7 Security Property Page

This property page allows you to permit or forbid the execution of embedded shell commands.

Never execute any shell commands

Check this button to prevent the execution of embedded shell commands.

Ask for permission to execute shell command

Check this button if you want to be warned about any embedded shell commands. You can then choose whether or not to execute the command.

Execute only secure shell commands

Check this button to allow secure commands. Enter a comma-separated list of command names in the edit box.

Execute all shell commands

Check this button to execute embedded shell commands unconditionally.

8.1.8 Advanced Property Page

This property page allows you to set advanced options.

Keep logbook

Check this button to cause Yap to record events into the logbook.

Show source specials

Check this button to cause Yap to show all source specials.

Yap should check to see whether it is the default viewer

Check this button, if Yap should check to see whether it is associated with the file extension .dvi.

8.2 Telling Yap About PostScript Fonts

Yap consults several font mapping files when a missing PK font has to be generated from a PostScript Type 1 font:

`dvips\config\config.ps'

Yap first consults the Dvips configuration file.

`miktex\config\miktex.map'

Yap then consults the MiKTeX font mapping file.

9. The Logbook

Yap records certain events in a logbook. The command `View|Logbook...' opens the logbook.

Close

Press this button to close the logbook.

Copy

Press this button to copy the logbook to the Windows Clipboard.

Erase

Press this button to erase the logbook.

10. Command line switches

The general Yap command line syntax is

yap [options] [dvifile]

--find-src-special srcspecial

-s srcspecial

Initiate a forward search (see section 4. Forward and Inverse Search). The syntax for srcspecial is `NNFILENAME' (i.e. line number followed by source file name). See the example below.

--goto-hyper-label label

Jump to a HyperTeX label. The label must have been inserted as an html: special.

--single-instance

-1

Use an already opened Yap application window (if one exists). This flag prevents multiple Yap applications instances.

--unregister

Remove Yap related settings from the Windows Registry

Example

You want Yap to do a forward search to the DVI location corresponding to line 41 of the source file mydoc.tex. The name of the DVI file is mydoc.dvi. The forward search is initiated like this:

yap -s 41mydoc.tex mydoc.dvi

yap -1 -s 41mydoc.tex mydoc.dvi

A. Specials

A.1 PostScript Specials
A.2 HyperTeX Specials
A.3 emTeX Specials
A.4 DviWin Specials
A.5 Color Specials

A.1 PostScript Specials

\special{! string}

Insert literal PostScript into user dictionary.

\special{" string}

Insert literal PostScript.

\special{ps: string}

Insert literal PostScript, with no protection.

\special{ps::[begin] string}

Start inserting literal PostScript.

\special{ps:: string}

Send literal PostScript to GhostScript.

\special{ps::[end] string}

End sending literal PostScript.

\special{ps: plotfile filename}

Send file contents into GhostScript.

\special{header=filename}

Insert file contents into GhostScript's user dictionary.

\special{PSfile="filename"}

\special{psfile=filename}

Insert graphics file.

A.2 HyperTeX Specials

\special{html:<a href="hrefstring">}

Start a hyper reference

\special{html:<a name="namestring">}

Start a hyper label.

\special{html:</a>}

End a hyperref/label.

A.3 emTeX Specials

\special{em: graph filename}

\special{em: graph filename, width, height}

Display a graphics file.

\special{em: message string}

Writes a message to the Yap log file.

\special{em: line p1, p2}

\special{em: line p1, p2, width}

Draws a solid line between two points, which must have been defined with a previous `em: point' special.

\special{em: lineto}

Draws a solid line which starts at the coordinate set by the last `em: moveto' special and ends at the coordinate of the referenc point.

\special{em: linewidth width}

Sets the default width of lines.

\special{em: moveto}

Defines the starting point for the next `em: lineto' special.

\special{em: point P}

Defines point P, which gets the coordinates of the reference point.

A.4 DviWin Specials

\special{anisoscale filename, width, height}

Insert a graphics file.

{src: linenumber filename}

Insert source file information.

A.5 Color Specials

\special{color push color}

Push a color onto the color stack.

\special{color pop}

Pop the color stack.

\special{color reset}

Reset the color stack.

B. Yap Copyright

The following copyright notice applies to the Yap program. The copyright and copying permissions for this manual appear near the beginning of this document.

Copyright (C) 1996, 97, 98 Christian Schenk.

Yap is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
   
Yap is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
   
You should have received a copy of the GNU General Public License along
with Yap; if not, write to the Free Software Foundation, 59 Temple Place
- Suite 330, Boston, MA 02111-1307, USA.

C. Troubleshooting

C.1 Cannot locate GhostScript DLL
C.2 Cannot locate GhostScript Executable
C.3 Cannot create font
C.4 No source specials found
C.5 Cannot open TeX source file

C.1 Cannot locate GhostScript DLL

The GhostScript interpreter (gsdll32.dll) could not be located.

Remedy: Install GhostScript 5.50 and make sure that the GhostScript directory (usually `c:\gstools\gs5.50') is included in the PATH variable.

More information: PostScript specials are rendered with the help of GhostScript, a free PostScript interpreter.

C.2 Cannot locate GhostScript Executable

The GhostScript executable (gswin32.exe) could not be located.

Remedy: Install GhostScript 5.50 and make sure that the GhostScript directory (usually `c:\gstools\gs5.50') is included in the PATH variable.

More information: PostScript specials are printed with the help of GhostScript, a free PostScript interpreter.

C.3 Cannot create font

Yap was not able to create a missing font.

Remedy: Install the font source file(s).

More information: The logbook (`View|Logbook...') should state the name of the missing file.

C.4 No source specials found

The DVI file contains no source specials.

Remedy: Use the `--src' option the next time you compile your TeX source file (see section 4.1 How to enrich your document with source specials).

C.5 Cannot open TeX source file

Yap cannot open the TeX source file because the current DVI page contains no source file information.

Remedy: Use the `--src' option the next time you compile your TeX source file (see section 4.1 How to enrich your document with source specials).

D. Index

Jump to:

Footnotes

(1)

Yet Another Previewer

(2)

Most Recently Used (File)

Table of Contents

• 1. What is Yap?
• 2. How to open a DVI file
• 3. Printing DVI Documents
• 3.1 Standard Print Command
• 3.2 Printing using Dvips
• 3.2.1 Print PostScript Dialog Box
• 4. Forward and Inverse Search
• 4.1 How to enrich your document with source specials
• 4.2 How to search forward
• 4.2.1 Configuring Emacs
• 4.3 Initiating Inverse Search
• 5. Graphics Inclusions
• 5.1 Windows Metafiles
• 5.2 Windows Bitmap (BMP) Files
• 5.3 Encapsulated PostScript
• 5.4 Other Graphics Formats
• 5.4.1 Specifying filters
• 6. Yap Tools
• 6.1 Browsing Source Specials
• 6.1.1 Source Specials Window
• 6.2 Hand Tool
• 6.3 Magnifying Glasses
• 7. Keyboard Map
• 8. Customizing Yap
• 8.1 Options Dialog Box
• 8.1.1 User Interface Property Page
• 8.1.2 Magnifying Glass Propery Page
• 8.1.3 Display Property Page
• 8.1.4 Printer Property Page
• 8.1.5 Inverse Search Property Page
• 8.1.6 GhostScript Property Page
• 8.1.7 Security Property Page
• 8.1.8 Advanced Property Page
• 8.2 Telling Yap About PostScript Fonts
• 9. The Logbook
• 10. Command line switches
• A. Specials
• A.1 PostScript Specials
• A.2 HyperTeX Specials
• A.3 emTeX Specials
• A.4 DviWin Specials
• A.5 Color Specials
• B. Yap Copyright
• C. Troubleshooting
• C.1 Cannot locate GhostScript DLL
• C.2 Cannot locate GhostScript Executable
• C.3 Cannot create font
• C.4 No source specials found
• C.5 Cannot open TeX source file
• D. Index

Overview (Short Table of Contents)

About this document

• 1. Section One
• 1.1 Subsection One-One
• ...
• 1.2 Subsection One-Two
• 1.2.1 Subsubsection One-Two-One
• 1.2.2 Subsubsection One-Two-Two
• 1.2.3 Subsubsection One-Two-Three     <== Current Position
• 1.2.4 Subsubsection One-Two-Four
• 1.3 Subsection One-Three
• ...
• 1.4 Subsection One-Four