Changeset 11170 for NEMO/trunk/doc/latex/global/document.tex

Timestamp:

2019-06-21T12:18:45+02:00 (5 years ago)

Author:

nicolasmartin

Message:

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:

• NEMO/trunk/doc/latex/global/document.tex (copied) (copied from NEMO/trunk/doc/latex/NEMO/main/NEMO_manual.tex) (5 diffs)

NEMO/trunk/doc/latex/global/document.tex

@@ -1 +1 @@
 %% ==============================================================================
-%% NEMO Reference Manual
+%% Reference Manual
 %% ==============================================================================
 
+%% NEMO release version
+\def\version{X.X~}
 
 %% Preamble
@@ -12 +14 @@
 %% Custom style (.sty)
 \usepackage{../../global/packages}
-\hypersetup{
-  pdftitle={NEMO ocean engine},
-  pdfauthor={Gurvan Madec and NEMO System Team},
-  colorlinks
-}
+
+%% Engine name and Zenodo DOI
+\input{definitions}
 
 %% Include references and index for single subfile compilation
-\newcommand{\biblio}{\bibliography{../main/NEMO_manual}}
+\newcommand{\biblio}{\bibliography{../main/bibliography}}
 \newcommand{\pindex}{\printindex}
 
@@ -36 +36 @@
 %% ==============================================================================
 
-\title{NEMO ocean engine}
-\author{Gurvan Madec \and NEMO System Team\thanks{
-    TBD
-  }
-}
-\date{\today}
-
 %% Title and information pages
 \input{../../global/frontpages}
 
-%% Citation embedded
-\textsf{
-``{\bfseries NEMO ocean engine}'', 
-Madec Gurvan and NEMO System Team, 
-{\em Scientific Notes of Climate Modelling Center (27)} -- ISSN 1288-1619, 
-Institut Pierre-Simon Laplace (IPSL), 
-\href{https://doi.org/10.5281/zenodo.1464816}{doi:10.5281/zenodo.1464816}
-}
+%% Engine citation
+\input{../../global/citation}
 
+%% Foreword
 \newpage
 %\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
 \pagenumbering{roman}
-
-\subfile{../subfiles/foreword}            %% Foreword
-
+\subfile{../subfiles/foreword}
 
 %% ToC i.e. Table of Contents
 \newpage
-\dominitoc
-\tableofcontents
+\dominitoc\tableofcontents
 
 \clearpage
 %\end{document}
+
 
 %% Mainmatter
@@ -76 +62 @@
 \pagenumbering{arabic}
 
-\graphicspath{{../../figures/NEMO/}}
+\graphicspath{{../../figures/\engine/}}
+\input{chapters}
 
-\subfile{../subfiles/introduction}        %% Introduction
-
-%% Chapters
-\subfile{../subfiles/chap_model_basics}
-\subfile{../subfiles/chap_time_domain}    %% Time discretisation (time stepping strategy)
-\subfile{../subfiles/chap_DOM}            %% Space discretisation
-\subfile{../subfiles/chap_TRA}            %% Tracer advection/diffusion equation
-\subfile{../subfiles/chap_DYN}            %% Dynamics : momentum equation
-\subfile{../subfiles/chap_SBC}            %% Surface Boundary Conditions
-\subfile{../subfiles/chap_LBC}            %% Lateral Boundary Conditions
-\subfile{../subfiles/chap_LDF}            %% Lateral diffusion
-\subfile{../subfiles/chap_ZDF}            %% Vertical diffusion
-\subfile{../subfiles/chap_DIA}            %% Outputs and Diagnostics
-\subfile{../subfiles/chap_OBS}            %% Observation operator
-\subfile{../subfiles/chap_ASM}            %% Assimilation increments
-\subfile{../subfiles/chap_STO}            %% Stochastic param.
-\subfile{../subfiles/chap_misc}           %% Miscellaneous topics
-\subfile{../subfiles/chap_CONFIG}         %% Predefined configurations
 
 %% Appendix
 %% ==============================================================================
 
-\appendix   % Chapter numbering is reset with letters now
+%% Chapter numbering is reset with letters now
+\appendix   
 
-\subfile{../subfiles/annex_A}             %% Generalised vertical coordinate
-\subfile{../subfiles/annex_B}             %% Diffusive operator
-\subfile{../subfiles/annex_C}             %% Discrete invariants of the eqs.
-\subfile{../subfiles/annex_iso}            %% Isoneutral diffusion using triads
-\subfile{../subfiles/annex_D}             %% Coding rules
+\input{appendices}
 
-%% Not included
-%\subfile{../subfiles/chap_model_basics_zstar}
-%\subfile{../subfiles/chap_DIU}
-%\subfile{../subfiles/chap_conservation}
-%\subfile{../subfiles/annex_E}            %% Notes on some on going staff
 
 %% Backmatter
@@ -120 +81 @@
 
 %% Bibliography
-\phantomsection
-\addcontentsline{toc}{chapter}{Bibliography}
-\bibliography{../main/NEMO_manual}
+\phantomsection\addcontentsline{toc}{chapter}{Bibliography}
+\bibliography{../main/bibliography}
 
 %% Index
 \clearpage
-\phantomsection
-\addcontentsline{toc}{chapter}{Index}
+\phantomsection\addcontentsline{toc}{chapter}{Index}
 \printindex