Changeset 11433 for NEMO/trunk/doc/latex/TOP/main

Timestamp:

2019-08-12T21:44:18+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Pre-implementation of new cover page and new headings style for reference manuals

Cover page

The layout of the frontpage has been completely redesigned,
a coloured banner has been added to emphasize the title and easily identify each manual
between them.
The chosen color for each document (blue for NEMO, gray for SI³ and green for TOP) will be
used throughout the manual for the links and in the chapter headings.
The list of authors (writers/editors/reviewers) for the version of the manual is given next to
the abstract, which is now included in the frontpage.
A link to an existing ORCID profile for the author precedes its name.
Few settings have been added to each definitions.tex in order to adjust the rendering of the cover page (vertical spaces above and below the title, a subtitle, the width for authors list and
abstract section)

Headings

• header: chapter number and title for even pages, same infos for section otherwise
• footer: name of the manual and page numbering with the total number of pages (reverse order between odd/even pages)

For the chapter heading, a new style 'Bjornstrup' from fncychap package is now use.

Abstract

Split the section in two paragraphs for all manuals

1. Common description with almost the same sentences only customized by the general infos of the model
2. Specific part for the characteristics of the model

Troubleshooting

As announced, I have introduced some icons from academicons and fontawesome packages.
It required to switch from pdflatex to xelatex for the compilation and it prevents from now
the building of the whole document.
Also the PDF generated does not look nice due to the font

Work in progress...

Location:

NEMO/trunk/doc/latex/TOP/main

Files:

• definitions.tex (modified) (1 diff)
• foreword.tex (modified) (1 diff)
• thanks.tex (modified) (1 diff)

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

@@ -2 +2 @@
 \def \engine{TOP}
 
-%% Title (variable name already use by 'titling' pkg)
-\def \heading{Tracers in Ocean Paradigm (TOP) \\ The NEMO passive tracers engine}
+%% Title and cover page settings
+\def \spacetop{  \vspace*{1.3cm} }
+\def \heading{Tracers in Ocean Paradigm (TOP)
+\def \subheading{The NEMO passive tracers engine}
+\def \spacedown{ \vspace*{1cm  } }
+\def \authorswidth{0.15\linewidth}
+\def \rulelenght{110pt}
+\def \abstractwidth{0.7\linewidth}
 
-%% Authors (thanks will apply to the second author)
-\def \firstauthor{}
-\def \secondauthor{NEMO TOP Working Group}
+%% Color for document (frontpage banner, links and chapter boxes)
+\def \setcolor{ \definecolor{manualcolor}{cmyk}{1, 0, 1, 0.4} }
 
 %% IPSL publication number

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

@@ +1 @@
+%% ================================================================
+%% Abstract
+%% ================================================================
+
+%% Common part between NEMO-SI3-TOP
+``Tracers in Ocean Paradigm'' (\TOP) is the passive tracers engine of
+the \NEMO\ ocean model (``Nucleus for European Modelling of the Ocean'').
+It is intended to be a flexible tool for studying the on/offline oceanic tracers transport and
+the biogeochemical processes (``green ocean''),
+as well as its interactions with the other components of the Earth climate system over
+a wide range of space and time scales.
+\TOP\ is interfaced with the \NEMO\ ocean engine, and,
+via the \href{http://portal.enes.org/oasis}{OASIS} coupler,
+with several atmospheric general circulation models.
+%It also supports two-way grid embedding by means of the \href{http://agrif.imag.fr}{AGRIF} software.
+
+%% Specific part
+This component provides the physical constraints and boundaries conditions for
+oceanic tracers transport and represents a generalized, hardwired interface toward
+biogeochemical models to enable a seamless coupling.
+In particular, transport dynamics are supplied by the ocean dynamical core thus
+enabling the use of all available advection and diffusion schemes in both on- and off-line modes.
+\TOP\ is designed to handle multiple oceanic tracers through a modular approach and
+it includes different sub-modules: ocean water age, inorganic carbon (CFCs) \& radiocarbon (C14b),
+built-in biogeochemical model (PISCES), and prototype for user-defined cases or
+coupling with alternative biogeochemical models (\eg \href{http://www.bfm-community.eu}{BFM}).

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

@@ -1 @@
-\'{E}th\'{e} Christian, 
-Lovato Tomas, 
-Aumont Olivier, 
-Palmi\'{e}ri Julien, 
-Mouchet Anne, 
-Nurser Georges, 
-Yool Andrew
-
+Olivier Aumont         \\
+Christian \'{E}th\'{e} \\
+Tomas Lovato           \\
+Anne Mouchet           \\
+Georges Nurser         \\
+Julien Palmi\'{e}ri    \\
+Andrew Yool