New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
document.tex in NEMO/trunk/doc/latex/global – NEMO

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

Last change on this file since 11176 was 11176, checked in by nicolasmartin, 5 years 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: 2.2 KB
Line 
1
2%% ==============================================================================
3%% Template structure for reference manual
4%% ==============================================================================
5
6%% NEMO release version
7\def \version{4.0rc~}
8
9%% Preamble
10%% ==============================================================================
11
12%% Document layout
13\documentclass[draft]{scrreport}
14
15%% Load the configuration of the manual
16\input{../main/definitions}
17
18%% Load global *.tex files
19\input{../../global/preamble}
20
21\dominitoc
22
23%% Launch the creation of the indexes
24\input{../../global/indexes}
25
26
27%% End of common preamble between main and sub-files
28%% Override custom cmds for full manual compilation
29\newcommand{\onlyinsubfile}[1]{#1}
30\newcommand{\notinsubfile}[1]{}
31
32\begin{document}
33
34\renewcommand{\onlyinsubfile}[1]{}
35\renewcommand{\notinsubfile}[1]{#1}
36
37\renewcommand{\biblio}{}
38\renewcommand{\pindex}{}
39
40
41%% Frontmatter
42%% ==============================================================================
43
44\pagenumbering{gobble}
45
46%% Title page
47\input{../../global/frontpage}
48
49\maketitle
50\emptythanks
51
52%% Information page (2nd page)
53\input{../../global/info_page}
54
55%% Foreword
56%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
57\pagenumbering{roman}
58\input{foreword}
59
60%% Table of Contents
61\tableofcontents
62%\listoffigures
63\listoftables
64
65\clearpage
66%\end{document}
67
68
69%% Mainmatter
70%% ==============================================================================
71
72%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
73\pagenumbering{arabic}
74
75\input{chapters}
76
77
78%% Appendix
79%% ==============================================================================
80
81%% Chapter numbering is reset with letters now
82\appendix   
83
84\input{appendices}
85
86
87%% Backmatter
88%% ==============================================================================
89
90%\backmatter   %% Chapter numbering off
91
92%% Bibliography
93\phantomsection
94\addcontentsline{toc}{chapter}{Bibliography}
95\bibliography{../main/bibliography}
96
97%% Index
98\clearpage
99\phantomsection
100\addcontentsline{toc}{chapter}{Indexes}
101\printindex[keys]
102\printindex[modules]
103\printindex[blocks]
104\printindex[parameters]
105\printindex[subroutines]
106
107\end{document}
108
Note: See TracBrowser for help on using the repository browser.