diff options
author | schnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2003-07-18 18:54:18 +0000 |
---|---|---|
committer | schnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2003-07-18 18:54:18 +0000 |
commit | 67d7b09601e6c4de65b7dc8883bce917e5b44c96 (patch) | |
tree | 762600124a1a061ffcbb2096bdbe4fa55a92bced /doc/latex | |
parent | 996d199af97ad532deb03de7e2159d4c8b282c79 (diff) |
Move most of the (duplicated) latex headers into cactus.sty.
Fix typos in template.tex.
git-svn-id: http://svn.cactuscode.org/flesh/trunk@3295 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/latex')
-rw-r--r-- | doc/latex/cactus.sty | 265 |
1 files changed, 246 insertions, 19 deletions
diff --git a/doc/latex/cactus.sty b/doc/latex/cactus.sty index 29f26edd..1dc0aa41 100644 --- a/doc/latex/cactus.sty +++ b/doc/latex/cactus.sty @@ -1,12 +1,14 @@ % @version $Header$ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \NeedsTeXFormat{LaTeX2e} \def\CA@styledate{\CA@getcvsdate $Date$} \def\CA@styleversion{\CA@getcvsversion $Revision$} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \def\CA@getcvsdate $#1:#2/#3/#4 #5:#6:#7${#2/#3/#4} \def\CA@getcvsversion $#1:#2${#2} @@ -34,39 +36,58 @@ } -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% Check if we are under pdftex -\newif\ifCA@pdf -\ifx\pdfoutput\undefined - \CA@pdffalse % we are not running PDFLaTeX -\else - \pdfoutput=1 % we are running PDFLaTeX - \CA@pdftrue - % Add the pdftex option to a subsequent load of graphicx - \PassOptionsToPackage{pdftex}{graphicx} -\fi +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Load in other packages. +\RequirePackage{fancyhdr} \RequirePackage{graphicx} \RequirePackage{hyperref} \RequirePackage{latexsym} \RequirePackage{amssymb} \RequirePackage{ifthen} \RequirePackage{calc} -\RequirePackage{hyperref} +\RequirePackage{thumbpdf} -\parskip = 2 pt + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\parskip = 10 pt +\parindent = 0 pt \oddsidemargin = 0 cm \textwidth = 16 cm \topmargin = -1 cm \textheight = 24 cm + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + % macros \def\text#1{{\rm #1}} +\def\q{\bf QUERY: } +\def\t{\tt \obeylines } +\def\ie{\hbox{i.e.\hbox{}}} + +\def\nhat{{\hat n}} +\def\vone{{v_{{}_{(1)}}}} +\def\vtwo{{v_{{}_{(2)}}}} +\def\vthree{{v_{{}_{(3)}}}} +\def\eref#1{(\ref{#1})} + +% nicely typeset "C++" (adapted from a comp.lang.C++ FAQ entry) +\def\Cplusplus{\hbox{C\hspace{-.05em}\raisebox{.4ex}{\tiny\bf ++}}} + + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % MANPAGE like description setting for options, use as % \begin{Lentry} %\item[text] text \end{Lentry} \usepackage{ifthen,calc} @@ -93,6 +114,137 @@ \begin{entry}} {\end{entry}} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\newenvironment{CCTKroutine}{\newpage}{} +\newenvironment{CCTKsyn}{\noindent\begin{tabular}{@{}p{3cm}cp{11cm}}&&\\{\bf Synopsis} \hfill&&\\}{\end{tabular}} +% The above needs to be fixed -- sometimes it runs off the page (e.g. with cctk_complex arguments...) +\newenvironment{CCTKpar}{\noindent\begin{tabular}{@{}p{3cm}cp{11cm}}&&\\{\bf Parameters} \hfill&&\\}{\end{tabular}} +\newcommand{\CCTKname}[1]{\noindent{\t #1}\hrule} +\newcommand{\CCTKdesc}[1]{\vskip .3cm \noindent #1} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%Define some saveboxes to hold data +\newsavebox{\cctkbox} +\newsavebox{\cctkcargbox} +\newsavebox{\cctkfargbox} +\newsavebox{\cctkfargdefs} +\newsavebox{\cctkcsepbox} +\newsavebox{\cctkfsepbox} +\newsavebox{\cctkfdefssep} +\newsavebox{\cctkcprefix} +\newsavebox{\cctkfprefix} +\newsavebox{\cctkparambox} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newenvironment{CCTKFunc}[2] + {\sbox{\cctkbox}{#1} + \newpage + \noindent{\t #1}\hrule + \vskip .3cm \noindent #2\\ +%Clear the saveboxes - this may not be neccessary + \sbox{\cctkcargbox}{} + \sbox{\cctkfargbox}{} + \sbox{\cctkfargdefs}{} + \sbox{\cctkcsepbox}{} + \sbox{\cctkfsepbox}{} + \sbox{\cctkfdefssep}{} + \sbox{\cctkcprefix}{} + \sbox{\cctkfprefix}{} +%A command to add an argument - takes ctype, ftype, name + \newcommand{\argument}[3] + {\sbox{\cctkcargbox}{\usebox{\cctkcargbox}\usebox{\cctkcsepbox} ##1 ##3} + \sbox{\cctkcsepbox}{,} + \sbox{\cctkfargbox}{\usebox{\cctkfargbox}\usebox{\cctkfsepbox} ##3} + \sbox{\cctkfsepbox}{,} + \sbox{\cctkfargdefs}{\noindent{}\vbox{\noindent\usebox{\cctkfargdefs}\noindent\usebox{\cctkfdefssep}\noindent {} ##2 ##3}} + \sbox{\cctkfdefssep}{\\} + } +%Use this command if it is a subroutine, same args as \argument + \newcommand{\subroutine}[3] + {\sbox{\cctkcprefix}{##1 ##3 =} + \sbox{\cctkfprefix}{call} + \sbox{\cctkfargbox}{##3\usebox{\cctkfsepbox} \usebox{\cctkfargbox}} + \sbox{\cctkfsepbox}{,} + \sbox{\cctkfargdefs}{\noindent{}\vbox{\noindent ##2 ##3 \usebox{\cctkfdefssep}\noindent{}\usebox{\cctkfargdefs}}} + \sbox{\cctkfdefssep}{\\} + } + +%Use this command if it is a function, same args as \argument + \newcommand{\function}[3] + {\sbox{\cctkcprefix}{##1 ##3 =} + \sbox{\cctkfprefix}{##3 = } + \sbox{\cctkfargdefs}{\noindent{}\vbox{\noindent ##2 ##3 \usebox{\cctkfdefssep}\noindent{}\usebox{\cctkfargdefs}}} + \sbox{\cctkfdefssep}{\\} + } + +%Use this to display the arguments + \newcommand{\showargs} + {\noindent + \begin{tabular}{@{}p{3cm}cp{11cm}}&&\\ +{\bf Synopsis} \hfill&&\\ +\hfill {\bf C} && {\t \usebox{\cctkcprefix} \usebox{\cctkbox}(\usebox{\cctkcargbox})}\\ +\hfill {\bf Fortran} && +{\t \usebox{\cctkfprefix} \usebox{\cctkbox}(\usebox{\cctkfargbox} ) }\\ +&&\noindent\usebox{\cctkfargdefs} +\end{tabular}\\ +} + +%Use this to display the C arguments + \newcommand{\showcargs} + {\noindent + \begin{tabular}{@{}p{3cm}cp{11cm}}&&\\ +{\bf Synopsis} \hfill&&\\ +\hfill {\bf C} && {\t \usebox{\cctkcprefix} \usebox{\cctkbox}(\usebox{\cctkcargbox})}\\ +\end{tabular}\\ +} + + +%Environment for describing parameters + \newenvironment{params}{ + \noindent\begin{tabular}{@{}p{3cm}cp{11cm}}&&\\{\bf Parameters} \hfill&&\\}{\end{tabular}\\} +%Command to describe a parameter, takes name and description + \newcommand{\parameter}[2]{ +\\ +\hfill {\t ##1} &-&##2 +\\ +} +%Environment for discussion + \newenvironment{discussion} + {\noindent + \begin{tabular}{@{}p{14cm}} + \\{\bf Discussion} \hfill\\ + } + { + \end{tabular}\\ + } +%Environment for examples + \newenvironment{examples} + {\noindent + \begin{tabular}{@{}p{14cm}} + \\{\bf Examples} \hfill\\ + } + { + \end{tabular}\\\\ + } + +%Environment for describing errors + \newenvironment{errorcodes} + {\noindent + \begin{tabular}{@{}p{6cm}cp{10cm}}&&\\ + {\bf Errors} \hfill&&\\} + {\end{tabular}\\} +%Command to describe an errorcode, takes name and description + \newcommand{\errorcode}[2]{ +\\ +\hfill {\t ##1} &-&##2 +\\ +} + +}% end of \begin{CCTKFunc} expansion +{}% \end{CCTKFunc} expansion + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -312,6 +464,81 @@ {%%% }%%% % \end{FunctionDescription} expansion is empty + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Takes three arguments - the name of the document, the revision, and +% the date. +% Additionally ther eis an optional first argument with the version number + +\newcommand{\cactustitlepage}[4][4.0] +{ +\thispagestyle{empty} +\setlength{\parindent}{0mm} +\setlength{\parskip}{0mm} +\vspace*{\stretch{1}} +\rule{\linewidth}{1mm} +\begin{flushright} + \Huge Cactus #1\\[5mm] + #2 +\end{flushright} +\rule{\linewidth}{1mm} +\vspace*{\stretch{2}} +\begin{center} +\includegraphics[angle=0,width=5cm]{bincactus2} +\end{center} +\vspace*{\stretch{2}} +\begin{center} + \Large #3 \\[3mm] + #4 +\end{center} +\newpage +\setlength{\parindent}{0pt} +\setlength{\parskip}{10pt} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newenvironment{cactuspart}[4] +{ + \clearpage + \renewcommand{\thepage}{\Alph{part}\arabic{page}} + % Redefine the plain style + \fancypagestyle{plain} + { + \fancyhf{} % Clear all header and footer fields + \lfoot{#3} + \cfoot{#4} + \rfoot{\thepage/\pageref{lastpage:\thepart}} + \renewcommand{\headrulewidth}{0.0pt} + \renewcommand{\footrulewidth}{0.4pt} + \renewcommand{\thepage}{\Alph{part}\arabic{page}} + } + + % Make sure it's arabic numbering + \pagenumbering{arabic} + % Start the page counter at 1 + \setcounter{page}{1} + % Start a new part + \renewcommand{\thepage}{\Alph{part}\arabic{page}} + \part{#2} + \setcounter{part}{#1} + % Redefine the page + % Set up fancy headings. + \lfoot{#3} + \cfoot{#4} + \rfoot{\thepage/\pageref{lastpage:\thepart}} + \renewcommand{\headrulewidth}{0.4pt} + \renewcommand{\footrulewidth}{0.4pt} +} +{ + % Remember the last page of the + \label{lastpage:\thepart} + \clearpage +} + + + \endinput -%% %% End of cactus.sty |