source: trunk/DOC/BETA/NEMO_book.tex @ 781

Last change on this file since 781 was 781, checked in by smasson, 13 years ago

doc update, see ticket:1

  • Property svn:executable set to *
File size: 8.9 KB
Line 
1%description: Book template
2
3% template of document for LaTeX
4% (C) Xavier Perseguers 2002 - xavier.perseguers@epfl.ch
5
6\documentclass[a4paper,12pt]{book}
7
8% ================================================================
9% HEADERS DEFINITION
10% ================================================================
11
12\usepackage[french]{babel}
13\usepackage{fancyhdr}
14
15\usepackage{alltt}      %%  alltt for namelist
16\usepackage{verbatim}   %%  alltt for namelist
17
18%\usepackage{amssymb}
19\pagestyle{fancy}
20% with this we ensure that the chapter and section
21% headings are in lowercase.
22\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
23\renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}}
24\fancyhf{}             % delete current setting for header and footer
25\fancyhead[LE,RO]{\bfseries\thepage}
26\fancyhead[LO]{\bfseries\hspace{-0em}\rightmark}
27\fancyhead[RE]{\bfseries\leftmark}
28\renewcommand{\headrulewidth}{0.5pt}
29\renewcommand{\footrulewidth}{0pt}
30\addtolength{\headheight}{2.6pt}   % make space for the rule
31%\addtolength{\headheight}{1.6pt}   % make space for the rule
32\fancypagestyle{plain}{
33  \fancyhead{}         % get rid of headers on plain pages
34  \renewcommand{\headrulewidth}{0pt}  % and the line
35}
36
37% Leave blank pages completely empty, w/o header
38\makeatletter
39\def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else
40  \hbox{}
41  \vspace*{\fill}
42  \vspace{\fill}
43  \thispagestyle{empty}
44  \newpage
45  \if@twocolumn\hbox{}\newpage\fi\fi\fi}
46\makeatother
47
48\usepackage{makeidx}
49
50\usepackage{minitoc}          %in french : \usepackage[french]{minitoc}
51
52%\usepackage{mtcoff}          % invalidate the use of minitocs
53\usepackage[latin1]{inputenc}
54\usepackage{graphics}            % allows insertion of pictures
55\usepackage{times}               % use vector fonts instead of bitmap
56\usepackage{fancybox}
57\usepackage{color}
58\usepackage{colortbl}
59
60%%%% add by Word2Tex
61%\documentclass{amsart}
62\usepackage{latexsym}
63\usepackage{amssymb}
64\usepackage{amsmath}
65\usepackage{graphicx}
66%%%%
67
68%%%%
69%\usepackage{mathtime}      % font for illustrator to work (belleek fonts )
70%%%%
71
72%\usepackage{showidx}            % show the index entry
73
74
75
76%%%% define the style of title for chapter  %%%
77\usepackage{pstricks}
78\makeatletter
79\def\LigneVerticale{\vrule height 5cm depth 2cm\hspace{0.1cm}\relax}
80\def\LignesVerticales{%
81  \let\LV\LigneVerticale\LV\LV\LV\LV\LV\LV\LV\LV\LV\LV}
82\def\GrosCarreAvecUnChiffre#1{%
83  \rlap{\vrule height 0.8cm width 1cm depth 0.2cm}%
84  \rlap{\hbox to 1cm{\hss\mbox{\white #1}\hss}}%
85  \vrule height 0pt width 1cm depth 0pt}
86\def\GrosCarreAvecTroisChiffre#1{%
87  \rlap{\vrule height 0.8cm width 1.6cm depth 0.2cm}%
88  \rlap{\hbox to 1.5cm{\hss\mbox{\white #1}\hss}}%
89  \vrule height 0pt width 1cm depth 0pt}
90
91\def\@makechapterhead#1{\hbox{%
92    \huge 
93    \LignesVerticales
94    \hspace{-0.5cm}%
95    \GrosCarreAvecUnChiffre{\thechapter}
96    \hspace{0.2cm}\hbox{#1}%
97%    \GrosCarreAvecTroisChiffre{\thechapter}
98%    \hspace{1cm}\hbox{#1}%
99%}\par\vskip 2cm}
100}\par\vskip 1cm}
101\def\@makeschapterhead#1{\hbox{%
102    \huge 
103    \LignesVerticales
104    %\hspace{0.5cm}%
105    \hbox{#1}%
106}\par\vskip 2cm}
107
108%\def\thechapter{\Roman{chapter}}      % chapter number to be Roman
109
110%%%% end style chapter %%%
111
112%%% eqution shortcut:
113\newcommand{\vect} [1] { \rm{\textbf{#1}} }    % vector style: non-italic bold
114
115%%% essai commande
116\newcommand{\nl} [1] {\texttt{\small {\textcolor{blue}{#1}} } } 
117
118%essai commande 
119\newcommand{\mdl} [1] {\textit{#1.F90}\index{Modules!#1}}         %module (mdl)
120\newcommand{\rou} [1] {\textit{#1}\index{Routines!#1}}         %module (routine)
121\newcommand{\hf} [1] {\textit{#1.h90}\index{h90 file!#1}}         %module (h90 files)
122\newcommand{\np} [1] {\textit{#1}\index{Namelist parameters!#1}}%namelist parameter (nampar)
123\newcommand{\jp} [1] {\textit{#1}\index{Model parameters!#1}}%model parameter (jp)
124\newcommand{\pp} [1] {\textit{#1}\index{Model parameters!#1}}%namelist parameter (pp)
125\newcommand{\key} [1] {\textbf{key\_#1}\index{CPP keys!key\_#1}}  %key_cpp (key)
126\newcommand{\NEMO} {\textit{NEMO}}                 %NEMO (nemo)
127\newcommand{\amtcomment}[1]{}    % command to allow "commented out" portions of
128%                                               % text that span line breaks
129
130%--------------------------------------------namlist---------------------------------------------------------
131%\newcommand{\namdisplay} [1] {  \vspace{-25pt}
132%  \begin{alltt}  \textcolor{blue}{{\scriptsize \verbatiminput{./Namelist/#1}}}  \end{alltt}
133%                          \vspace{-20pt} }
134\newcommand{\namdisplay} [1] { 
135   \begin{alltt}  {{\tiny \verbatiminput{./Namelist/#1}}}  \end{alltt} 
136                               \vspace{-15pt}   }
137%--------------------------------------------------------------------------------------------------------------
138
139%Red (NR) or Yellow(WARN)
140%\newcommand{\NR} {\colorbox{red}{#1}}
141%\newcommand{\WARN} {{ \colorbox{yellow}{#1}} }
142
143%---------------------%%%%%  Section number in Margin  %%%%%-----------------------------
144% typeset the number of each section in the left margin, with the start of each instance of
145% sectional heading text aligned with the left hand edge of  the body text.
146\makeatletter 
147\def\@seccntformat#1{\protect\makebox[0pt][r]{\csname the#1\endcsname\quad}} 
148\makeatother 
149%--------------------------------------------------------------------------------------------------------------
150
151%----------------------------%%%%%   Bilbiography   %%%%%%-------------------------------%
152\usepackage[nottoc, notlof, notlot]{tocbibind}
153\usepackage[square, comma]{natbib}
154\bibpunct{[}{]}{,}{a}{}{;}                           %suppress "," after "et al."
155\newcommand{\bibfont}{\small}
156%--------------------------------------------------------------------------------------------------------------
157
158% ================================================================
159% FRONT PAGE
160% ================================================================
161\title{ \includegraphics[width=0.4\textwidth]{./Figures/NEMO_logo.pdf} \\
162\rule{345pt}{1.5pt} \\
163\vspace{0.45cm}
164 {\Huge NEMO ocean engine} 
165\rule{345pt}{1.5pt} \\ 
166{\small NEMO v2.3} \\
167{ -- Draft --}   }
168\date{\today}
169
170%%    \hbox{\mbox{%
171%%        \hspace{4pt}%
172%%         \fbox{\includegraphics[width=3em]{./NEMO_logo.pdf}}%
173%%        \hspace{4pt}
174%%        }  }%
175
176\author{Gurvan Madec - \texttt{{\small gurvan.madec@locean-ipsl.umpc.fr}} \\
177{\small Laboratoire d'Oc\'{e}anographie  et du Climat: Exp\'{e}rimentation et Approches Num\'{e}riques}
178}
179
180\dominitoc
181\makeindex        %type this first :     makeindex -s NEMO.ist NEMO_book.idx
182
183% ================================================================
184% ================================================================
185%      Include ONLY order
186% ================================================================
187
188%\includeonly{./Chapters/Annex_E,./Chapters/Annex_C}
189%\includeonly{./Chapters/Chap_LBC,./Chapters/Chap_MISC}
190%\includeonly{./Chapters/Chap_Model_Basics_zstar}
191%\includeonly{./Chapters/Annex_A,./Chapters/Annex_B,./Chapters/Annex_C,./Chapters/Annex_D}
192
193% ================================================================
194% ================================================================
195\begin{document}
196
197\maketitle                 % generate the title
198
199\frontmatter
200
201\tableofcontents              % generate a table of content
202%\listoffigures               % generate a table of content
203%\listoftables             % generate a table of content
204
205\mainmatter
206
207% ================================================================
208% Abstract - Foreword
209% ================================================================
210
211\include{./Chapters/Abstracts_Foreword}
212
213% ================================================================
214% INTRODUCTION
215% ================================================================
216
217\include{./Chapters/Introduction}
218
219% ================================================================
220% CHAPTERS
221% ================================================================
222
223\include{./Chapters/Chap_Model_Basics}
224
225%\include{./Chapters/Chap_Model_Basics_zstar}         % attent to describe z*-s*
226
227\include{./Chapters/Chap_DOM}
228
229\include{./Chapters/Chap_TRA}
230
231\include{./Chapters/Chap_DYN}
232
233\include{./Chapters/Chap_SBC}
234
235\include{./Chapters/Chap_LBC}
236
237\include{./Chapters/Chap_LDF}
238
239\include{./Chapters/Chap_ZDF}
240
241\include{./Chapters/Chap_MISC}
242
243% ================================================================
244% APPENDIX
245% ================================================================
246
247%\appendix
248
249%\include{./Chapters/Chap_Conservation}
250%\include{./Chapters/Annex_A}
251%\include{./Chapters/Annex_B}
252%\include{./Chapters/Annex_C}
253%\include{./Chapters/Annex_D}
254%\include{./Chapters/Annex_E}
255
256%%%%\include{./Chapters/0_page_de_garde_old}
257% ================================================================
258% INDEX
259% ================================================================
260
261\addcontentsline{toc}{chapter}{Index}
262\printindex
263
264% ================================================================
265% BIBLIOGRAPHY
266% ================================================================
267
268%%\bibliographystyle{plainnat}
269\bibliographystyle{./ametsoc}       % AMS biblio style (JPO)
270\bibliography{./Biblio/biblio}
271
272% ================================================================
273\end{document}
Note: See TracBrowser for help on using the repository browser.