Document 657

The LaTeX version package

Version: 5.5 - Scientific WorkPlace & Scientific Word

The version package provides a way to include or exclude material conditionally from the LaTeX typesetting process. You can use the package to include in your document text, mathematics, graphics, and other materials that will never be typeset or that will be typeset at certain times but not others.

Package environments determine whether or not the information within the environment will be typeset. A predefined comment environment always excludes material from typesetting.

The advantage to using the version package instead of the Comment fragment included with the program is that the material is always displayed in the document window even though it may be ignored by LaTeX. You can also enter comments in the Document Info.

Including material that will never be typeset

  1. Add the version package to your document.

  2. Place the insertion point where you want the material to begin and enter a TeX field.

  3. In the entry area, type \begin{comment} and choose OK.

  4. Create the material you want to exclude from typesetting.

  5. At the end of the material, enter a TeX field.

  6. In the entry area, type \end{comment} and choose OK.

Including material that may or may not be typeset

  1. Add the version package to your document.

  2. Place the insertion point where you want the material to begin and enter a TeX field.

  3. In the entry area, type \begin{name} where name is any value that doesn't conflict with existing TeX values.

    The name is case-sensitive.

  4. Create the material you occasionally want to exclude from typesetting.

  5. At the end of the material, enter a TeX field.

  6. In the entry area, type \end{name} and choose OK.

  7. From the Typeset menu, choose Preamble.

  8. On a new line, type \includeversion{name} if you want to typeset the material or \excludeversion{name} if you don't.

  9. Choose OK.

You can define as many version environments as you want. The package is installed in the TCITeX/TeX/LaTeX/contrib/misc directory.

For more information, use an ASCII editor to open TCITeX/TeX/LaTeX/contrib/misc/version.sty in your program directory.

Last revised 02/13/06