source: NEMO/trunk/doc/latex/global/indexes.tex @ 11176

Last change on this file since 11176 was 11176, checked in by nicolasmartin, 15 months ago

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 2nd 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)
File size: 1.1 KB
Line 
1
2\usepackage{imakeidx}
3
4%% Index entries (italic font for files, preformat for code)
5\newcommand{\hf}[1]{\textit{#1.h90}   \index{h90 files!#1}}
6\newcommand{\ifile}[1]{\textit{#1.nc} \index{Input NetCDF files!#1.nc}}
7\newcommand{\jp}[1]{\texttt{#1}       \index{Model parameters!#1}}
8\newcommand{\key}[1]{\index[keys]{#1}       \texttt{\textbf{key\_#1}}}
9\newcommand{\mdl}[1]{\index[modules]{#1}    \textit{#1.F90}          }
10\newcommand{\ngn}[1]{\index[blocks]{#1}     \texttt{#1}              }
11\newcommand{\np}[1]{ \index[parameters]{#1} \texttt{#1}              }
12\newcommand{\rou}[1]{\index[subroutines]{#1}   \texttt{#1}              }
13
14\indexsetup{toclevel=section, othercode=\small}
15
16\makeindex[intoc=true, name=keys       , title=CPP keys                      ]
17\makeindex[intoc=true, name=modules    , title=Modules                       ]
18\makeindex[intoc=true, name=blocks     , title=Namelist blocks               ]
19\makeindex[intoc=true, name=parameters , title=Namelist parameters, columns=3]
20\makeindex[intoc=true, name=subroutines, title=Subroutines                   ]
21
Note: See TracBrowser for help on using the repository browser.