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 12149 for NEMO/branches/2019/ENHANCE-03_closea/doc/latex/global/document.tex – NEMO

Ignore:
Timestamp:
2019-12-10T15:03:24+01:00 (4 years ago)
Author:
ayoung
Message:

Updated trunk to 12072

Location:
NEMO/branches/2019/ENHANCE-03_closea/doc
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • NEMO/branches/2019/ENHANCE-03_closea/doc

    • Property svn:externals set to
      ^/utils/badges badges
      ^/utils/logos logos

  • NEMO/branches/2019/ENHANCE-03_closea/doc/latex

    • Property svn:ignore deleted

  • NEMO/branches/2019/ENHANCE-03_closea/doc/latex/global

    • Property svn:ignore deleted

  • NEMO/branches/2019/ENHANCE-03_closea/doc/latex/global/document.tex

    r11187 r12149  
    11 
    2 %% ============================================================================== 
    3 %% Template structure for reference manual 
    4 %% ============================================================================== 
     2%% ================================================================================================= 
     3%% Template structure for reference manuals 
     4%% ================================================================================================= 
    55 
    66%% NEMO release version 
    7 \def \version{4.0rc~} 
     7\def \version{trunk} 
    88 
    99%% Preamble 
    10 %% ============================================================================== 
     10%% ================================================================================================= 
    1111 
    1212%% Document layout 
    13 \documentclass[draft]{scrreprt} 
     13\documentclass[fontsize = 10pt, twoside, abstract]{scrreprt} 
    1414 
    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  
     15%% Load manual configuration 
     16\input{../../global/prologue} 
    2617 
    2718%% End of common preamble between main and sub-files 
    2819%% Override custom cmds for full manual compilation 
    29 \newcommand{\onlyinsubfile}[1]{#1} 
    30 \newcommand{\notinsubfile}[1]{} 
     20\newcommand{\subinc}[1]{#1} 
     21\newcommand{\subexc}[1]{} 
    3122 
    3223\begin{document} 
    3324 
    34 \renewcommand{\onlyinsubfile}[1]{} 
    35 \renewcommand{\notinsubfile}[1]{#1} 
    36  
    37 \renewcommand{\biblio}{} 
    38 \renewcommand{\pindex}{} 
     25\renewcommand{\subinc}[1]{} 
     26\renewcommand{\subexc}[1]{#1} 
    3927 
    4028 
    4129%% Frontmatter 
    42 %% ============================================================================== 
     30%% ================================================================================================= 
    4331 
    44 \pagenumbering{gobble} 
     32\pagenumbering{gobble}   %% Disable page numbering temporarily 
    4533 
    4634%% Title page 
    4735\input{../../global/frontpage} 
    4836 
    49 \maketitle 
    50 \emptythanks 
     37%% Footer for introductory parts (no header by cleaning default) 
     38\ofoot[]{\engine\ Reference Manual} \ifoot[]{\pagemark} 
    5139 
    5240%% Information page (2nd page) 
    5341\input{../../global/info_page} 
    5442 
    55 %% Foreword 
    56 %\frontmatter   %% Chapter numbering off and Roman numerals for page numbers 
     43\listoffigures 
     44\listoflistings 
     45\listoftables 
     46 
     47\clearpage 
     48 
    5749\pagenumbering{roman} 
    58 \input{foreword} 
     50\ofoot[]{\engine\ Reference Manual} \ifoot[]{\pagemark} 
     51 
     52\input{introduction} 
    5953 
    6054%% Table of Contents 
    6155\tableofcontents 
    62 \listoffigures 
    63 \listoftables 
    6456 
    6557\clearpage 
    66 %\end{document} 
    6758 
    6859 
    6960%% Mainmatter 
    70 %% ============================================================================== 
     61%% ================================================================================================= 
    7162 
    72 %\mainmatter   %% Chapter numbering on, page numbering is reset with Arabic numerals 
     63%% Headings for document body 
    7364\pagenumbering{arabic} 
     65\lohead{Chap.\ \thechapter\ \leftmark} \rehead{Sect.\ \thesection\ \rightmark} 
     66\ifoot[]{Page\ \pagemark\ of \pageref*{LastPage}} 
    7467 
    7568\include{chapters} 
    … …  
    7770 
    7871%% Appendix 
    79 %% ============================================================================== 
     72%% ================================================================================================= 
    8073 
    81 %% Chapter numbering is reset with letters now 
    82 \appendix    
     74\appendix   %% Chapter numbering with letters by now 
     75\lohead{Apdx\ \thechapter\ \leftmark} 
     76\include{appendices} 
    8377 
    84 \include{appendices} 
     78%% Append coding rules for every manual 
     79\input{../../global/coding_rules} 
    8580 
    8681 
    8782%% Backmatter 
    88 %% ============================================================================== 
     83%% ================================================================================================= 
    8984 
    90 %\backmatter   %% Chapter numbering off 
    91  
    92 %% Bibliography 
    93 \phantomsection 
    94 \addcontentsline{toc}{chapter}{Bibliography} 
    95 \bibliography{../main/bibliography} 
    96  
    97 %% Index 
    98 \clearpage 
    99 \phantomsection 
    100 \addcontentsline{toc}{chapter}{Indexes} 
    101 \printindex[keys] 
    102 \printindex[modules] 
    103 \printindex[blocks] 
    104 \printindex[parameters] 
    105 \printindex[subroutines] 
     85%% Bibliography and indexes 
     86\input{../../global/epilogue} 
    10687 
    10788\end{document} 
    108  
Note: See TracChangeset for help on using the changeset viewer.