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.
Changeset 11433 for NEMO/trunk/doc/latex/global/document.tex – NEMO

Ignore:
Timestamp:
2019-08-12T21:44:18+02:00 (5 years ago)
Author:
nicolasmartin
Message:

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:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/global/document.tex

    r11299 r11433  
    55 
    66%% NEMO release version 
    7 \def \version{4.0rc~} 
     7\def \version{trunk} 
    88 
    99%% Preamble 
     
    1111 
    1212%% Document layout 
    13 \documentclass[draft]{scrreprt} 
     13\documentclass[twoside = semi, abstract = on]{scrreprt} 
    1414 
    15 %% Load the configuration of the manual 
    16 \input{../main/definitions} 
    17  
    18 %% Load global *.tex files 
     15%% Load configurations 
    1916\input{../../global/preamble} 
    2017 
    2118\dominitoc 
    22  
    23 %% Launch the creation of the indexes 
    24 \input{../../global/indexes} 
    25  
    2619 
    2720%% End of common preamble between main and sub-files 
     
    4235%% ============================================================================== 
    4336 
     37%% Disable page numbering temporarily 
    4438\pagenumbering{gobble} 
    4539 
    4640%% Title page 
    47 \input{../../global/frontpage} 
     41%\input{../../global/frontpage} 
     42\input{../../global/frontpage_new} 
    4843 
    49 \maketitle 
    50 \emptythanks 
     44%\maketitle 
     45%\emptythanks 
    5146 
    5247%% Information page (2nd page) 
    5348\input{../../global/info_page} 
    5449 
     50%% Headings for introductory parts (no header, simple footer) 
     51\ofoot{\engine\ Reference Manual}\ifoot{\pagemark} 
     52\pagenumbering{roman} 
     53 
    5554%% Foreword 
    56 %\frontmatter   %% Chapter numbering off and Roman numerals for page numbers 
    57 \pagenumbering{roman} 
    58 \input{foreword} 
     55%\input{foreword} 
    5956 
    6057%% Table of Contents 
    6158\tableofcontents 
    62 \listoffigures 
    63 \listoftables 
    64 \listoflistings 
     59%\listoffigures 
     60%\listoftables 
     61%\listoflistings 
    6562 
    6663\clearpage 
    67 %\end{document} 
    6864 
    6965 
     
    7167%% ============================================================================== 
    7268 
    73 %\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals 
     69%% Headings for document body 
     70\lohead{Chap.\ \thechapter\ \leftmark}\rehead{Sect.\ \thesection\ \rightmark} 
     71\ifoot{Page\ \pagemark\ of \pageref*{LastPage}} 
    7472\pagenumbering{arabic} 
    7573 
     
    8179 
    8280%% Chapter numbering is reset with letters now 
    83 \appendix    
     81\appendix 
    8482 
    8583\include{appendices} 
     
    110108 
    111109\end{document} 
    112  
Note: See TracChangeset for help on using the changeset viewer.