Changeset 11299 for NEMO/trunk/doc/latex/NEMO

Timestamp:

2019-07-18T16:27:43+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Review of the coding rules chapter: convert it to a shared file for 3 manuals

• Move annex_D.tex and NEMO_coding_conv.tex to ./latex/global
• Rename NEMO_coding_conv.tex to coding_rules.tex and redesign it as a chapter and not a standalone document
• Edit document.tex to include the coding rules by default at the end of the appendix

Location:

NEMO/trunk/doc/latex/NEMO

Files:

• main/appendices.tex (modified) (1 diff)
• subfiles/introduction.tex (modified) (2 diffs)

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

@@ -4 +4 @@
 \subfile{../subfiles/annex_C}             %% Discrete invariants of the eqs.
 \subfile{../subfiles/annex_iso}            %% Isoneutral diffusion using triads
-\subfile{../subfiles/annex_D}             %% Coding rules
 
 %% Not included

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

@@ -151 +151 @@
 The coding rules for OPA include conventions for naming variables,
 with different starting letters for different types of variables (real, integer, parameter\ldots).
-Those rules are briefly presented in \autoref{apdx:D} and a more complete document is available .
+Those rules are briefly presented in \autoref{apdx:coding} and a more complete document is available .
 
 The model is organized with a high internal modularity based on physics.
@@ -158 +158 @@
 To make it easier for the user to find his way around the code, the module names follow a three-letter rule.
 For example, \mdl{traldf} is a module related to the TRAcers equation, computing the Lateral DiFfussion.
-%The complete list of module names is presented in \autoref{apdx:D}.      %====>>>> to be done !
+%The complete list of module names is presented in \autoref{apdx:coding}.      %====>>>> to be done !
 Furthermore, modules are organized in a few directories that correspond to their category,
 as indicated by the first three letters of their name (\autoref{tab:chapters}).