Changeset 10354 for NEMO/trunk/doc/latex/NEMO/subfiles/annex_D.tex

Timestamp:

2018-11-21T17:59:55+01:00 (5 years ago)

Author:

nicolasmartin

Message:

Vast edition of LaTeX subfiles to improve the readability by cutting sentences in a more suitable way
Every sentence begins in a new line and if necessary is splitted around 110 characters lenght for side-by-side visualisation,
this setting may not be adequate for everyone but something has to be set.
The punctuation was the primer trigger for the cutting process, otherwise subordinators and coordinators, in order to mostly keep a meaning for each line

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/annex_D.tex (modified) (7 diffs)

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

@@ -13 +13 @@
 
 
-A "model life" is more than ten years. Its software, composed of a few 
-hundred modules, is used by many people who are scientists or students 
-and do not necessarily know every aspect of computing very well. 
-Moreover, a well thought-out program is easier to read and understand, 
-less difficult to modify, produces fewer bugs and is easier to maintain. 
-Therefore, it is essential that the model development follows some rules :
+A "model life" is more than ten years.
+Its software, composed of a few hundred modules, is used by many people who are scientists or students and
+do not necessarily know every aspect of computing very well.
+Moreover, a well thought-out program is easier to read and understand, less difficult to modify,
+produces fewer bugs and is easier to maintain.
+Therefore, it is essential that the model development follows some rules:
 
 - well planned and designed
@@ -32 +32 @@
 - flexible.
 
-To satisfy part of these aims, \NEMO is written with a coding standard which 
-is close to the ECMWF rules, named DOCTOR \citep{Gibson_TR86}. 
-These rules present some advantages like :
+To satisfy part of these aims, \NEMO is written with a coding standard which is close to the ECMWF rules,
+named DOCTOR \citep{Gibson_TR86}. 
+These rules present some advantages like:
 
 - to provide a well presented program
 
-- to use rules for variable names which allow recognition of their type 
+- to use rules for variable names which allow recognition of their type
 (integer, real, parameter, local or shared variables, etc. ). 
 
@@ -49 +49 @@
 \label{sec:D_structure}
 
-Each program begins with a set of headline comments containing :
+Each program begins with a set of headline comments containing:
 
 - the program title
@@ -65 +65 @@
 - the author name(s), the date of creation and any updates.
 
-- Each program is split into several well separated sections and 
+- Each program is split into several well separated sections and
 sub-sections with an underlined title and specific labelled statements.
 
 - A program has not more than 200 to 300 lines.
 
-A template of a module style can be found on the NEMO depository 
-in the following file : NEMO/OPA\_SRC/module\_example.
+A template of a module style can be found on the NEMO depository in the following file:
+NEMO/OPA\_SRC/module\_example.
 % ================================================================
 % Coding conventions
@@ -78 +78 @@
 \label{sec:D_coding}
 
-- Use of the universal language \textsc{Fortran} 90, and try to avoid obsolescent
-features like statement functions, do not use GO TO and EQUIVALENCE statements.
-
-- A continuation line begins with the character {\&} indented by three spaces 
-compared to the previous line, while the previous line ended with the character {\&}.
-
-- All the variables must be declared. The code is usually compiled with implicit none.
+- Use of the universal language \textsc{Fortran} 90, and try to avoid obsolescent features like statement functions,
+do not use GO TO and EQUIVALENCE statements.
+
+- A continuation line begins with the character {\&} indented by three spaces compared to the previous line,
+while the previous line ended with the character {\&}.
+
+- All the variables must be declared.
+The code is usually compiled with implicit none.
  
-- Never use continuation lines in the declaration of a variable. When searching a 
-variable in the code through a \textit{grep} command, the declaration line will be found.
-
-- In the declaration of a PUBLIC variable, the comment part at the end of the line 
-should start with the two characters "\verb?!:?". the following UNIX command, \\
+- Never use continuation lines in the declaration of a variable.
+When searching a variable in the code through a \textit{grep} command, the declaration line will be found.
+
+- In the declaration of a PUBLIC variable, the comment part at the end of the line should start with
+the two characters "\verb?!:?".
+The following UNIX command, \\
 \verb?grep var_name *90 \ grep \!: ? \\
 will display the module name and the line where the var\_name declaration is.
 
-- Always use a three spaces indentation in DO loop, CASE, or IF-ELSEIF-ELSE-ENDIF 
-statements.
+- Always use a three spaces indentation in DO loop, CASE, or IF-ELSEIF-ELSE-ENDIF statements.
 
 - use a space after a comma, except when it appears to separate the indices of an array.
@@ -109 +110 @@
 \label{sec:D_naming}
 
-The purpose of the naming conventions is to use prefix letters to classify 
-model variables. These conventions allow the variable type to be easily 
-known and rapidly identified. The naming conventions are summarised 
-in the Table below:
+The purpose of the naming conventions is to use prefix letters to classify model variables.
+These conventions allow the variable type to be easily known and rapidly identified.
+The naming conventions are summarised in the Table below:
 
 
@@ -192 +192 @@
 %--------------------------------------------------------------------------------------------------------------
 
-N.B.   Parameter here, in not only parameter in the \textsc{Fortran} acceptation, it is also used for code variables 
-that are read in namelist and should never been modified during a simulation. 
+N.B. Parameter here, in not only parameter in the \textsc{Fortran} acceptation,
+it is also used for code variables that are read in namelist and should never been modified during a simulation. 
 It is the case, for example, for the size of a domain (jpi,jpj,jpk).