source: trunk/docs/Guide.tex @ 298

Last change on this file since 298 was 298, checked in by Matthew Whiting, 17 years ago

Updated documentation, and changed the version number to 1.1 ready for the next release.

File size: 4.4 KB
Line 
1\documentclass[11pt,a4paper]{article}
2%\documentclass[12pt,a4paper]{report}
3
4%%%%%% LINE SPACING %%%%%%%%%%%%
5\usepackage{setspace}
6\singlespacing
7%\onehalfspacing
8%\doublespacing
9
10%Define a test for doing PDF format -- use different code below
11\newif\ifPDF
12\ifx\pdfoutput\undefined\PDFfalse
13\else\ifnum\pdfoutput > 0\PDFtrue
14     \else\PDFfalse
15     \fi
16\fi
17
18%\textwidth=165 mm
19%\textheight=245 mm
20%\topmargin=0 mm
21%\oddsidemargin=0 mm
22%\parindent=6 mm
23
24\usepackage{amsmath}
25\usepackage{amsfonts}
26\usepackage{xspace}
27\usepackage[sort]{natbib}
28\bibpunct[,]{(}{)}{;}{a}{}{,}
29
30%\newcommand{\secA}{\chapter}
31%\newcommand{\secB}{\section}
32%\newcommand{\secC}{\subsection}
33
34\newcommand{\secA}{\section}
35\newcommand{\secB}{\subsection}
36\newcommand{\secC}{\subsubsection}
37
38
39\newcommand{\eg}{e.g.\ }
40\newcommand{\ie}{i.e.\ }
41\newcommand{\hi}{H\textsc{i}\xspace}
42\newcommand{\hipass}{\textsc{hipass}\xspace}
43\newcommand{\duchamp}{\emph{Duchamp}\xspace}
44\newcommand{\atrous}{\textit{{\`a} trous}\xspace}
45\newcommand{\Atrous}{\textit{{\`A} trous}\xspace}
46\newcommand{\diff}{{\rm d}}
47\newcommand{\entrylabel}[1]{\mbox{\textsf{\bf{#1:}}}\hfil}
48\newenvironment{entry}
49        {\begin{list}{}%
50                {\renewcommand{\makelabel}{\entrylabel}%
51                        \setlength{\labelwidth}{30mm}%
52                        \setlength{\labelsep}{5pt}%
53                        \setlength{\itemsep}{2pt}%
54                        \setlength{\parsep}{2pt}%
55                        \setlength{\leftmargin}{35mm}%
56                }%
57        }%
58{\end{list}}
59
60%%%%%%% FANCY HEADINGS %%%%%%%%%%
61%\usepackage{fancyheadings}
62%\pagestyle{fancyplain}
63%\addtolength{\headheight}{1.6pt}
64%\addtolength{\headwidth}{\marginparsep}
65%\addtolength{\headwidth}{\marginparwidth}
66%\renewcommand{\secAmark}[1]
67%                {\markboth{#1}{}}
68%\renewcommand{\secBmark}[1]
69%                {\markright{\thesection\ #1}}
70%\lhead[\fancyplain{}{\bfseries\thepage}]
71%      {\fancyplain{}{\bfseries\rightmark}}
72%\rhead[\fancyplain{}{\bfseries\leftmark}]
73%      {\fancyplain{}{\bfseries\thepage}}
74%\cfoot{}
75
76% If we are creating a PDF, use different options for graphicx, hyperref.
77\ifPDF
78  \usepackage[pdftex]{graphicx,color}
79  \usepackage[pdftex,bookmarks]{hyperref}
80  \hypersetup{colorlinks=true,%             
81              citecolor=red,%
82              filecolor=red,%
83              linkcolor=red,%
84              urlcolor=red,%
85              }
86\else
87  \usepackage[dvips]{graphicx}
88  \usepackage[dvips]{hyperref}
89\fi
90
91\usepackage{lscape}
92\usepackage[dvips]{rotating}
93%\rotdriver{dvips}
94
95\pagestyle{headings}
96\begin{document}
97
98\ifPDF
99\pdfbookmark[2]{Title Page}{title}
100\fi
101\newlength{\centreoff}
102\setlength{\centreoff}{-0.5\oddsidemargin}
103\addtolength{\centreoff}{0.5\evensidemargin}
104\thispagestyle{empty}
105\vspace*{\stretch{1}}
106\noindent\hspace*{\centreoff}%
107\makebox[0pt][l]{\begin{minipage}{\textwidth}
108\flushright
109{\Huge\bfseries Source Detection with \duchamp\\[2ex]}
110{\huge\bfseries A User's Guide
111
112}
113\noindent\rule[-1ex]{\textwidth}{3pt}
114%\noindent\rule[-1ex]{\textwidth}{3pt}
115%{\huge\bfseries A User's Guide}
116\end{minipage}}
117
118\vspace{\stretch{1}}
119\noindent\hspace*{\centreoff}%
120\makebox[0pt][l]{\begin{minipage}{\textwidth}
121\flushright
122{\bfseries
123Matthew Whiting\\
124Australia Telescope National Facility\\
125CSIRO\\[3ex]}
126Duchamp version~1.1\\
127May 15, 2007
128\end{minipage}}
129
130\begin{figure}[!h]
131%\begin{center}
132\includegraphics[width=\textwidth]{cover_image}
133%\end{center}
134\end{figure}
135
136%\newpage
137\ifPDF
138\pdfbookmark[2]{Contents}{contents}
139\fi
140\tableofcontents
141
142\newpage
143\input{intro} %Introduction and getting going quickly
144\newpage
145\input{userInputs} %User Inputs
146\newpage
147\input{executionFlow} %What \duchamp is doing
148\newpage
149\input{outputs} %Outputs
150\newpage
151\input{hints} %Notes and hints on the use of \duchamp
152\newpage
153\input{future} %Future developments
154
155%\bibliographystyle{plainnat}
156%\bibliographystyle{mn2e}
157%\bibliography{guide}
158
159\newpage
160\ifPDF
161\pdfbookmark[1]{References}{references}
162\fi
163\ifPDF
164\input{Guide-URL-bib}
165\else
166\input{Guide-noURL-bib}
167\fi
168
169\appendix
170\newpage
171\input{app-install} %Obtaining and installing \duchamp
172\newpage
173\input{app-param} %Available parameters
174\newpage
175\input{app-paramEx} %Example parameter files
176\newpage
177\input{app-resultsEx} %Example results files
178\newpage
179\input{app-VOTable} %Example VOTable output
180\newpage
181\input{app-Karma} %Example Karma annotation file output
182\newpage
183\input{app-stats} %Robust statistics for a Normal distribution
184\newpage
185\input{app-waveletNoise} %How Gaussian noise changes with wavelet scale
186
187
188\end{document}
Note: See TracBrowser for help on using the repository browser.