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

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

Review of the overall building of any reference manual
Implementation of a compilation process shared between the 3 manuals: now a global document.tex will be used as the main LaTeX file (a symbolic link will refer to it in each ./engine/main directory).
At the time of the manual building, a few small LaTeX files will be imported on the fly from the corresponding folder ./latex/engine/main.

  • definitions.tex: engine, title, author(s), IPSL publication number and DOI ID
  • thanks.tex: list of collaborators to be thanked for the writing/reviewing
  • chapters.tex: ordered list of chapters (relative path to subfiles)
  • appendices.tex: ordered list of subordinate chapters (relative path to subfiles)
File size: 2.1 KB
RevLine 
[9376]1%% ==============================================================================
[11170]2%% Reference Manual
[9376]3%% ==============================================================================
[707]4
[11170]5%% NEMO release version
6\def\version{X.X~}
[707]7
[9376]8%% Preamble
9%% ==============================================================================
10
[10495]11%% Document layout
[11151]12\documentclass[draft]{scrreport}
[10495]13
14%% Custom style (.sty)
[11151]15\usepackage{../../global/packages}
[707]16
[11170]17%% Engine name and Zenodo DOI
18\input{definitions}
19
[10442]20%% Include references and index for single subfile compilation
[11170]21\newcommand{\biblio}{\bibliography{../main/bibliography}}
[10442]22\newcommand{\pindex}{\printindex}
[10414]23
[10495]24\makeindex
25
26%% End of common preamble between main and sub-files
[9388]27\begin{document}
[11151]28\pagenumbering{gobble}
[9376]29
[10442]30%% Override custom cmds for full manual compilation
31\renewcommand{\biblio}{}
32\renewcommand{\pindex}{}
[9376]33
[10414]34
[9376]35%% Frontmatter
36%% ==============================================================================
37
[11151]38%% Title and information pages
39\input{../../global/frontpages}
[707]40
[11170]41%% Engine citation
42\input{../../global/citation}
[11151]43
[11170]44%% Foreword
[11151]45\newpage
46%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers
47\pagenumbering{roman}
[11170]48\subfile{../subfiles/foreword}
[11151]49
[9376]50%% ToC i.e. Table of Contents
[11151]51\newpage
[11170]52\dominitoc\tableofcontents
[9376]53
[11151]54\clearpage
55%\end{document}
[9376]56
[11170]57
[9376]58%% Mainmatter
59%% ==============================================================================
60
[11151]61%\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals
62\pagenumbering{arabic}
[707]63
[11170]64\graphicspath{{../../figures/\engine/}}
65\input{chapters}
[11007]66
[707]67
[9388]68%% Appendix
[11151]69%% ==============================================================================
[9376]70
[11170]71%% Chapter numbering is reset with letters now
72\appendix   
[11151]73
[11170]74\input{appendices}
[11151]75
[9376]76
77%% Backmatter
78%% ==============================================================================
79
[11151]80%\backmatter   %% Chapter numbering off
[9376]81
[9394]82%% Bibliography
[11170]83\phantomsection\addcontentsline{toc}{chapter}{Bibliography}
84\bibliography{../main/bibliography}
[9394]85
[9376]86%% Index
[11151]87\clearpage
[11170]88\phantomsection\addcontentsline{toc}{chapter}{Index}
[707]89\printindex
90
[781]91\end{document}
Note: See TracBrowser for help on using the repository browser.