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

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

Pre-implementation of new cover page and new headings style for reference manuals

Cover page

The layout of the frontpage has been completely redesigned,
a coloured banner has been added to emphasize the title and easily identify each manual
between them.
The chosen color for each document (blue for NEMO, gray for SI3 and green for TOP) will be
used throughout the manual for the links and in the chapter headings.
The list of authors (writers/editors/reviewers) for the version of the manual is given next to
the abstract, which is now included in the frontpage.
A link to an existing ORCID profile for the author precedes its name.
Few settings have been added to each definitions.tex in order to adjust the rendering of the cover page (vertical spaces above and below the title, a subtitle, the width for authors list and
abstract section)

Headings

  • header: chapter number and title for even pages, same infos for section otherwise
  • footer: name of the manual and page numbering with the total number of pages (reverse order between odd/even pages)

For the chapter heading, a new style 'Bjornstrup' from fncychap package is now use.

Abstract

Split the section in two paragraphs for all manuals

  1. Common description with almost the same sentences only customized by the general infos of the model
  2. Specific part for the characteristics of the model

Troubleshooting

As announced, I have introduced some icons from academicons and fontawesome packages.
It required to switch from pdflatex to xelatex for the compilation and it prevents from now
the building of the whole document.
Also the PDF generated does not look nice due to the font

Work in progress...

File size: 2.4 KB
Line 
1
2%% ==============================================================================
3%% Template structure for reference manual
4%% ==============================================================================
5
6%% NEMO release version
7\def \version{trunk}
8
9%% Preamble
10%% ==============================================================================
11
12%% Document layout
13\documentclass[twoside = semi, abstract = on]{scrreprt}
14
15%% Load configurations
16\input{../../global/preamble}
17
18\dominitoc
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%% Disable page numbering temporarily
38\pagenumbering{gobble}
39
40%% Title page
41%\input{../../global/frontpage}
42\input{../../global/frontpage_new}
43
44%\maketitle
45%\emptythanks
46
47%% Information page (2nd page)
48\input{../../global/info_page}
49
50%% Headings for introductory parts (no header, simple footer)
51\ofoot{\engine\ Reference Manual}\ifoot{\pagemark}
52\pagenumbering{roman}
53
54%% Foreword
55%\input{foreword}
56
57%% Table of Contents
58\tableofcontents
59%\listoffigures
60%\listoftables
61%\listoflistings
62
63\clearpage
64
65
66%% Mainmatter
67%% ==============================================================================
68
69%% Headings for document body
70\lohead{Chap.\ \thechapter\ \leftmark}\rehead{Sect.\ \thesection\ \rightmark}
71\ifoot{Page\ \pagemark\ of \pageref*{LastPage}}
72\pagenumbering{arabic}
73
74\include{chapters}
75
76
77%% Appendix
78%% ==============================================================================
79
80%% Chapter numbering is reset with letters now
81\appendix
82
83\include{appendices}
84
85%% Append coding rules for every manual
86\input{../../global/coding_rules}
87
88
89%% Backmatter
90%% ==============================================================================
91
92%\backmatter   %% Chapter numbering off
93
94%% Bibliography
95\phantomsection
96\addcontentsline{toc}{chapter}{Bibliography}
97\bibliography{../main/bibliography}
98
99%% Index
100\clearpage
101\phantomsection
102\addcontentsline{toc}{chapter}{Indexes}
103\printindex[keys]
104\printindex[modules]
105\printindex[blocks]
106\printindex[parameters]
107\printindex[subroutines]
108
109\end{document}
Note: See TracBrowser for help on using the repository browser.