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.
Changeset 10442 for NEMO/trunk/doc/latex/NEMO/main – NEMO

Ignore:
Timestamp:
2018-12-21T15:18:38+01:00 (5 years ago)
Author:
nicolasmartin
Message:

Front page edition, cleaning in custom LaTeX commands and add index for single subfile compilation

  • Use \thanks storing cmd to refer to the ST members list for 2018 in an footnote on the cover page
  • NEMO and Fortran in small capitals
  • Removing of unused or underused custom cmds, move local cmds to their respective .tex file
  • Addition of new ones (\zstar, \ztilde, \sstar, \stilde, \ie, \eg, \fortran, \fninety)
  • Fonts for indexed items: italic font for files (modules and .nc files), preformat for code (CPP keys, routines names and namelists content)
Location:
NEMO/trunk/doc/latex/NEMO/main
Files:
1 deleted
2 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/doc/latex/NEMO/main/NEMO_manual.sty

    r10146 r10442  
    11%% ============================================================================== 
    2 %% NEMO_manual.sty: all customizations (packages, ) 
     2%% NEMO_manual.sty: all customizations (packages, styles, cmds) 
    33%% ============================================================================== 
    44 
    … …  
    1010\usepackage{caption}          %% caption 
    1111\usepackage{xcolor}           %% color 
    12 \usepackage{silence}          %% compilation 
    1312\usepackage{times}            %% font 
    1413\usepackage{hyperref}         %% hyper 
    … …  
    2423%% Extensions in bundle package 
    2524 
    26 \usepackage{amssymb, graphicx, makeidx, tabularx, xspace} 
     25\usepackage{amssymb, graphicx, makeidx, tabularx} 
    2726 
    2827 
    … …  
    3231\graphicspath{{../../../figures/}} 
    3332\hypersetup{ 
    34    pdftitle={NEMO ocean engine}, pdfauthor={Gurvan Madec, and the NEMO team}, 
     33   pdftitle={NEMO ocean engine}, pdfauthor={Gurvan Madec, and NEMO System Team}, 
    3534   colorlinks 
    3635} 
    … …  
    4544\pagestyle{fancy} 
    4645\bibliographystyle{../main/ametsoc} 
    47  
    4846 
    4947%% Additionnal fonts 
    … …  
    103101 
    104102 
    105 %% Macros (to check) 
     103%% Global custom commands: \newcommand{<name>}[<args>][<first argument value>]{<code>} 
     104%% ============================================================================== 
    106105 
    107 \def\deg{$^{\circ}$} 
    108 \def\degC{$^{\circ}C$} 
    109 \def\degK{$^{\circ}K$} 
    110 \def\degN{$^{\circ}N$} 
    111 \def\degS{$^{\circ}S$} 
     106%% NEMO and Fortran in small capitals 
     107\newcommand{\NEMO}{\textsc{nemo}} 
     108\newcommand{\fortran}{\textsc{Fortran}} 
     109\newcommand{\fninety}{\textsc{Fortran 90}} 
    112110 
    113 \def\half{\textstyle\frac{1}{2}} 
    114 \def\hhalf{\scriptstyle\frac{1}{2}} 
     111%% Common aliases 
     112\renewcommand{\deg}[1][]{\ensuremath{^{\circ}#1}} 
     113\newcommand{\zstar }{\ensuremath{z^\star}} 
     114\newcommand{\sstar }{\ensuremath{s^\star}} 
     115\newcommand{\ztilde}{\ensuremath{\tilde z}} 
     116\newcommand{\stilde}{\ensuremath{\tilde s}} 
     117\newcommand{\ie}{\ensuremath{i.e.}} 
     118\newcommand{\eg}{\ensuremath{e.g.}} 
    115119 
    116 \def\quarter{\textstyle\frac{1}{4}} 
    117 \def\qquarter{\scriptstyle\frac{1}{4}} 
    118 \def\squarter{\sfrac{1}{4}} 
    119 \def\stwelfth{\sfrac{1}{12}} 
    120 \def\sthirtysixth{\sfrac{1}{36}} 
     120%% Inline maths 
     121\newcommand{\fractext}[2]{\textstyle \frac{#1}{#2}} 
     122\newcommand{\rdt}{\Delta t} 
    121123 
    122 \def\bgamma\boldsymbol{\gamma} 
    123 \def\rdt{\Delta t} 
     124%% Text env. for Gurvan 
     125\newcommand{\gmcomment}[1]{} 
     126 
     127%% Index (italic font for files, preformat for code) 
     128\newcommand{\ifile}[1]{\textit{#1.nc}          \index{Input NetCDF files!#1.nc}} 
     129\newcommand{\mdl}[1]{\textit{#1.F90}           \index{Modules!#1}} 
     130\newcommand{\jp}[1]{\texttt{#1}                \index{Model parameters!#1}} 
     131\newcommand{\key}[1]{\texttt{\textbf{key\_#1}} \index{CPP keys!key\_#1}} 
     132\newcommand{\ngn}[1]{\texttt{#1}               \index{Namelist Group Name!#1}} 
     133\newcommand{\np}[1]{\texttt{#1}                \index{Namelist variables!#1}} 
     134\newcommand{\rou}[1]{\texttt{#1}               \index{Routines!#1}} 
     135 
     136%% Maths 
     137\newcommand{\vect}[1]{\ensuremath{\mathbf{#1}}} 
     138\newcommand{\pd}[2][]{\ensuremath{\frac{\partial #1}{\partial #2}}} 
     139 
     140%% Shortened DOI in bibliography 
     141\newcommand{\doi}[1]{\href{http://dx.doi.org/#1}{doi:#1}} 
     142 
     143%% Namelists inclusion 
     144\newcommand{\nlst}[1]{\forfile{../../../namelists/#1}} 
    124145 
    125146 
    126 %% New commands 
     147%% Minted package: syntax highlighting configuration 
     148%% ============================================================================== 
    127149 
    128 \newcommand{\gmcomment}[1]{} 
    129 \newcommand{\sfcomment}[1]{} 
    130 \newcommand{\sgacomment}[1]{} 
     150%% Global highlighting style 
     151\setminted{style=emacs, fontsize=\scriptsize, breaklines, frame=leftline} 
     152\setminted[xml]{style=borland} %% Specific per language 
    131153 
    132 \newcommand{\nl}[1]{\texttt{\small{\textcolor{blue}{#1}}}} 
    133 \newcommand{\NEMO}{\textit{NEMO}\xspace} 
     154%% Oneliner 
     155\newmint[forline]{fortran}{}   % \forline|...| 
     156\newmint[xmlline]{xml}{}       % \xmlline|...| 
     157\newmint[cmd]{console}{}       % \cmd|...| 
    134158 
    135 \newcommand{\hf}[1]{\textit{#1.h90}\index{h90 file!#1}} 
    136 \newcommand{\ifile}[1]{\textit{#1.nc}\index{Input NetCDF files!#1.nc}} 
    137 \newcommand{\jp}[1]{\textit{#1}\index{Model parameters!#1}} 
    138 \newcommand{\key}[1]{\textbf{key\_#1}\index{CPP keys!key\_#1}} 
    139 \newcommand{\mdl}[1]{\textit{#1.F90}\index{Modules!#1}} 
    140 \newcommand{\ngn}[1]{\textit{#1}\index{Namelist Group Name!#1}} 
    141 \newcommand{\np}[1]{\textit{#1}\index{Namelist variables!#1}} 
    142 \newcommand{\rou}[1]{\textit{#1}\index{Routines!#1}} 
     159%% Multi-lines 
     160\newminted[forlines]{fortran}{}   % \begin{forlines} 
     161\newminted[xmllines]{xml}{}       % \begin{xmllines} 
     162\newminted[cmds]{console}{}       % \begin{cmds} 
     163\newminted[clines]{c}{}           % \begin{clines} 
    143164 
    144 \newcommand{\grad}{\nabla} 
    145 \newcommand{\gradh}{\nabla_h} 
     165%% File 
     166\newmintedfile[forfile]{fortran}{}   % \forfile{../namelists/nam...} 
    146167 
    147 \newcommand{\ew}[3]{{e_{3#1}}_{\,#2}^{\,#3} } 
    148 \newcommand{\vect}[1]{\ensuremath{\mathbf{#1}}} 
    149 \newcommand{\Div}{\grad\cdot} 
    150 \newcommand{\curl}{\nabla \times} 
    151 \newcommand{\pd}[2][]{\frac{\partial #1}{\partial #2}} 
    152 \newcommand{\alpbet} {\left(\alpha / \beta \right)} 
    153  
    154 \newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}} 
    155 \newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}} 
    156 \newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}} 
    157 \newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}} 
    158 \newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}} 
    159  
    160 \newcommand{\Alts}{{A}} 
    161 \newcommand{\Alt}{{A^{lT}}} 
    162  
    163 \newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}} 
    164 \newcommand{\rML}[1][i]{r_{\mathrm{ML}\,#1}} 
    165  
    166 \newcommand{\mygstrut}[2]{\rule[#1 em]{0pt}{#2 em}} 
    167 \newcommand{\mystrut}{\rule[-.9 em]{0pt}{1.79 em}} 
    168  
    169 \newcommand{\doi}[1]{\href{http://dx.doi.org/#1}{full-text}} 
    170  
    171 \newcommand{\nlst}[1]{\forfile{../../../namelists/#1}} 
     168%% Inline 
     169\newmintinline[forcode]{fortran}{fontsize=auto, frame=lines}   % \forcode{...} 
     170\newmintinline[xmlcode]{xml}{    fontsize=auto, frame=lines}   % \xmlcode{...} 
     171\newmintinline[snippet]{console}{fontsize=auto, frame=lines}   % \snippet{...} 

  • NEMO/trunk/doc/latex/NEMO/main/NEMO_manual.tex

    r10414 r10442  
    1717%% Custom style 
    1818\usepackage{../main/NEMO_manual} 
    19 \usepackage{../main/NEMO_minted} 
    2019 
    2120\makeindex 
    … …  
    2524%% ============================================================================== 
    2625 
    27 %% Trick to include biblio in subfile compilation 
    28 \newcommand{\biblio}{ 
    29   \bibliographystyle{../main/ametsoc} 
    30   \bibliography{../main/NEMO_manual} 
    31 } 
     26%% Include references and index for single subfile compilation 
     27\newcommand{\biblio}{\bibliography{../main/NEMO_manual}} 
     28\newcommand{\pindex}{\printindex} 
    3229 
    3330\begin{document} 
    3431 
    35 %% Trick to include biblio in subfile compilation 
    36 \def\biblio{} 
     32%% Override custom cmds for full manual compilation 
     33\renewcommand{\biblio}{} 
     34\renewcommand{\pindex}{} 
    3735 
    3836 
    … …  
    5149 
    5250\author{ 
    53 \Large Gurvan Madec, and the NEMO team                                                          \\ 
    54 \texttt{\small\href{mailto:gurvan.madec@locean-ipsl.umpc.fr}{gurvan.madec@locean-ipsl.umpc.fr}} \\ 
     51  \Large Gurvan Madec and NEMO System Team 
     52  \thanks{ 
     53    Yevgeny Aksenov, Mireck Andrejczuk, Mike Bell, Romain Bourdalle-Badie, Cl\'{e}ment Bricaud, 
     54    J\'{e}r\^{o}me Chanut, Stefania Ciliberti, Emanuela Clementi, Andrew Coward, Damiano Delrosso, 
     55    Massimiliano Drudi, Christian Eth\'{e}, Simona Flavoni, Doroteaciro Iovino, Claire L\'{e}vy, Tomas Lovato, 
     56    Nicolas Martin, S\'{e}bastien Masson, Pierre Mathiot, Gelsomina Mattia, Francesca Mele, Silvia Mocavero, 
     57    George Nurser, Enda O'Dea, Julien Paul, Cl\'{e}ment Rousset, Dave Storkey, Martin Vancoppenolle 
     58  }                                                        \\ 
     59                                                           \\ 
     60  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\ 
     61  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\ 
     62  \textit{ISSN 1288-1619} 
    5563} 
    5664 
    57 \date{ 
    58 Decembre 2017                                                                                \\ 
    59 {\small  -- version 4.0 alpha --}                                                            \\ 
    60 ~                                                                                            \\ 
    61 \textit{\small Note du P\^ole de mod\'{e}lisation de l'Institut Pierre-Simon Laplace No 27 } \\ 
    62 \vspace{0.45cm}{ ISSN No 1288-1619.} 
    63 } 
     65\date{Version 4.0 -- January 2019} 
    6466%\date{\today} 
    6567 
Note: See TracChangeset for help on using the changeset viewer.