New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
document.tex in NEMO/trunk/doc/latex/global – NEMO

source: NEMO/trunk/doc/latex/global/document.tex @ 11170

Last change on this file since 11170 was 11170, checked in by nicolasmartin, 5 years ago

Review of the overall building of any reference manual
Implementation of a compilation process shared between the 3 manuals: now a global document.tex will be used as the main LaTeX file (a symbolic link will refer to it in each ./engine/main directory).
At the time of the manual building, a few small LaTeX files will be imported on the fly from the corresponding folder ./latex/engine/main.

  • definitions.tex: engine, title, author(s), IPSL publication number and DOI ID
  • thanks.tex: list of collaborators to be thanked for the writing/reviewing
  • chapters.tex: ordered list of chapters (relative path to subfiles)
  • appendices.tex: ordered list of subordinate chapters (relative path to subfiles)
File size: 2.1 KB
Line 
1%% ==============================================================================
2%% Reference Manual
3%% ==============================================================================
4
5%% NEMO release version
6\def\version{X.X~}
7
8%% Preamble
9%% ==============================================================================
10
11%% Document layout
12\documentclass[draft]{scrreport}
13
14%% Custom style (.sty)
15\usepackage{../../global/packages}
16
17%% Engine name and Zenodo DOI
18\input{definitions}
19
20%% Include references and index for single subfile compilation
21\newcommand{\biblio}{\bibliography{../main/bibliography}}
22\newcommand{\pindex}{\printindex}
23
24\makeindex
25
26%% End of common preamble between main and sub-files
27\begin{document}
28\pagenumbering{gobble}
29
30%% Override custom cmds for full manual compilation
31\renewcommand{\biblio}{}
32\renewcommand{\pindex}{}
33
34
35%% Frontmatter
36%% ==============================================================================
37
38%% Title and information pages
39\input{../../global/frontpages}
40
41%% Engine citation
42\input{../../global/citation}
43
44%% Foreword
45\newpage
46%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
47\pagenumbering{roman}
48\subfile{../subfiles/foreword}
49
50%% ToC i.e. Table of Contents
51\newpage
52\dominitoc\tableofcontents
53
54\clearpage
55%\end{document}
56
57
58%% Mainmatter
59%% ==============================================================================
60
61%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
62\pagenumbering{arabic}
63
64\graphicspath{{../../figures/\engine/}}
65\input{chapters}
66
67
68%% Appendix
69%% ==============================================================================
70
71%% Chapter numbering is reset with letters now
72\appendix   
73
74\input{appendices}
75
76
77%% Backmatter
78%% ==============================================================================
79
80%\backmatter   %% Chapter numbering off
81
82%% Bibliography
83\phantomsection\addcontentsline{toc}{chapter}{Bibliography}
84\bibliography{../main/bibliography}
85
86%% Index
87\clearpage
88\phantomsection\addcontentsline{toc}{chapter}{Index}
89\printindex
90
91\end{document}
Note: See TracBrowser for help on using the repository browser.