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

Last change on this file since 11299 was 11299, checked in by nicolasmartin, 14 months ago

Review of the coding rules chapter: convert it to a shared file for 3 manuals

  • Move annex_D.tex and NEMO_coding_conv.tex to ./latex/global
  • Rename NEMO_coding_conv.tex to coding_rules.tex and redesign it as a chapter and not a standalone document
  • Edit document.tex to include the coding rules by default at the end of the appendix
File size: 2.3 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]{scrreprt}
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\listoflistings
65
66\clearpage
67%\end{document}
68
69
70%% Mainmatter
71%% ==============================================================================
72
73%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
74\pagenumbering{arabic}
75
76\include{chapters}
77
78
79%% Appendix
80%% ==============================================================================
81
82%% Chapter numbering is reset with letters now
83\appendix   
84
85\include{appendices}
86
87%% Append coding rules for every manual
88\input{../../global/coding_rules}
89
90
91%% Backmatter
92%% ==============================================================================
93
94%\backmatter   %% Chapter numbering off
95
96%% Bibliography
97\phantomsection
98\addcontentsline{toc}{chapter}{Bibliography}
99\bibliography{../main/bibliography}
100
101%% Index
102\clearpage
103\phantomsection
104\addcontentsline{toc}{chapter}{Indexes}
105\printindex[keys]
106\printindex[modules]
107\printindex[blocks]
108\printindex[parameters]
109\printindex[subroutines]
110
111\end{document}
112
Note: See TracBrowser for help on using the repository browser.