summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/.latex2html-init30
-rw-r--r--doc/UsersGuide/Appendices.tex8
-rw-r--r--doc/UsersGuide/Infrastructure.tex6
-rw-r--r--doc/UsersGuide/RunningCactus.tex4
-rw-r--r--doc/UsersGuide/ThornWriters.tex5
-rw-r--r--doc/UsersGuide/UsersGuide.tex99
6 files changed, 138 insertions, 14 deletions
diff --git a/doc/UsersGuide/.latex2html-init b/doc/UsersGuide/.latex2html-init
new file mode 100644
index 00000000..153bf32b
--- /dev/null
+++ b/doc/UsersGuide/.latex2html-init
@@ -0,0 +1,30 @@
+#/*@@
+# @file .latex2html-init
+# @date Mon Jul 12 15:01:45 1999
+# @author Tom Goodale
+# @desc
+# Extra stuff for latex2html
+# @enddesc
+# @version $Header$
+#@@*/
+&ignore_commands(<<_IGNORED_CMDS_);
+lfoot # {}
+rfoot # {}
+cfoot # {}
+fancypagestyle # {} # {}
+renewcommand \\headrulewidth {} # {}
+cactustitlepage # {} # {} # {}
+_IGNORED_CMDS_
+
+#headrulewidth # {}
+#footrulewidth # {}
+
+#newcommand # {} # {}
+
+&process_commands_in_tex(<<_RAW_ARG_CMDS_) ;
+
+
+
+_RAW_ARG_CMDS_
+
+1;
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex
index 185dc2a7..b621100f 100644
--- a/doc/UsersGuide/Appendices.tex
+++ b/doc/UsersGuide/Appendices.tex
@@ -1,6 +1,5 @@
-\part{Appendices}
-
-\appendix
+\begin{cactuspart}{4}{Appendices}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
\chapter{Configuration file syntax}
\label{sec:cofisy}
@@ -319,6 +318,9 @@ Return to previous location before jump to tag (not widely implemented).
\label{sec:thflin}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\end{cactuspart}
diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index 06fa4232..40492b4f 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -1,4 +1,5 @@
-\part{Infrastructure Thorn Writer's Guide}
+\begin{cactuspart}{3}{Infrastructure Thorn Writer's Guide}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
\begin{enumerate}
@@ -548,3 +549,6 @@ resulting strings should be freed when no longer needed.
\item{} int CCTK\_SetString(char **data, const char *value);
\item{} int CCTK\_SetLogical(int *data, const char *value);
\end{itemize}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\end{cactuspart}
diff --git a/doc/UsersGuide/RunningCactus.tex b/doc/UsersGuide/RunningCactus.tex
index d43352d1..198f4c39 100644
--- a/doc/UsersGuide/RunningCactus.tex
+++ b/doc/UsersGuide/RunningCactus.tex
@@ -1,4 +1,5 @@
-\part{Installation and Running}
+\begin{cactuspart}{1}{Installation and Running}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
\chapter{Overview of documentation}
@@ -969,3 +970,4 @@ parameter in your parameter file.}
\item Anything else ?
\end{itemize}
+\end{cactuspart} \ No newline at end of file
diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index 1623933f..bf5a0fbf 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -1,5 +1,5 @@
-
-\part{Application thorn writing}
+\begin{cactuspart}{2}{Application thorn writing}{$RCSfile$}{$Revision$}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -981,3 +981,4 @@ allow for a homogeneous code.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\end{cactuspart}
diff --git a/doc/UsersGuide/UsersGuide.tex b/doc/UsersGuide/UsersGuide.tex
index 11c800e8..b85ed4a4 100644
--- a/doc/UsersGuide/UsersGuide.tex
+++ b/doc/UsersGuide/UsersGuide.tex
@@ -1,5 +1,21 @@
+% /*@@
+% @file UsersGuide.tex
+% @date
+% @author
+% @desc
+%
+% @enddesc
+% @version $Header$
+% @@*/
+
\documentclass{report}
+\usepackage{fancyhdr}
+
+\makeatletter
+\@addtoreset{chapter}{part}
+\makeatother
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\parskip = 2 pt
\oddsidemargin = 0 cm
\textwidth = 16 cm
@@ -9,8 +25,7 @@
\def\q{\bf QUERY: }
\def\t{\tt \obeylines }
-\begin{document}
-
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newenvironment{CCTKroutine}{\newpage}{}
\newenvironment{CCTKsyn}{\noindent\begin{tabular}{@{}p{3cm}cp{11cm}}&&\\{\bf Synopis} \hfill&&\\}{\end{tabular}}
\newenvironment{CCTKpar}{\noindent\begin{tabular}{@{}p{3cm}cp{11cm}}&&\\{\bf Parameters} \hfill&&\\}{\end{tabular}}
@@ -125,16 +140,82 @@
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% 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}
+ \Large #3 \\[3mm]
+ #4
+\end{center}
+\newpage
+}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+\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
+}
-\date{\verb$Date$}
-\title{Cactus 4.0 Documentation\\
-\small{\verb$Revision$}
-}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%\maketitle
+\begin{document}
+\cactustitlepage{Users' Guide}{$$Revision$$}{$$Date$$}
+\setcounter{page}{1}
+
+% Table of contents
+\pagenumbering{roman}
\tableofcontents
@@ -142,6 +223,10 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\renewcommand{\thepart}{\Alph{part}}
+\renewcommand{\thechapter}{\Alph{part}\arabic{chapter}}
+\renewcommand{\thepage}{\Alph{part}\arabic{page}}
+
\include{RunningCactus}
\include{ThornWriters}