Changeset 11152

Timestamp:

2019-06-20T15:11:32+02:00 (6 years ago)

Author:

nicolasmartin

Message:

Modifications in NEMO manual disseminated to SI³ and TOP

Location:

NEMO/trunk/doc/latex

Files:

• SI3 (modified) (1 prop)
• SI3/main (modified) (1 prop)
• SI3/main/SI3_manual.tex (modified) (5 diffs)
• SI3/namelists (modified) (1 prop)
• SI3/subfiles (modified) (1 prop)
• TOP (modified) (1 prop)
• TOP/main (modified) (1 prop)
• TOP/main/TOP_manual.tex (modified) (5 diffs)
• TOP/subfiles (modified) (1 prop)

NEMO/trunk/doc/latex/SI3/main/SI3_manual.tex

@@ -8 +8 @@
 
 %% Document layout
-\documentclass{book}
+\documentclass[draft]{scrreport}
 
 %% Custom style (.sty)
-\usepackage{../../styles/NEMO}
+\usepackage{../../global/packages}
 \hypersetup{
-  pdftitle={SI³ – Sea Ice modelling Integrated Initiative – The NEMO Sea Ice engine},
+  pdftitle={Sea Ice modelling Integrated Initiative (SI³) -- The NEMO sea ice engine},
   pdfauthor={NEMO Sea Ice Working Group},
   colorlinks
@@ -26 +26 @@
 %% End of common preamble between main and sub-files
 \begin{document}
+\pagenumbering{gobble}
 
 %% Override custom cmds for full manual compilation
@@ -35 +36 @@
 %% ==============================================================================
 
-\graphicspath{{../../figures/logos/}}
-
-%% Frontpage
-\title{
-  \includegraphics[height=0.05\textheight]{CMCC}\hfill
-  \includegraphics[height=0.05\textheight]{CNRS}\hfill
-  \includegraphics[height=0.05\textheight]{MOI} \hfill
-  \includegraphics[height=0.05\textheight]{UKMO}\hfill
-  \includegraphics[height=0.05\textheight]{NERC}       \\
-  {\Huge SI$^3$ \\}
-  {\Large Sea Ice modelling Integrated Initiative -- The NEMO Sea Ice engine}\\ 
-  {\small \textcolor{red}{First draft documentation. Needs completion and rewriting}.}
+\title{Sea Ice modelling Integrated Initiative (SI$^3$) -- The NEMO sea ice engine}
+%  \small{\textcolor{red}{First draft documentation. Needs completion and rewriting.}}
 }
-\author{The NEMO Sea Ice Working Group
-%  \thanks{
-%
-%  }                                                        \\
-  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
-  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
-  \textit{ISSN 1288-1619}
+\author{NEMO Sea Ice Working Group\thanks{
+    TBD
+  }
 }
 \date{\today}
 
-\maketitle
-\frontmatter
+%% Title and information pages
+\input{../../global/frontpages}
+
+%% Citation embedded
+\textsf{
+``{\bfseries Sea Ice modelling Integrated Initiative (SI$^3$) -- The NEMO sea ice engine}'', 
+NEMO Sea Ice Working Group, 
+{\em Scientific Notes of Climate Modelling Center (31)}, ISSN 1288-1619, 
+Institut Pierre-Simon Laplace (IPSL), 
+\href{http://doi.org/10.5281/zenodo.1471689}{doi:10.5281/zenodo.1471689}
+}
+
+\newpage
+%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
+\pagenumbering{roman}
+
+\subfile{../subfiles/foreword}            %% Foreword
+
 
 %% ToC i.e. Table of Contents
+\newpage
 \dominitoc
 \tableofcontents
 
+\clearpage
 
 %% Mainmatter
 %% ==============================================================================
 
-\mainmatter
+%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
+\pagenumbering{arabic}
 
 \graphicspath{{../../figures/SI3/}}
 
 \subfile{../subfiles/todolist}
-
-%% Abstract - Foreword
-
-\subfile{../subfiles/abstract_foreword}
 
 % Introduction
@@ -86 +88 @@
 
 \subfile{../subfiles/chap_model_basics}
-
 \subfile{../subfiles/chap_domain}
-
 \subfile{../subfiles/chap_dynamics}
-
 \subfile{../subfiles/chap_transport}
-
 \subfile{../subfiles/chap_ridging_rafting}
-
 \subfile{../subfiles/chap_radiative_transfer}
-
 \subfile{../subfiles/chap_thermo}
-
 \subfile{../subfiles/chap_interfaces}
-
 \subfile{../subfiles/chap_output_diagnostics}
-
 \subfile{../subfiles/chap_single_category_use}
-
 \subfile{../subfiles/chap_bdy_agrif}
-
 \subfile{../subfiles/chap_miscellaneous}
 
 %% Appendix
+%% ==============================================================================
 
-%\appendix
+%\appendix   % Chapter numbering is reset with letters now
+
+
 %% Backmatter
 %% ==============================================================================
 
-\backmatter
+%\backmatter   %% Chapter numbering off
 
 %% Bibliography
-\cleardoublepage
 \phantomsection
 \addcontentsline{toc}{chapter}{Bibliography}
@@ -125 +118 @@
 
 %% Index
-\cleardoublepage
+\clearpage
 \phantomsection
 \addcontentsline{toc}{chapter}{Index}

NEMO/trunk/doc/latex/TOP/main/TOP_manual.tex

@@ -8 +8 @@
 
 %% Document layout
-\documentclass{book}
+\documentclass[draft]{scrreport}
 
 %% Custom style (.sty)
-\usepackage{../../styles/NEMO}
+\usepackage{../../global/packages}
 \hypersetup{
-  pdftitle={TOP – Tracers in Ocean Paradigm – The NEMO Tracers engine},
+  pdftitle={Tracers in Ocean Paradigm (TOP) -- The NEMO passive tracers engine},
   pdfauthor={NEMO TOP Working Group},
   colorlinks
@@ -26 +26 @@
 %% End of common preamble between main and sub-files
 \begin{document}
+\pagenumbering{gobble}
 
 %% Override custom cmds for full manual compilation
@@ -35 +36 @@
 %% ==============================================================================
 
-\graphicspath{{../../figures/logos/}}
-
-%% Frontpage
-\title{
-  \includegraphics[height=0.05\textheight]{CMCC}\hfill
-  \includegraphics[height=0.05\textheight]{CNRS}\hfill
-  \includegraphics[height=0.05\textheight]{MOI} \hfill
-  \includegraphics[height=0.05\textheight]{UKMO}\hfill
-  \includegraphics[height=0.05\textheight]{NERC}       \\
-  {\Huge TOP \\}
-  {\Large Tracer in Ocean Paradigm -- The NEMO Passive Tracer engine}\\
-  \small \textcolor{red}{First draft documentation. Needs completion and rewriting}. \\
+\title{Tracer in Ocean Paradigm (TOP) -- The NEMO passive tracer engine}
+%  \small{\textcolor{red}{First draft documentation. Needs completion and rewriting.}}
 }
-\author{The NEMO-TOP Group
-  \thanks{
-    Eth\'{e} Christian, Lovato Thomas, Aumont Olivier, Palmi\'{e}ri Julien,
+\author{NEMO TOP Working Group\thanks{
+    \'{E}th\'{e} Christian, Lovato Tomas, Aumont Olivier, Palmi\'{e}ri Julien,
     Mouchet Anne, Nurser Georges, Yool Andrew
-  }\\
-  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\
-  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\
-  \textit{ISSN 1288-1619}
+  }
 }
 \date{\today}
 
-\maketitle
-\frontmatter
+%% Title and information pages
+\input{../../global/frontpages}
+
+%% Citation embedded
+\textsf{
+``{\bfseries Tracer in Ocean Paradigm (TOP) -- The NEMO passive tracer engine}'', 
+NEMO TOP Working Group, 
+{\em Scientific Notes of Climate Modelling Center (28)}, ISSN 1288-1619, 
+Institut Pierre-Simon Laplace (IPSL), 
+\href{http://doi.org/10.5281/zenodo.1471700}{doi:10.5281/zenodo.1471700}
+}
+
+\newpage
+%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
+\pagenumbering{roman}
+
+\subfile{../subfiles/foreword}            %% Foreword
+
 
 %% ToC i.e. Table of Contents
-
+\newpage
 \dominitoc
 \tableofcontents
 
+\clearpage
 
 %% Mainmatter
 %% ==============================================================================
 
-\mainmatter
+%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
+\pagenumbering{arabic}
 
 \graphicspath{{../../figures/TOP/}}
@@ -81 +86 @@
 
 %% Appendix
+%% ==============================================================================
 
-%\appendix
+%\appendix   % Chapter numbering is reset with letters now
+
+
 %% Backmatter
 %% ==============================================================================
 
-\backmatter
+%\backmatter   %% Chapter numbering off
 
 %% Bibliography
-\cleardoublepage
 \phantomsection
 \addcontentsline{toc}{chapter}{Bibliography}
@@ -95 +102 @@
 
 %% Index
-\cleardoublepage
+\clearpage
 \phantomsection
 \addcontentsline{toc}{chapter}{Index}