Changeset 11176 for NEMO/trunk/doc/latex/global/document.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)
• document.tex (modified) (5 diffs)

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

@@ +1 @@
+
 %% ==============================================================================
-%% Reference Manual
+%% Template structure for reference manual
 %% ==============================================================================
 
 %% NEMO release version
-\def\version{4.0rc~}
+\def \version{4.0rc~}
 
 %% Preamble
@@ -12 +13 @@
 \documentclass[draft]{scrreport}
 
-%% Load manual definitions
-\input{definitions}
+%% Load the configuration of the manual
+\input{../main/definitions}
 
-%% Load all *.tex files from './latex/global' directory
-\input{../../global/packages}
-\input{../../global/highlighting}
-\input{../../global/new_cmds}
-\input{../../global/styles}
-\input{../../global/todonotes}
+%% Load global *.tex files
+\input{../../global/preamble}
 
-%% Include references and index for single subfile compilation
-\newcommand{\biblio}{\bibliography{../main/bibliography}}
-\newcommand{\pindex}{\printindex}
+\dominitoc
 
-\makeindex
+%% Launch the creation of the indexes
+\input{../../global/indexes}
+
 
 %% End of common preamble between main and sub-files
+%% Override custom cmds for full manual compilation
+\newcommand{\onlyinsubfile}[1]{#1}
+\newcommand{\notinsubfile}[1]{}
+
 \begin{document}
-\pagenumbering{gobble}
 
-%% Override custom cmds for full manual compilation
+\renewcommand{\onlyinsubfile}[1]{}
+\renewcommand{\notinsubfile}[1]{#1}
+
 \renewcommand{\biblio}{}
 \renewcommand{\pindex}{}
@@ -40 +42 @@
 %% ==============================================================================
 
-%% Title and information pages
-\input{../../global/frontpages}
+\pagenumbering{gobble}
 
-%% Engine citation
-\input{../../global/citation}
+%% Title page
+\input{../../global/frontpage}
+
+\maketitle
+\emptythanks
+
+%% Information page (2nd page)
+\input{../../global/info_page}
 
 %% Foreword
-\newpage
 %\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
 \pagenumbering{roman}
-\subfile{../subfiles/foreword}
+\input{foreword}
 
-%% ToC i.e. Table of Contents
-\newpage
-\dominitoc
+%% Table of Contents
 \tableofcontents
+%\listoffigures
+\listoftables
 
 \clearpage
@@ -67 +73 @@
 \pagenumbering{arabic}
 
-\graphicspath{{../../figures/\engine/}}
 \input{chapters}
 
@@ -93 +98 @@
 \clearpage
 \phantomsection
-\addcontentsline{toc}{chapter}{Index}
-\printindex
+\addcontentsline{toc}{chapter}{Indexes}
+\printindex[keys]
+\printindex[modules]
+\printindex[blocks]
+\printindex[parameters]
+\printindex[subroutines]
 
 \end{document}
+