← Back to branch summary

~chris-rogers/maus/emr_mc_digitization

« back to all changes in this revision

Viewing changes to doc/doc_src/detectors/tracker/01-Current/99-Styles/revtex4-1/README

  • Committer: Chris Rogers
  • Date: 2014-04-16 11:48:45 UTC
  • mfrom: (707 merge)
  • mto: This revision was merged to the branch mainline in revision 711.
  • Revision ID: chris.rogers@stfc.ac.uk-20140416114845-h3u3q7pdcxkxvovs
Update to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doc_src/detectors/tracker/01-Current/99-Styles/revtex4-1/README
1
 
%% ****** Start of file README ****** %
2
 
%%
3
 
%%   This file is part of the APS files in the REVTeX 4 distribution.
4
 
%%   Version 4.1r of REVTeX, August 2010.
5
 
%%
6
 
%%   Copyright (c) 1999, 2000, 2001, 2009, 2010 The American Physical Society.
7
 
%%
8
 
 
9
 
Last updated 09 August 2010
10
 
 
11
 
This file describes the contents of this distribution of REVTeX 4.1.
12
 
The definitive source of information about REVTeX 4 is the APS web
13
 
page http://authors.aps.org/revtex4/.
14
 
 
15
 
User queries should be directed to revtex@aps.org.
16
 
 
17
 
Manifest
18
 
--------
19
 
 
20
 
All files in this release are contained within the compressed archive
21
 
revtex4-1.zip. For installation instructions, see below.
22
 
 
23
 
NOTE: The only files necessary for running REVTeX 4.1 are those under 
24
 
tex/latex/revtex and bibtex/bst/revtex, but it is a good idea to install
25
 
the entire distribution, especially the documentation.
26
 
 
27
 
TeX inputs:          tex/latex/revtex/
28
 
                     -----------------  
29
 
revtex4-1.cls     - The REVTeX 4.1 class file
30
 
aps4-1.rtx        - APS-specific customizations for REVTeX 4.1
31
 
aip4-1.rtx        - AIP-specific customizations for REVTeX 4.1
32
 
apsrmp4-1.rtx     - APS-specific customizations for REVTeX 4.1,
33
 
                    specifically for Rev. Mod. Phys.
34
 
aps10pt4-1.rtx    - 10-point size class option file for REVTeX.
35
 
aps11pt4-1.rtx    - 11-point size class option file for REVTeX.
36
 
aps12pt4-1.rtx    - 12-point size class option file for REVTeX.
37
 
revsymb4-1.sty    - A collection of common symbols for use outside of REVTeX.
38
 
 
39
 
ltxdocext.sty     - Part of ltxgrid package used for page layout in REVTeX.
40
 
ltxfront.sty      - Part of ltxgrid package used for page layout in REVTeX.
41
 
ltxgrid.sty       - Part of ltxgrid package used for page layout in REVTeX.
42
 
ltxutil.sty       - Part of ltxgrid package used for page layout in REVTeX.
43
 
  
44
 
BibTeX inputs:       bibtex/bst/revtex/
45
 
                     ------------------ 
46
 
apsrev4-1.bst     - BibTeX styles for use for Phys. Rev. journals
47
 
apsrmp4-1.bst     - BibTeX styles for use for Rev. Mod. Phys.
48
 
aipauth4-1.bst    - BibTeX styles for AIP journals with author/year style citations
49
 
aipnum4-1.bst     - BibTeX styles for AIP journals with numerical style citations
50
 
 
51
 
 
52
 
Documentation:       doc/latex/revtex/
53
 
                     -----------------
54
 
README       - How to get started
55
 
DOWNLOAD     - How to download REVTeX4.1
56
 
 
57
 
Author guide:           doc/latex/revtex/auguide/
58
 
                        ------
59
 
auguide4-1.tex (pdf)  - REVTeX 4.1 Author's Guide
60
 
whatsnew4-1.tex (pdf) - What's New in REVTeX 4.1
61
 
summary.tex (pdf)     - REVTeX 4.1 Command and Options Summary
62
 
docs.sty              - Package used by REVTeX documentation
63
 
 
64
 
APS guide:              doc/latex/revtex/aps
65
 
                        ------
66
 
apsguide4-1.tex (pdf) - APS Author Guide for REVTeX 4.1
67
 
 
68
 
AIP guide:              doc/latex/revtex/aip
69
 
                        ------
70
 
aipguide4-1.tex (pdf) - Author's Guide to AIP Substyles for REVTeX 4.1
71
 
 
72
 
APS Sample document:    doc/latex/revtex/sample/aps
73
 
                        -------
74
 
apssamp.tex (pdf)  - A sample file showing most common features of an APS
75
 
                     REVTeX 4.1 document
76
 
fig_1.eps          - sample figure for apssamp.tex
77
 
fig_2.eps          - sample wide figure for apssamp.tex
78
 
vid_1a.eps         - sample figure for apssamp.tex
79
 
vid_1b.eps         - sample figure for apssamp.tex
80
 
apssamp.bib        - sample BibTeX source file for apssamp.tex
81
 
apstemplate.tex    - A template for APS authors to follow
82
 
 
83
 
AIP Sample document:    doc/latex/revtex/sample/aip
84
 
                        -------
85
 
aipsamp.tex (pdf)  - A sample file showing most common features of an AIP
86
 
                     REVTeX 4.1 document
87
 
fig_1.eps          - sample figure for apssamp.tex
88
 
fig_2.eps          - sample wide figure for apssamp.tex
89
 
aipsamp.bib        - sample BibTeX source file for apssamp.tex
90
 
aiptemplate.tex    - A template for APS authors to follow
91
 
 
92
 
 
93
 
Programmer's docs:      doc/latex/revtex/source/
94
 
                        -------
95
 
ltxdocext.pdf - Programmer's documentation for the ltxdocext package
96
 
ltxfront.pdf  - Programmer's documentation for the ltxfront  package
97
 
ltxgrid.pdf   - Programmer's documentation for the ltxgrid   package
98
 
ltxutil.pdf   - Programmer's documentation for the ltxutil   package
99
 
revtex4-1.pdf - Programmer's documentation for the revtex4-1 document class
100
 
aip.pdf       - Programmer's documentation for the AIP journal styles
101
 
 
102
 
Source files:        source/latex/revtex
103
 
                     -------------------
104
 
ltxdocext.dtx - The source file for the ltxdocext package
105
 
ltxfront.dtx  - The source file for the ltxfront package
106
 
ltxgrid.dtx   - The source file for the ltxgrid package
107
 
ltxutil.dtx   - The source file for the ltxutil package
108
 
revtex4-1.dtx - The source file for revtex4.cls and revsymb.sty.
109
 
aip.dtx       - The source file for AIP journal styles
110
 
 
111
 
Not Included   
112
 
------------
113
 
The following packages are required by REVTeX but are not
114
 
included in this distribution. Please obtain from CTAN
115
 
(Comprehensive TeX Archive Network), e.g. <http://www.ctan.org/>. Direct
116
 
links to the necessary files can be found at <http://authors.aps.org/revtex4/>.
117
 
 
118
 
natbib.dtx   - Version 8.31a or later; found in latex/contrib/natbib on CTAN
119
 
natbib.ins   - LaTeX this to create natbib.sty and natbib
120
 
               documentation from natbib.dtx
121
 
bm.dtx       - Bold math style - part of (current!) standard LaTeX2e tools
122
 
bm.sty       - generated from bm.dtx by running tools.ins
123
 
textcase.dtx - Found in latex/contrib/textcase on CTAN
124
 
textcase.ins - LaTeX this to generate textcase.sty from textcase.dtx
125
 
url.sty      - Found in latex/contrib/misc on CTAN
126
 
 
127
 
An up-to-date installation of AMS-LaTeX is also required for certain
128
 
documentclass options. Version 2.0 or higher is needed. It is
129
 
available from <http://www.ams.org/tex/>.
130
 
 
131
 
Recommended styles and packages
132
 
--------------------------
133
 
With REVTeX implemented as a native LaTeX2e document class, users can 
134
 
take advantage of many of the well-supported LaTeX2e packages available.
135
 
Here are some that are particularly useful and recommended.
136
 
 
137
 
longtable.sty for tables running to multiple pages - part of a
138
 
standard LaTeX2e distribution.
139
 
 
140
 
hyperref.sty for hyperlinking - should work well with REVTeX 4.1.
141
 
 
142
 
graphics.sty and graphicx.sty for figure inclusion - part of LaTeX2e's
143
 
standard distribution.
144
 
 
145
 
Installation
146
 
------------
147
 
You already started the installation process by unzipping revtex4-1.zip.
148
 
As you will have seen, it created a directory revtex4.1 containing
149
 
this file README, the file DOWNLOAD, and the file revtex4-1-tds.zip, which
150
 
contains the bulk of the installation.
151
 
 
152
 
To install this software into a TDS-compliant TeX installation, like
153
 
TeX Live, working as root, issue a shell command like
154
 
 
155
 
  unzip revtex4-1-tds.zip -d /usr/local/texlive/texmf-local/
156
 
  
157
 
where the destination for the unzipped files is, in this example, 
158
 
appropriate for a local modificaton of a sufficiently recent distribution
159
 
of TeX Live. You may of course choose a different destination depending 
160
 
on your particular requirements. 
161
 
 
162
 
After installation, files will be located as per the Manifest above.
163
 
 
164
 
Run the appropriate update command (mktexlsr, initexmf -u, etc.); under
165
 
TeX Live that would be (as root)
166
 
 
167
 
   mktexlsr /usr/local/texlive/texmf-local
168
 
 
169
 
Install required packages (AMS-LaTeX, natbib, textcase, and bm). 
170
 
Please consult the documentaton for your local TeX package for more information. 
171
 
MikTeX users should use a recent version (see http://miktex.org/) and consult
172
 
the documentation there. There are several steps you will have to do. Please
173
 
note that the steps given here may change with future versions of MikTeX, but
174
 
the basic steps should be quite similar.
175
 
  1) Create a texmf-local directory if needed. For example, you might create
176
 
     a directory such as C:\local\miktex\texmf-local.
177
 
  2) Tell MikTeX where your texmf-local directory is. Find the MikTeX Options
178
 
     window and look for the "Roots" tab. If your texmf-local directory
179
 
     is not listed, click "Add" and add it.
180
 
  3) Unzip the revtex4-1-tds.zip (part of the REVTeX distribtution) in your
181
 
     texmf-local directory.
182
 
  4) Update the "File Name Database (FNDB)." This step is essential and
183
 
     it registers all of the files in your texmf-local directory with MikTeX.
184
 
     Do this by clicking on "Refresh FNDB" in the General tab of the MikTeX
185
 
     Options window.
186
 
     
187
 
MikTex also comes with a package manager. This can be an easier way to maintain
188
 
the packages installed on your system. However, please note that the packages
189
 
available may not be the most current version of the packages.
190
 
 
191
 
Credits
192
 
-------
193
 
David Carlisle created the first draft of REVTeX 4; Arthur Ogawa has 
194
 
supported the TeX development since. Patrick Daly was so kind as to 
195
 
incorporate needed changes into natbib and custom-bib. All worked under 
196
 
commission from the APS. Mark Doyle, APS Assistant Director, Journal
197
 
Information Systems coordinated the effort, which was partly underwritten
198
 
by the American Institute of Physics. The APS is the maintainer of REVTeX,
199
 
and all bugs are our responsibility. Please e-mail feedback to revtex@aps.org.
200
 
 
201
 
Backwards compatibility
202
 
-----------------------
203
 
The REVTeX 4.1 class file has been named revtex4-1.cls to distinguish it
204
 
from its predecessors. If the class file is copied to revtex4.cls,
205
 
files created with earlier versions of REVTeX 4 should still work.
206
 
 
207
 
LaTeX2e requirements
208
 
--------------------
209
 
REVTeX 4 requires: 
210
 
LaTeX2e [1996/06/01],
211
 
natbib  [2009/11/07]
212
 
textcase