Changeset 11577 for NEMO/trunk/doc/latex/NEMO/subfiles/apdx_algos.tex

Timestamp:

2019-09-19T19:01:38+02:00 (5 years ago)

Author:

nicolasmartin

Message:

New LaTeX commands \nam and \np to mention namelist content
(Partial commit to serve as a backup before other large edits)
In order to benefit of the syntax highlighting and to have a simpler syntax for
citing namelist block (\nam) and parameter (\np) with an optional variable assignment (\forcode{...}),
at this time the only viable solution I found is to require a double marker for
what it looks like the same item:

1. Marker with the real name: 'tra_adv' block or 'ln_flx' parameter
2. Marker with underscore character escaping: 'tra\_adv' block or 'ln\_flx' parameter

Despite many searches and attempts, I did not find a workaround to edit on-the-fly one or
the other marker.
In fact, the problem is on one side that the LaTeX index interprets '_' as a switch for lowering like
in math mode while on the other hand the backslash is considered for Pygments as a typo in Fortran
(red box).

For instance, \nam and \np have as of now the aforementioned 2 mandatory arguments in
the previous order (between braces) + an optional argument for \np when the parameter is defined
(between brackets at the first position):

• \nam: LaTeX code in the \nam{tra_adv}{tra\_adv} -> PDF ' in the &namtra_adv (namelist X.X) ' with syntax highlighting, the hyperlink and the index entry
• \np: LaTeX code \np[=.true.]{ln_flx}{ln\_flx} -> PDF ln_flux=.true. with syntax highlighting for the whole string and the entry in the 'parameters' index

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/apdx_algos.tex (modified) (2 diffs)

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

@@ -17 +17 @@
 %        UBS scheme
 % -------------------------------------------------------------------------------------------------------------
-\section{Upstream Biased Scheme (UBS) (\protect\np{ln\_traadv\_ubs}\forcode{ = .true.})}
+\section{Upstream Biased Scheme (UBS) (\protect\np{ln_traadv_ubs}{ln\_traadv\_ubs}\forcode{ = .true.})}
 \label{sec:ALGOS_tra_adv_ubs}
 
@@ -59 +59 @@
 the control of artificial diapycnal fluxes is of paramount importance.
 It has therefore been preferred to evaluate the vertical flux using the TVD scheme when
-\np{ln\_traadv\_ubs}\forcode{ = .true.}.
+\np{ln_traadv_ubs}{ln\_traadv\_ubs}\forcode{ = .true.}.
 
 For stability reasons, in \autoref{eq:TRA_adv_ubs}, the first term which corresponds to