summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-07-20 10:40:59 +0000
committerjthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-07-20 10:40:59 +0000
commit4ee091d18b35cba2fe5ad43d366708506ed8d275 (patch)
treeebfd6027835fe8a16789d3106215c66c16cba4bb /doc
parentf7226761c9454561a66abe13460307e17b3e3f35 (diff)
change cactuspart environment so part numbers (A, B, C, ...)
are automagically assigned by latex when the document is typeset delete explicit numbering of parts --> it's now possible for a given part to have a different number in the Users' Guide and the Reference Manual, eg when I finish creating the Reference Manual, "Appendices" will be part E there, while it will be part B in the Users Guide. With \ref all the references shuold be ok... git-svn-id: http://svn.cactuscode.org/flesh/trunk@3323 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/Appendices.tex11
-rw-r--r--doc/UsersGuide/FunctionReference.tex3
-rw-r--r--doc/UsersGuide/Infrastructure.tex12
-rw-r--r--doc/UsersGuide/Preface.tex7
-rw-r--r--doc/UsersGuide/RunningCactus.tex15
-rw-r--r--doc/UsersGuide/ThornWriters.tex13
-rw-r--r--doc/UsersGuide/UtilityRoutines.tex7
-rw-r--r--doc/latex/cactus.sty19
8 files changed, 60 insertions, 27 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex
index 9caaf8e1..c4f0d423 100644
--- a/doc/UsersGuide/Appendices.tex
+++ b/doc/UsersGuide/Appendices.tex
@@ -7,9 +7,14 @@
% @enddesc
% @version $Header$
% @@*/
-\begin{cactuspart}{6}{Appendices}{$RCSfile$}{$Revision$}
+
+\begin{cactuspart}{Appendices}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\chapter{Glossary}
\label{sec:glossary}
@@ -1324,6 +1329,8 @@ subroutine in any file with this problem.}
This section still needs to be written.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{cactuspart}
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index fa41bf65..fae328ce 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -13,7 +13,8 @@
% add key/value table functions in that section
% @endhistory
% @@*/
-\begin{cactuspart}{5}{FunctionReference}{$RCSfile$}{$Revision$}
+
+\begin{cactuspart}{FunctionReference}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}
\label{part:FunctionReference}
diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index f7004575..1b4ea34f 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -7,10 +7,15 @@
% @enddesc
% @version $Header$
% @@*/
-\begin{cactuspart}{4}{Infrastructure Thorn Writer's Guide}{$RCSfile$}{$Revision$}
+
+\begin{cactuspart}{Infrastructure Thorn Writer's Guide}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}
\label{part:infrastructure}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\chapter{Introduction}
\begin{itemize}
@@ -591,5 +596,8 @@ contains the function pointers. The required functions are:
\end{Lentry}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\end{cactuspart}
diff --git a/doc/UsersGuide/Preface.tex b/doc/UsersGuide/Preface.tex
index 8908de85..4e15679e 100644
--- a/doc/UsersGuide/Preface.tex
+++ b/doc/UsersGuide/Preface.tex
@@ -8,8 +8,8 @@
% @version $Header$
% @@*/
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
{\large \bf Preface}
\label{sec:pr}
@@ -124,3 +124,6 @@ Cactus Code. Special thanks to those who struggled with the earliest
sparse versions of this guide and sent in mistakes and suggestions,
in particular John Baker, Carsten Gundlach, Ginny Hudak-David,
Sai Iyer, Paul Lamping, Nancy Tran and Ed Seidel.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
diff --git a/doc/UsersGuide/RunningCactus.tex b/doc/UsersGuide/RunningCactus.tex
index 9ea6069d..3ca7396b 100644
--- a/doc/UsersGuide/RunningCactus.tex
+++ b/doc/UsersGuide/RunningCactus.tex
@@ -7,13 +7,13 @@
% @enddesc
% @version $Header$
% @@*/
-\begin{cactuspart}{1}{Installation and Running}{$RCSfile$}{$Revision$}
-\renewcommand{\thepage}{\Alph{part}\arabic{page}}
+\begin{cactuspart}{Installation and Running}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Installation}
\label{cha:in}
@@ -1351,6 +1351,9 @@ In general, these thorns decide how often to generate a checkpoint. They also
register their recovery routines with the flesh which then get called during
initialization to perform the recovery of parameters and grid variables if
requested in the parameter file.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{cactuspart}
diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index 9f2fe63e..5f089840 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -16,12 +16,12 @@
% @endhistory
% @@*/
-\begin{cactuspart}{2}{Application thorn writing}{$RCSfile$}{$Revision$}
-
+\begin{cactuspart}{Application thorn writing}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Overview}
@@ -4044,7 +4044,8 @@ For example, the variable {\tt cctkGH} is of this type.
\section{How your code is built}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{cactuspart}
diff --git a/doc/UsersGuide/UtilityRoutines.tex b/doc/UsersGuide/UtilityRoutines.tex
index d14b412b..2de6ea70 100644
--- a/doc/UsersGuide/UtilityRoutines.tex
+++ b/doc/UsersGuide/UtilityRoutines.tex
@@ -7,10 +7,13 @@
% @enddesc
% @version $Header$
% @@*/
-\begin{cactuspart}{3}{Utility Routines}{$RCSfile$}{$Revision$}
+
+\begin{cactuspart}{Utility Routines}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Introduction}
@@ -414,5 +417,7 @@ code that by setting an appropriate entry in a checkpoint table.
``master system table'' that records handles of other interesting tables.)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{cactuspart}
diff --git a/doc/latex/cactus.sty b/doc/latex/cactus.sty
index 764a1f08..4ab04a02 100644
--- a/doc/latex/cactus.sty
+++ b/doc/latex/cactus.sty
@@ -510,7 +510,13 @@
y\or z\else\@ctrerr\fi}
\makeatother
-\newenvironment{cactuspart}[4]
+%
+% arguments:
+% #1 = Name of this part, eg "Function Reference"
+% #2 = $RCSFile:$ keyword
+% #3 = $Revision$ keyword
+%
+\newenvironment{cactuspart}[3]
{
\clearpage
\renewcommand{\thepage}{\BigAlph{part}\arabic{page}}
@@ -518,8 +524,8 @@
\fancypagestyle{plain}
{
\fancyhf{} % Clear all header and footer fields
- \lfoot{#3}
- \cfoot{#4}
+ \lfoot{#2}
+ \cfoot{#3}
\rfoot{\thepage/\pageref{lastpage:\thepart}}
\renewcommand{\headrulewidth}{0.0pt}
\renewcommand{\footrulewidth}{0.4pt}
@@ -532,12 +538,11 @@
\setcounter{page}{1}
% Start a new part
\renewcommand{\thepage}{\BigAlph{part}\arabic{page}}
- \part{#2}
- \setcounter{part}{#1}
+ \part{#1}
% Redefine the page
% Set up fancy headings.
- \lfoot{#3}
- \cfoot{#4}
+ \lfoot{#2}
+ \cfoot{#3}
\rfoot{\thepage/\pageref{lastpage:\thepart}}
\renewcommand{\headrulewidth}{0.4pt}
\renewcommand{\footrulewidth}{0.4pt}