% $Id: README.txt,v 1.11 2001/04/12 11:11:06 latex3 Exp $

This distribution implements a class for the conference proceedings
which have layouts close to those of the AIP proceedings.

Currently it supports:

  AIP Conference Proceedings  6in   x 9in single column 
  AIP Conference Proceedings  8.5in x 9in single column 
  AIP Conference Proceedings  8.5in x 9in double column 
  ARLO --- Acoustics Research Letters Online

The features of the class are described in aipguide (.pdf or .tex).
Special requirements or restrictions for the above layouts are given
at the end of this guide!


General requirements and restrictions:
======================================

This class was designed to work with LaTeX release 1999/6/01 or a
later version. However releases from late 1996 onwards will work
correctly if the installation is complete, ie contains all required
files which may not be the case.

Releases earlier than 1996/12/01 might compile the documents but will
*not* result in correct output due to some bugs in these earlier
releases! (In addition you need to have at least a newer version of
docstrip.tex to install the aipproc distribution.)

With the exception of the packages natbib.sty and url.sty the class
only requires files which are part of a standard LaTeX distribution,
i.e., it will work if your installation contains the following
standard components: BASE, TOOLS, GRAPHICS, PSNFSS and the above
packages.

If your installation does not fulfill the above requirements you may
have to upgrade your LaTeX to be able to use this class.

You can test your installation by running the file aipcheck.tex
through your version of LaTeX. It will try to determine if everything
necessary is available and if not will make recommendations what can
be done about it. In certain cases you might be able to use the class
if you follow the suggestions, in other cases the only solution is to
upgrade your LaTeX.

The most recent LaTeX as well as natbib.sty and url.sty can be
obtained from CTAN sites (Comprehensive TeX Archive Network).

Refer to http://www.tug.org for more information on CTAN and TeX in
general.

A ready to run TeX system for various platforms which has everything
required is available on CD-ROM, look into
http://www.tug.org/texlive.html.


Files in the distribution:
==========================

Class file:
-----------

aipproc.dtx	Documented source of the main class file

aipxfm.sty	Front matter part of aipproc.

aip-*.clo	Several layout files that implement layout styles for
		different proceeding styles


Included package files used by class:
-------------------------------------

fix2col.dtx	Source version v0.03 of this package, earlier releases
		contain some severe bugs.
		This package is only included for people with older
		LaTeX installations and not necessary with an
		up-to-date release.

Install script:
---------------

aipproc.ins	file to unpack aipproc.dtx and fix2col.dtx


BibTeX support:
---------------

aipproc.bst	BibTeX style file implementing something close the 
		requested layout for the AIP proceedings --- 
                to be used if natbib is available.


aipprocl.bst	BibTeX style file implementing something close the 
		requested layout for the AIP proceedings ---
		should only be used if natbib is not installed!


arlonum.bst	BibTeX style file implementing the ARLO layout for numerical
		references (i.e., when class option numcites is
		selected) --- requires natbib.

arlobib.bst	BibTeX style file implementing the ARLO layout for
		bibliographic references (i.e., when class option
		bibliocites is 	selected) --- requires natbib.


Documentation files:
--------------------

aipguide.tex	Guide explaining all the features of the aipproc class.
		To successfully process this file a reasonable new LaTeX
		release is required (see section "General requirements and 
		restrictions" below).
                It is also necessary to first unpack aipproc.dtx to
		obtain aipproc.cls etc.

aipguide.pdf	Processed version of aipguide in PDF format. You
		should be able to view this with Adobe's Acrobat
		Reader which is available free of charge for most
		platforms.

aipguide-xx.pdf Special versions of the aipguide related to a specific
		proceeding layout, e.g., aipguide-arlo.pdf would describe
		only features needed the ARLO proceeding.
		These guides are not part of the distribution but
		might be provided.

Test files:
-----------

aipcheck.tex	Checks the LaTeX installation for possible problems,
		used by sample.tex and aipguide.tex.

sample.tex 	A sample article that can be used to produce the
		various layouts supported by this class.

sample.bib	bib file for sample.tex

*.eps		a few PS files used as figures in sample.tex and aipguide.tex



Misc files:
-----------

README.txt	this file

ChangeLog.fmi	documentation of changes to the files

aipdoc.cls	Used for code documentation.


Major packages used by class but not included:
----------------------------------------------

calc.sty	part of standard LaTeX tools distribution

graphicx.sty	part of standard LaTeX graphics distribution

mathptm.sty	implements Times as math fonts. part of standard LaTeX
                psnfss distribution

mathtime.sty	implements commercial MathTime fonts as math fonts.
		package is available on CTAN, fonts must be purchased from Y&Y

fontenc.sty	part of standard LaTeX

times.sty	part of standard LaTeX psnfss distribution

textcomp.sty	part of standard LaTeX

natbib.sty	implements extended citation. should be available on
		any good LaTeX installation.

url.sty		implements URL support. should be available on
		any good LaTeX installation.


Installation:
=============

To unpack the distribution run aipproc.ins through LaTeX. This will
produce aipproc.cls and fix2col.sty. If this step fails than your
version of docstrip.tex is too old (you probably have a LaTeX
distribution prior to 1996/12/01).

Check if you have a later version of fix2col.sty, if so delete the
version coming with this distribution.

You may have to move or copy all files with the extensions .cls .clo
and .sty into a directory in which LaTeX finds them.

You may have to move the file with the extension .bst into a directory
in which BibTeX finds them.


Documentation:
==============

To produce the general guide, run aipguide.tex three times through LaTeX.
                                               ^^^^^^^^^^^
The file aipguide.tex will test your LaTeX installation for
completeness and reports any problems noticed.


To produce the code documentation run the aipproc.dtx or the
fix2col.dtx file through LaTeX.


Producing samples:
==================

The file sample.tex can be used to produce samples for each proceeding
layout. For this it will interactively ask two questions when you run
through LaTeX:

 - any class options?    (you will normally answer with <RETURN> here
			  unless you wish to test some of the options
			  explained in aipguide.tex )

 - which layout style?   (here you have to name the layout style you
			  wish to produce, for example "6x9". A list
			  of choices will be presented at this point.)


So the way to proceed is

 latex sample              % answer questions
 bibtex sample		   % make bibliography
 latex sample		   % for fixing references
 latex sample		   % fix more references (depending on the
			   % style this might be necessary)

view or print sample.dvi


Precompiled samples (might not be distributed):
-----------------------------------------------

The distribution might contain a subdirectory or an archive with
various samples produced with the above method. 

sample-6s.ps   Postscript generated from sample.tex showing the AIP
	       6x9 proceedings layout

sample-8s.ps   Postscript generated from sample.tex showing the AIP
	       8.5x11 proceedings single column layout

sample-8d.ps   Postscript generated from sample.tex showing the AIP
	       8.5x11 proceedings double column layout

sample-arlo.ps   Postscript generated from sample.tex showing the ARLO
	       layout with options "unnumberedheadings", "numcites",
	       and "draft" (multimedia figures still showing links and
	       title and page numbers are shown in a footer line).
	       For the bibliography generation the BibTeX style
	       "arlonum" was used.

sample-arlob.ps   Postscript generated from sample.tex showing the ARLO
	       layout with options "numberedheadings", "bibliocites",
	       and "final" (multimedia figures in final form and
	       no footer line).
	       For the bibliography generation the BibTeX style
	       "arlobib" was used.





Notes:
======

To run correctly the graphics package needs to be properly customized
for the site. This should be the case on standard installations; if
not, review cfgguide.tex and the graphics package documentation.

The natbib.sty is a powerful citation system which offers several
commands beside \cite. It comes with its own documentation, e.g.,
natnotes.tex.
