Changeset 11176 for NEMO/trunk/doc/latex/global/new_cmds.tex

Timestamp:

2019-06-24T21:55:11+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Implementation of multi-indexes instead of an indiscrimate aggregate index
Creation of 5 sections under Indexes chapter for the most relevant lists of index entries:
namelist blocks and parameters, CPP keys, modules and subroutines.

• indexes.tex & index.ist: new file in global directory for index management
• Add symbolic links under main to non-existing *.idx before LaTeX compilation to reduce trivial error messages with makeindex
• Create latexmkrc init file loaded latexmk with '-r' option in order to apply the style rules to the indexes with the sequence of several compilations

Other changes:

• Define a preamble.tex with the list of files to load from global folder
• Integrate 'Citation' subsubsection in new info_page.tex for the 2^nd page along with 'frontpage.tex' for the cover, in order to have a clear distinction with \maketitle in the main LaTeX document
• Move 'Foreword' chapter from subfiles to main as more appropriate

Bugfixes with few attempts of HTML export

• One single location for defining the paths to search for images with \graphicspath in packages.tex
• Renaming of authors variables (\1stauthor -> \firstauthor and so one)
• Update of LaTeX dependencies in terms of new pkgs (DEPS)

Location:

NEMO/trunk/doc/latex/global

Files:

• . (modified) (1 prop)
• new_cmds.tex (modified) (3 diffs)

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

@@ -2 +2 @@
 %% ==============================================================================
 
+%% Include references and index for compilation of single subfile 
+\newcommand{\mtoc}{\minitoc}
+\newcommand{\biblio}{\bibliography{../main/bibliography}}
+\newcommand{\pindex}{\printindex}
+
 %% NEMO and Fortran in small capitals
-\newcommand{\NEMO}{\textsc{nemo}}
-\newcommand{\fortran}{\textsc{Fortran}}
-\newcommand{\fninety}{\textsc{Fortran 90}}
+\newcommand{\NEMO}{\textsc{nemo}~}
+\newcommand{\fortran}{\textsc{Fortran}~}
+\newcommand{\fninety}{\textsc{Fortran 90}~}
 
 %% Common aliases
@@ -13 +18 @@
 \newcommand{\ztilde}{\ensuremath{\tilde z}}
 \newcommand{\stilde}{\ensuremath{\tilde s}}
-\newcommand{\ie}{\ensuremath{i.e.}}
-\newcommand{\eg}{\ensuremath{e.g.}}
+\newcommand{\ie}{\ensuremath{i.e.}~}
+\newcommand{\eg}{\ensuremath{e.g.}~}
 
 %% Inline maths
@@ -22 +27 @@
 %% Text env. for Gurvan
 \newcommand{\gmcomment}[1]{}
-
-%% Index entries (italic font for files, preformat for code)
-\newcommand{\hf}[1]{\textit{#1.h90}            \index{h90 files!#1}}
-\newcommand{\ifile}[1]{\textit{#1.nc}          \index{Input NetCDF files!#1.nc}}
-\newcommand{\jp}[1]{\texttt{#1}                \index{Model parameters!#1}}
-\newcommand{\key}[1]{\texttt{\textbf{key\_#1}} \index{CPP keys!key\_#1}}
-\newcommand{\mdl}[1]{\textit{#1.F90}           \index{Modules!#1}}
-\newcommand{\ngn}[1]{\texttt{#1}               \index{Namelist Group Names!#1}}
-\newcommand{\np}[1]{\texttt{#1}                \index{Namelist parameters!#1}}
-\newcommand{\rou}[1]{\texttt{#1}               \index{Routines!#1}}
 
 %% Maths