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

Last change on this file since 11563 was 11563, checked in by nicolasmartin, 5 years ago

Miscellaneous changes

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