summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chet
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-17 23:13:58 +0000
committerKarl Berry <karl@freefriends.org>2011-05-17 23:13:58 +0000
commitebabb68f273387fc705c6b98868bf6cfaf42cb0f (patch)
treee434258d09d3a51c89821699be44c22089eea9ad /Master/texmf-dist/doc/latex/chet
parentc7ac449f0aede549bd987568506dd60f716d936b (diff)
new latex package chet (17may11)
git-svn-id: svn://tug.org/texlive/trunk@22512 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chet')
-rw-r--r--Master/texmf-dist/doc/latex/chet/chetdoc.tex105
-rw-r--r--Master/texmf-dist/doc/latex/chet/chetmacros.txt77
2 files changed, 182 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/chet/chetdoc.tex b/Master/texmf-dist/doc/latex/chet/chetdoc.tex
new file mode 100644
index 00000000000..baceaaa69f4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/chet/chetdoc.tex
@@ -0,0 +1,105 @@
+% chetdoc.tex
+% Copyright 2011 Andreas Stergiou
+%
+% This is an example file for the use of chet.
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+
+\documentclass{chet}
+
+\usepackage{textcomp}
+
+\draftmode %Comment this for labels on the right margin to go away.
+\multaffil %Comment this if all authors have the same affiliation. (Also put all authors in the same \author{}.)
+
+\preprint{UCSD-PTH-11-08}
+\title{The \texttt{chet} class}
+\author[$\ast$]{Andreas Stergiou\email{1}{stergiou@physics.ucsd.edu}}
+\affiliation[$\ast$]{Department of Physics, University of California, San Diego, La Jolla, CA 92093 USA}
+\author[$\ast$$\dagger$]{Author2\email{2}{address2@example.com}}
+\affiliation[$\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 the obsolete \TeX. The commands provided are to be used as faster alternatives to \LaTeXe's default environments.}
+
+\begin{document}
+\maketitle
+
+\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. The command \verb1\multaffil1 should be used if the coauthors are affiliated with different institutions. If all coauthors have the same affiliation, their names should all be in the same \verb1\author{}1, and the command \verb1\multaffil1 should not be issued. In the preamble of the document one also specifies the preprint number, authors' email addresses, and the abstract (see usage in this example file).
+
+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.
+
+\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.
+
+\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 incuded 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. (See usage in this example file.)
+
+For example, the form of the three-point function in superconformal theories is not fixed up to a constant, as explained in \rcite{Osb98}.
+
+\ack{I would like to thank Ken Intriligator and Jean-Fran\c{c}ois Fortin for adopting \texttt{chet}, and for their numerous suggestions and tips that helped me improve the class.
+
+Several \LaTeX\ packages are called by default by \texttt{chet}. In alphabetical order, they are \texttt{amsmath}, \texttt{appendix}, \texttt{authblk}, \texttt{caption}, \texttt{cite}, \texttt{collref}, \texttt{datetime}, \texttt{filecontents}, \texttt{geometry}, \texttt{hyperref}, \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.
+\end{itemize}
+
+\newsec{Conference proceedings}
+If you want to use the macros for equations and sections defined in \texttt{chet}, but you 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.
+
+\bibliography{chetdocbib}
+
+\begin{filecontents}{chetdocbib.bib}
+@article{Osb98,
+ author = "Osborn, Hugh",
+ title = "{$\mathcal{N}=1$ superconformal symmetry in four-dimensional quantum
+ field theory}",
+ journal = "Annals Phys.",
+ volume = "272",
+ pages = "243-294",
+ doi = "10.1006/aphy.1998.5893",
+ year = "1999",
+ eprint = "hep-th/9808041",
+ archivePrefix = "arXiv",
+ primaryClass = "hep-th",
+}
+\end{filecontents}
+
+\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/chet/chetmacros.txt b/Master/texmf-dist/doc/latex/chet/chetmacros.txt
new file mode 100644
index 00000000000..793328cc79e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/chet/chetmacros.txt
@@ -0,0 +1,77 @@
+\usepackage{xparse}
+\usepackage{xspace}
+% Numbered equation with optional label
+\NewDocumentCommand\eqn{mo}{%
+ \IfNoValueTF{#2}
+ {\[ #1 \]}
+ {\begin{equation}\label{#2} #1 \end{equation} \expandafter\newcommand\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces}
+}
+
+% Numbered aligned equation with optional label in the vertical middle
+\NewDocumentCommand\eqna{mo}{%
+ \IfNoValueTF{#2}
+ {\begin{align*} #1 \end{align*}}
+ {\begin{equation}\label{#2}\begin{split} #1 \end{split}\end{equation} \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces}
+}
+
+% Numbered subequations
+% Two subequations
+\NewDocumentCommand\twoseqn{momoo}{%
+ \IfNoValueTF{#5}
+ {\begin{subequations}\begin{align} #1\label{#2} \\ #3 \label{#4} \end{align}\end{subequations} \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces}
+ {\begin{subequations}\label{#5}\begin{align} #1\label{#2} \\ #3 \label{#4} \end{align}\end{subequations} \expandafter\def\csname #5\endcsname{\eqref{#5}\xspace}\ignorespaces \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces}
+}
+% Three subequations
+\NewDocumentCommand\threeseqn{momomoo}{%
+ \IfNoValueTF{#7}
+ {\begin{subequations}\begin{align} #1\label{#2} \\ #3 \label{#4} \\ #5 \label{#6} \end{align}\end{subequations} \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces \expandafter\def\csname #6\endcsname{\eqref{#6}\xspace}\ignorespaces}
+ {\begin{subequations}\label{#7}\begin{align} #1\label{#2} \\ #3 \label{#4} \\ #5 \label{#6} \end{align}\end{subequations} \expandafter\def\csname #7\endcsname{\eqref{#7}\xspace}\ignorespaces \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces \expandafter\def\csname #6\endcsname{\eqref{#6}\xspace}\ignorespaces}
+}
+
+% Four subequations
+\NewDocumentCommand\fourseqn{momomomoo}{%
+ \IfNoValueTF{#9}
+ {\begin{subequations}\begin{align} #1\label{#2} \\ #3 \label{#4} \\ #5 \label{#6} \\ #7\label{#8} \end{align}\end{subequations} \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces \expandafter\def\csname #6\endcsname{\eqref{#6}\xspace}\ignorespaces \expandafter\def\csname #8\endcsname{\eqref{#8}\xspace}\ignorespaces}
+ {\begin{subequations}\label{#9}\begin{align} #1\label{#2} \\ #3 \label{#4} \\ #5 \label{#6} \\ #7\label{#8} \end{align}\end{subequations} \expandafter\def\csname #9\endcsname{\eqref{#9}\xspace}\ignorespaces \expandafter\def\csname #2\endcsname{\eqref{#2}\xspace}\ignorespaces \expandafter\def\csname #4\endcsname{\eqref{#4}\xspace}\ignorespaces \expandafter\def\csname #6\endcsname{\eqref{#6}\xspace}\ignorespaces \expandafter\def\csname #8\endcsname{\eqref{#8}\xspace}\ignorespaces}
+}
+
+\newcommand{\rcite}{\cite}
+\newcommand{\draftmode}{\usepackage[notref,notcite]{showkeys}}
+\providecommand*\showkeyslabelformat[1]{\normalfont\sffamily\footnotesize#1}
+\newcommand{\foot}{\footnote}
+
+% Sections and subsections
+\NewDocumentCommand\newsec{mo}{%
+ \IfNoValueTF{#2}
+ {\section{#1}}
+ {\section{#1}\label{#2} \expandafter\gdef\csname #2\endcsname{\ref{#2}\xspace}\ignorespaces}
+}
+\NewDocumentCommand\subsec{mo}{%
+ \IfNoValueTF{#2}
+ {\subsection{#1}}
+ {\subsection{#1}\label{#2}\expandafter\gdef\csname #2\endcsname{\ref{#2}\xspace}\ignorespaces}
+}
+\NewDocumentCommand\subsubsec{mo}{%
+ \IfNoValueTF{#2}
+ {\subsubsection{#1}}
+ {\subsubsection{#1}\label{#2}\expandafter\gdef\csname #2\endcsname{\ref{#2}\xspace}\ignorespaces}
+}
+
+\makeatletter
+\renewcommand\section{\@startsection {section}{1}{\z@}%
+{-6ex \@plus -1ex \@minus -.2ex}%
+{2.3ex \@plus.2ex}%
+{\bfseries}}
+\makeatother
+\makeatletter
+\renewcommand\subsection{\@startsection{subsection}{2}{\z@}%
+ {-3.25ex\@plus -1ex \@minus -.2ex}%
+ {1.5ex \@plus .2ex}%
+ {\itshape}}
+\makeatother
+\makeatletter
+\renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}%
+ {-3.25ex\@plus -1ex \@minus -.2ex}%
+ {1.5ex \@plus .2ex}%
+ {\itshape}}
+\makeatother \ No newline at end of file