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