Changeset 11543 for NEMO/trunk/doc/latex/NEMO/main

Timestamp:

2019-09-13T15:57:52+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Implementation of convention for labelling references + files renaming
Now each reference is supposed to have the information of the chapter in its name
to identify quickly which file contains the reference (\label{$prefix:$chap_...)

Rename the appendices from 'annex_' to 'apdx_' to conform with the prefix used in labels (apdx:...)
Suppress the letter numbering

Location:

NEMO/trunk/doc/latex/NEMO/main

Files:

• appendices.tex (modified) (2 diffs)
• chapters.tex (modified) (1 diff)
• introduction.tex (modified) (4 diffs)

NEMO/trunk/doc/latex/NEMO/main/appendices.tex

@@ -1 +1 @@
 
-\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_DOMAINcfg}     %% Brief notes on DOMAINcfg
+\subfile{../subfiles/apdx_s_coord}      %% Generalised vertical coordinate
+\subfile{../subfiles/apdx_diff_opers}   %% Diffusive operators
+\subfile{../subfiles/apdx_invariants}   %% Discrete invariants of the eqs.
+\subfile{../subfiles/apdx_triads}       %% Isoneutral diffusion using triads
+\subfile{../subfiles/apdx_DOMAINcfg}    %% Brief notes on DOMAINcfg
 
 %% Not included
@@ -10 +10 @@
 %\subfile{../subfiles/chap_DIU}
 %\subfile{../subfiles/chap_conservation}
-%\subfile{../subfiles/annex_E}            %% Notes on some on going staff
-
+%\subfile{../subfiles/apdx_algos}   %% Notes on some on going staff

NEMO/trunk/doc/latex/NEMO/main/chapters.tex

@@ -13 +13 @@
 \subfile{../subfiles/chap_STO}            %% Stochastic param.
 \subfile{../subfiles/chap_misc}           %% Miscellaneous topics
-\subfile{../subfiles/chap_CONFIG}         %% Predefined configurations
+\subfile{../subfiles/chap_cfgs}           %% Predefined configurations
 
 %% Not included

NEMO/trunk/doc/latex/NEMO/main/introduction.tex

@@ -56 +56 @@
 
 \begin{description}
-\item [\nameref{chap:PE}] presents the equations and their assumptions, the vertical coordinates used,
+\item [\nameref{chap:MB}] presents the equations and their assumptions, the vertical coordinates used,
 and the subgrid scale physics.
 The equations are written in a curvilinear coordinate system, with a choice of vertical coordinates
@@ -63 +63 @@
 Dimensional units in the meter, kilogram, second (MKS) international system are used throughout.
 The following chapters deal with the discrete equations.
-\item [\nameref{chap:STP}] presents the model time stepping environment.
+\item [\nameref{chap:TD}] presents the model time stepping environment.
 it is a three level scheme in which the tendency terms of the equations are evaluated either
 centered in time, or forward, or backward depending of the nature of the term.
@@ -123 +123 @@
 \item [\nameref{chap:ASM}] describes how increments produced by
 data \textbf{A}s\textbf{S}i\textbf{M}ilation may be applied to the model equations.
+\item [\nameref{chap:STO}]
 \item [\nameref{chap:MISC}] (including solvers)
-\item [\nameref{chap:CFG}] provides finally a brief introduction to
+\item [\nameref{chap:CFGS}] provides finally a brief introduction to
 the pre-defined model configurations
 (water column model \texttt{C1D}, ORCA and GYRE families of configurations).
@@ -133 +134 @@
 
 \begin{description}
-\item [\nameref{apdx:s_coord}]
-\item [\nameref{apdx:diff_oper}]
-\item [\nameref{apdx:invariants}]
-\item [\nameref{apdx:triads}]
-\item [\nameref{apdx:DOMAINcfg}]
-\item [\nameref{apdx:coding}]
+\item [\nameref{apdx:SCOORD}]
+\item [\nameref{apdx:DIFFOPERS}]
+\item [\nameref{apdx:INVARIANTS}]
+\item [\nameref{apdx:TRIADS}]
+\item [\nameref{apdx:DOMCFG}]
+\item [\nameref{apdx:CODING}]
 \end{description}