Changeset 11577 for NEMO/trunk/doc/latex/global/indexes.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/global/indexes.tex (modified) (2 diffs)

NEMO/trunk/doc/latex/global/indexes.tex

@@ -1 +1 @@
 
 \usepackage{imakeidx}
+
+%% Naming customization
+\renewcommand{\listingname}{namelist}
+\renewcommand{\listlistingname}{List of Namelists}
 
 %% Index entries (italic font for files, preformat for code)
@@ -8 +12 @@
 \newcommand{\key}[1]{  \index[keys]{#1@\texttt{\textbf{key\_#1}}} \texttt{\textbf{key\_#1}}}
 \newcommand{\mdl}[1]{  \index[modules]{#1@\textit{#1.F90}}        \textit{#1.F90}          }
-\newcommand{\nam}[1]{  \index[blocks]{#1@\texttt{\&nam#1}}        \forcode{&nam#1}         }
-\newcommand{\np}[1]{   \index[parameters]{#1@\texttt{#1}}         \texttt{#1}              }
-\newcommand{\npnew}[2][]{\index[parameters]{#2@\texttt{#2}}       \forcode{#2#1}           }
+\newcommand{\nam}[2]{  \index[blocks]{\texttt{\&nam#2}}   \forcode{&nam#1} (\autoref{lst:nam#1})         }
+\newcommand{\np}[3][]{\index[parameters]{\texttt{#3}}       \forcode{#2#1}           }
+%\newcommand{\nam}[1]{  \index[blocks]{\texttt{\&nam#1}}           \forcode{&nam#1}         }
+%\newcommand{\np}[1]{   \index[parameters]{\texttt{#1}}            \forcode{#1}              }
 \newcommand{\rou}[1]{  \index[subroutines]{#1@\texttt{#1}}        \texttt{#1}              }
+
 
 \indexsetup{toclevel=section, othercode=\small}