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 @ 11524

Last change on this file since 11524 was 11524, checked in by nicolasmartin, 3 years ago

Bugfixes

File size: 2.5 KB
Line 
1
2%% =================================================================================================
3%% Template structure for reference manuals
4%% =================================================================================================
5
6%% NEMO release version
7\def \version{trunk}
8
9%% Preamble
10%% =================================================================================================
11
12%% Document layout
13\documentclass[draft, fontsize = 10pt,
14twoside = semi, abstract = on,
15open = right]{scrreprt}
16
17%% Load configurations
18\input{../../global/preamble}
19
20%% End of common preamble between main and sub-files
21%% Override custom cmds for full manual compilation
22\newcommand{\onlyinsubfile}[1]{#1}
23\newcommand{\notinsubfile}[1]{}
24
25\begin{document}
26
27\renewcommand{\onlyinsubfile}[1]{}
28\renewcommand{\notinsubfile}[1]{#1}
29
30\renewcommand{\biblio}{}
31\renewcommand{\pindex}{}
32
33
34%% Frontmatter
35%% =================================================================================================
36
37\pagenumbering{gobble}   %% Disable page numbering temporarily
38
39%% Title page
40\input{../../global/frontpage}
41
42%% Footer for introductory parts (no header by cleaning default)
43\ofoot[]{\engine\ Reference Manual} \ifoot[]{\pagemark}
44
45%% Information page (2nd page)
46\input{../../global/info_page}
47
48\clearpage
49
50\pagenumbering{roman}
51\input{introduction}
52
53%% Table of Contents
54\tableofcontents
55\listoffigures \listoftables \listoflistings
56
57\clearpage
58
59
60%% Mainmatter
61%% =================================================================================================
62
63%% Headings for document body
64\pagenumbering{arabic}
65\lohead{Chap.\ \thechapter\ \leftmark} \rehead{Sect.\ \thesection\ \rightmark}
66\ifoot[]{Page\ \pagemark\ of \pageref*{LastPage}}
67
68\include{chapters}
69
70
71%% Appendix
72%% =================================================================================================
73
74\appendix   %% Chapter numbering with letters by now
75\include{appendices}
76
77%% Append coding rules for every manual
78\input{../../global/coding_rules}
79
80
81%% Backmatter
82%% =================================================================================================
83
84%% Bibliography
85\phantomsection
86\addcontentsline{toc}{chapter}{Bibliography}
87\lohead{Bibliography} \rehead{Bibliography}
88\bibliography{../main/bibliography}
89
90\clearpage
91
92%% Indexes
93\phantomsection
94\addcontentsline{toc}{chapter}{Indexes}
95\lohead{Indexes} \rehead{Indexes}
96\printindex[keys]
97\printindex[modules]
98\printindex[blocks]
99\printindex[parameters]
100\printindex[subroutines]
101
102\end{document}
Note: See TracBrowser for help on using the repository browser.