source: branches/CMIP5_IPSL/DOC/NEMO_book.tex @ 1803

Last change on this file since 1803 was 1680, checked in by rblod, 11 years ago

Cosmetic changes on documentation (correct references and page indexation)

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