summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chet
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-10-28 23:44:33 +0000
committerKarl Berry <karl@freefriends.org>2011-10-28 23:44:33 +0000
commit986937b3263b9632cc4a1bcf6db9044152efbfff (patch)
treedf1ef6c593a9a6392440abf79c19205f28c231f6 /Master/texmf-dist/doc/latex/chet
parent428705d44379becd889634d0b8a21d5f6eda12b9 (diff)
chet (28oct11)
git-svn-id: svn://tug.org/texlive/trunk@24432 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chet')
-rw-r--r--Master/texmf-dist/doc/latex/chet/README18
-rw-r--r--Master/texmf-dist/doc/latex/chet/chetdoc.pdfbin168347 -> 168185 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chet/chetdoc.tex185
3 files changed, 151 insertions, 52 deletions
diff --git a/Master/texmf-dist/doc/latex/chet/README b/Master/texmf-dist/doc/latex/chet/README
index d8f51b03534..71a75e47292 100644
--- a/Master/texmf-dist/doc/latex/chet/README
+++ b/Master/texmf-dist/doc/latex/chet/README
@@ -1,11 +1,13 @@
-This material is subject to the LaTeX Project Public License.
-See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
-for the details of that license.
+This material is subject to the LaTeX Project Public License. See
+http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for
+the details of that license.
-The "chet" class (class for high-energy theory) is inspired by Paul Ginsparg's harvmac,
-but uses LaTeX2e instead of TeX. The commands provided are to be used as faster
-alternatives to LaTeX's default environments (which can all still be used in chet).
+The chet package is inspired by Paul Ginsparg's harvmac, but uses
+LaTeX2e instead of TeX. The commands provided are to be used as faster
+alternatives to LaTeX's default environments (which can all still be
+used in chet).
-To use chet just copy chet.cls in the folder of the TeX file you are compiling (or in
-your path) and start your TeX file with \documentclass{chet}. \ No newline at end of file
+To use chet just copy chet.sty in the folder of the TeX file you are
+compiling (or in your path) and include \usepackage{chet} in the
+preamble of your LaTeX file. \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/chet/chetdoc.pdf b/Master/texmf-dist/doc/latex/chet/chetdoc.pdf
index a18d9f6ff18..732abd5881b 100644
--- a/Master/texmf-dist/doc/latex/chet/chetdoc.pdf
+++ b/Master/texmf-dist/doc/latex/chet/chetdoc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chet/chetdoc.tex b/Master/texmf-dist/doc/latex/chet/chetdoc.tex
index c8477a269ab..97604d65430 100644
--- a/Master/texmf-dist/doc/latex/chet/chetdoc.tex
+++ b/Master/texmf-dist/doc/latex/chet/chetdoc.tex
@@ -1,7 +1,7 @@
% chetdoc.tex
% Copyright 2011 Andreas Stergiou
%
-% This is an example file for the use of chet.
+% This is an example file for the use of the package chet.
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
@@ -11,31 +11,37 @@
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
-\documentclass{chet}
+\documentclass[12pt]{article}
\usepackage{textcomp}
+\usepackage{chet}
\draftmode %Comment this for labels on the right margin to go away.
\preprint{UCSD-PTH-11-08}
-\title{The \texttt{chet} class}
+\title{The \texttt{chet} package}
-\author{%
-Andreas Stergiou$^{\ast,}$\email{stergiou@physics.ucsd.edu} and Author2$^{\ast,\dagger,}$\email{address2@example.com}
-}
+\author{Andreas Stergiou$^{\ast,}$\email{stergiou@physics.ucsd.edu} and
+Author2$^{\ast,\dagger,}$\email{address2@example.com}}
-\affiliation{%
-$^{\ast}$Department of Physics, University of California, San Diego, La Jolla, CA 92093 USA\\
-$^{\dagger}$Department of Physics, University of Somewhere Else, \ldots}
+\affiliation{$^{\ast}$Department of Physics, University of California, San
+Diego, La Jolla, CA 92093 USA\\ $^{\dagger}$Department of Physics,
+University of Somewhere Else, \ldots}
-\abstract{%
-This is a sample produced with \texttt{chet}. This class is inspired by Paul Ginsparg's \texttt{harvmac}, but uses \LaTeXe\ instead of \TeX. The commands provided are to be used as faster alternatives to \LaTeXe's default environments (which can all still be used in \texttt{chet}).
-\begin{center}
-(\texttt{chet} can be found at \href{http://www.ctan.org/pkg/chet}{\texttt{http://www.ctan.org/pkg/chet}}.)
-\end{center}
-}
+\abstract{This is a sample produced using \texttt{chet}. This package is
+inspired by Paul Ginsparg's \texttt{harvmac}, but uses \LaTeXe\ instead of
+\TeX. The commands provided are to be used as faster alternatives to
+\LaTeXe's default environments (which can all still be used with
+\texttt{chet}).
+
+\begin{center}
+ %
+ (\texttt{chet} can be found at
+ \href{http://www.ctan.org/pkg/chet}{\texttt{http://www.ctan.org/pkg/chet}}.)
+\end{center} }
+\date{June 2011}
\begin{document}
\maketitle
@@ -43,62 +49,152 @@ This is a sample produced with \texttt{chet}. This class is inspired by Paul Gin
\toc
\newsec{Basic commands}[SecLabel]
+%
\subsec{Preamble}
-To use \verb1chet1 type \verb1\documentclass{chet}1 in the beginning of your \LaTeX\ file. For labels of equations, sections, etc.\ to appear on the margins, you can use the command \verb1\draftmode1.
-
-In the preamble of the document one also specifies the preprint number, authors' email addresses, and the abstract (see usage in this example file). If you want to have only one footnote with all the email addresses and without footnote marks, then you can use the command \verb1\emails{}1 inside the \verb1\author{}1 environment. If a specific date is desired, then just include \verb1\date{}1 with the desired date in the preamble of your document, and the default current date on the bottom left of the title page will be substituted with the one you specified.
-
-It is suggested that authors compile straight to \texttt{pdf} with \texttt{pdflatex}, i.e.\ following \TeX\textrightarrow\verb1PDF1. The compilation method \TeX\textrightarrow\verb1DVI1\textrightarrow\verb1PS1\textrightarrow\verb1PDF1 is obsolete and redundant, and should not be used. As far as I know the only problem that arises frequently with \TeX\textrightarrow\verb1PDF1 is the inability to obtain \verb1psfrag1 replacements in \verb1eps1 figures; that can be taken care of very easily with the package \verb1pstool1.
+%
+To use \verb1chet1 start with \verb1\documentclass{article}1 and include
+\verb1\usepackage{chet}1 in the preamble of your \LaTeX\ file. For labels
+of equations, sections, etc.\ to appear on the margins, you can use the
+command \verb1\draftmode1.
+
+In the preamble of the document one also specifies the preprint number,
+authors' email addresses, and the abstract (see usage in this example
+file). If you want to have only one footnote with all email addresses
+and without footnote marks, then you can use the command \verb1\emails{}1
+inside the \verb1\author{}1 environment. If a specific date is desired,
+then just include \verb1\date{}1 with the desired date in the preamble of
+your document, and the default current date on the bottom left of the title
+page will be substituted with the one you specified.
+
+It is suggested that authors compile straight to \texttt{pdf} with
+\texttt{pdflatex}, i.e.\ following \TeX\textrightarrow\verb1PDF1. The
+compilation method
+\TeX\textrightarrow\verb1DVI1\textrightarrow\verb1PS1\textrightarrow\verb1PDF1
+is obsolete and redundant, and should not be used. As far as I know the
+only problem that arises frequently with \TeX\textrightarrow\verb1PDF1 is
+the inability to obtain \verb1psfrag1 replacements in \verb1eps1 figures;
+that can be taken care of very easily with the package \verb1pstool1.
\subsec{Sections}
-Sections start with the command \verb1\newsec{}[]1. The first argument is the name of the section, while the second provides the label. You can refer back to sections simply by putting a slash in front of their label. For example, if you write \verb1\newsec{Name}[Label]1 you can just type \verb1\Label1 in the subsequent text and the number of the section will appear, e.g.\ you can refer to section \SecLabel. Note that if you are referring to a label you define in a later line, for example you want to refer to a later section, then the default \verb1\ref{Label}1 is needed.\foot{The same holds for all references to equations defined with the commands outlined in this section.} Note, also, that the second argument of the command can be omitted altogether, i.e.\ the command \verb1\newsec{}1 starts a section but does not give it a label. The commands \verb1\subsec{}[]1 and \verb1\subsubsec{}[]1 that define subsections and subsubsections respectively, are similarly defined.
+%
+Sections start with the command \verb1\newsec{}[]1. The first argument is
+the name of the section, while the second provides the label. You can refer
+back to sections simply by putting a slash in front of their label. For
+example, if you write \verb1\newsec{Name}[Label]1 you can just type
+\verb1\Label1 in the subsequent text and the number of the section will
+appear, e.g.\ you can refer to section \SecLabel. Note that if you are
+referring to a label you define in a later line, for example you want to
+refer to a later section, then the default \verb1\ref{Label}1 is
+needed.\foot{The same holds for all references to equations defined with
+the commands outlined in this section.} Note, also, that the second
+argument of the command can be omitted altogether, i.e.\ the command
+\verb1\newsec{}1 starts a section but does not give it a label. The
+commands \verb1\subsec{}[]1 and \verb1\subsubsec{}[]1 that define
+subsections and subsubsections respectively, are similarly defined.
\subsec{Equations}
-For equations use the command \verb1\eqn{}[]1. Again, inside \verb1{}1 you write the equation and inside \verb1[]1 the label, if you want one. An equation number will appear only if you do type \verb1[Label]1.\foot{If you leave the \texttt{[]} empty, the equation is going to get a number but not a label. If you don't type the \texttt{[]} at all, then the equation will have no number.} For example, If you give the label \verb1EqMagic1 to an equation,
-\eqn{e^{i\pi}+1=0,}[EqMagic]
-then you can just type \verb1\EqMagic1 to reference it, \EqMagic. For aligned equations with one number in the vertical middle use the command \verb1\eqna{}[]1. A single \verb1&1 indicates the alignment point, while \verb1\\1 indicates a line break. For example,
-\eqna{\cos^2 \theta+\sin^2 \theta &=1, \\ \cos^2 \theta-\sin^2 \theta&=\cos 2\theta.}[EqTrig]
-You can later refer to equation \EqTrig with \verb1\EqTrig1.
-
-Commands that simplify the writing of subequations are also supplied for two, three, and four subequations. They are, respectively, \verb1\twoseqn{}[]{}[][]1, \verb1\threeseqn{}[]{}[]1 \verb1{}[][]1, and \verb1\fourseqn{}[]{}[]{}[]{}[][]1. Each pair of \verb1{}[]1 receives an equation and a label,\foot{If you don't want to label a subequation leave the corresponding \texttt{[]} empty.} while the last \verb1[]1 is used for an overall label and can be omitted. Each of the equations has an \verb1&1 at the alignment point. For example, equation \EqTrig could be written as
-\twoseqn{\cos^2 \theta+\sin^2 \theta&=1,}[FTrig]{\cos^2 \theta-\sin^2 \theta&=\cos 2\theta.}[STrig][TrigAll]
-You can then refer to \FTrig, \STrig, or \TrigAll. More complicated structures with subequations can be achieved with the corresponding \texttt{amsmath} environment. Note that all equation environments define labels that can be used only later in the text with \verb1\Label1. The original \verb1\eqref{Label}1 is otherwise needed. In the rare occasion that the name of your label coincides with the name of a \LaTeXe\ command, you will get an error and the file won't compile. In that case, just change the name of your label.
+%
+For equations use the command \verb1\eqn{}[]1. Again, inside \verb1{}1 you
+write the equation and inside \verb1[]1 the label, if you want one. An
+equation number will appear only if you do type \verb1[Label]1.\foot{If you
+leave the \texttt{[]} empty, the equation is going to get a number but not
+a label. If you don't type the \texttt{[]} at all, then the equation will
+have no number.} For example, If you give the label \verb1EqMagic1 to an
+equation, \eqn{e^{i\pi}+1=0,}[EqMagic] then you can just type
+\verb1\EqMagic1 to reference it, \EqMagic. For aligned equations with one
+number in the vertical middle use the command \verb1\eqna{}[]1. A single
+\verb1&1 indicates the alignment point, while \verb1\\1 indicates a line
+break. For example, \eqna{\cos^2 \theta+\sin^2 \theta &=1, \\ \cos^2
+\theta-\sin^2 \theta&=\cos 2\theta.}[EqTrig] You can later refer to
+equation \EqTrig with \verb1\EqTrig1.
+
+Commands that simplify the writing of subequations are also supplied for
+two, three, and four subequations. They are, respectively,
+\verb1\twoseqn{}[]{}[][]1, \verb1\threeseqn{}[]{}[]1 \verb1{}[][]1, and
+\verb1\fourseqn{}[]{}[]{}[]{}[][]1. Each pair of \verb1{}[]1 receives an
+equation and a label,\foot{If you don't want to label a subequation leave
+the corresponding \texttt{[]} empty.} while the last \verb1[]1 is used for
+an overall label and can be omitted. Each of the equations has an \verb1&1
+at the alignment point. For example, equation \EqTrig could be written as
+\twoseqn{\cos^2 \theta+\sin^2 \theta&=1,}[FTrig]{\cos^2 \theta-\sin^2
+\theta&=\cos 2\theta.}[STrig][TrigAll] You can then refer to \FTrig,
+\STrig, or \TrigAll. More complicated structures with subequations can be
+achieved with the corresponding \texttt{amsmath} environment. Note that all
+equation environments define labels that can be used only later in the text
+with \verb1\Label1. The original \verb1\eqref{Label}1 is otherwise needed.
+In the rare occasion that the name of your label coincides with the name of
+a \LaTeXe\ command, you will get an error and the file won't compile. In
+that case, just change the name of your label.
\subsec{Citations}
-To cite a paper use the command \verb1\rcite{}1. (The default command \verb1\cite{}1 can still be used.) The syntax is exactly the same as in \verb1\cite1, but, if \verb1\draftmode1 is used, \verb1\rcite1 presents the label of the citation as an exponent to the citation number wherever that appears (except in the bibliography, where the label appears on the left margin).
-
-The \verb1.bib1 file can be included in the main \verb1.tex1 file, preferably at the end, right before the \verb1\end{document}1. The way to do this is with the environment
+%
+To cite a paper use the command \verb1\rcite{}1. (The default command
+\verb1\cite{}1 can still be used.) The syntax is exactly the same as in
+\verb1\cite1, but, if \verb1\draftmode1 is used, \verb1\rcite1 presents the
+label of the citation as an exponent to the citation number wherever that
+appears (except in the bibliography, where the label appears on the left
+margin).
+
+The \verb1.bib1 file can be included in the main \verb1.tex1 file,
+preferably at the end, right before the \verb1\end{document}1. The way to
+do this is with the environment
+%
\begin{verbatim}
\begin{filecontents}{bibname.bib}
Your citations go here...
\end{filecontents}
\end{verbatim}
-Here, \verb1bibname.bib1 should be substituted with the name of the \verb1.bib1 file that you call in the command \verb1\bibliography{}1.\foot{The functions supported from the \texttt{.bst} style file are \texttt{@article}, \texttt{@book}, \texttt{@inbook}, and \texttt{@inproceedings}.} (See usage in this example file.) Note that you still have to run Bib\TeX\ to compile the bibliography.
+%
+Here, \verb1bibname.bib1 should be substituted with the name of the
+\verb1.bib1 file that you call in the command
+\verb1\bibliography{}1.\foot{The functions supported from the \texttt{.bst}
+style file are \texttt{@article}, \texttt{@book}, \texttt{@inbook}, and
+\texttt{@inproceedings}.} (See usage in this example file.) Note that you
+still have to run Bib\TeX\ to compile the bibliography.
-For example, scale does not imply conformal invariance in $4-\epsilon$ dimensions as demonstrated in \rcite{FGS}.
+For example, scale does not imply conformal invariance in $4-\epsilon$
+dimensions as demonstrated in \rcite{FGS}.
-\ack{I would like to thank Ken Intriligator, Ben Grinstein, and Jean-Fran\c{c}ois Fortin for adopting \texttt{chet}, and for their numerous suggestions and tips that helped me improve the class.
+\ack{I would like to thank Ken Intriligator, Ben Grinstein, and
+Jean-Fran\c{c}ois Fortin for adopting \texttt{chet}, and for their numerous
+suggestions and tips that helped me improve the package.
-Several \LaTeX\ packages are called by default by \texttt{chet}. In alphabetical order, they are \texttt{amsmath}, \texttt{appendix}, \texttt{caption}, \texttt{cite}, \texttt{collref}, \texttt{datetime}, \texttt{filecontents}, \texttt{footmisc}, \texttt{geometry}, \texttt{hyperref}, \texttt{manyfoot}, \texttt{pifont}, \texttt{showkeys}, \texttt{tocloft}, \texttt{xparse}, and \texttt{xspace}. I would like to thank the authors of these great packages for their amazing work!}
+Several \LaTeX\ packages are called by default by \texttt{chet}. In
+alphabetical order, they are \texttt{amsmath}, \texttt{appendix},
+\texttt{caption}, \texttt{cite}, \texttt{collref}, \texttt{datetime},
+\texttt{filecontents}, \texttt{footmisc}, \texttt{geometry},
+\texttt{hyperref}, \texttt{manyfoot}, \texttt{pifont}, \texttt{showkeys},
+\texttt{tocloft}, \texttt{xparse}, and \texttt{xspace}. I would like to
+thank the authors of these great packages for their amazing work!}
\appendix
\newsec{Other commands}
+%
Commands often used include
+%
\begin{itemize}
-\item \verb1\toc1: produces the table of contents.
-\item \verb1\foot{}1: produces footnotes.
-\item \verb1\ack{}1: used for acknowledgements.
-\item \verb1\appendix1: used before the appendices.
-\item \verb1\bibliography{}1: produces the bibliography.
+ \item \verb1\toc1: produces the table of contents.
+ \item \verb1\foot{}1: produces footnotes.
+ \item \verb1\ack{}1: used for acknowledgements.
+ \item \verb1\appendix1: used before the appendices.
+ \item \verb1\bibliography{}1: produces the bibliography.
\end{itemize}
+
\newsec{Conference proceedings}
-If you want to use the macros for equations and sections defined in \texttt{chet}, but have to use another \texttt{.cls} or \texttt{.sty} file, for example for conference proceedings, then you can just copy and paste the contents of \texttt{chetmacros.txt} in the preamble of your \texttt{.tex} file.
+%
+If you want to use the macros for equations and sections defined in
+\texttt{chet}, but have to use another \texttt{.sty} file,
+for example for conference proceedings, then you can just copy and paste
+the contents of \texttt{chetmacros.txt} in the preamble of your
+\texttt{.tex} file.
+
\bibliography{chetdocbib}
+
\begin{filecontents}{chetdocbib.bib}
@article{FGS,
author = "Fortin, Jean-Francois and Grinstein, Benjamin and Stergiou,
@@ -112,4 +208,5 @@ If you want to use the macros for equations and sections defined in \texttt{chet
}
\end{filecontents}
-\end{document} \ No newline at end of file
+
+\end{document}