Changeset 9388 for branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.sty

Timestamp:

2018-03-08T17:57:24+01:00 (6 years ago)

Author:

nicolasmartin

Message:

Global reorganisation of DOC directory: implementation and configuration of syntax highlighting with 'minted' LaTeX package
New macros have been created to insert different source codes (fortran, xml, c and shell-session) in the document.
Pygments Python package is now required to compile the documentation.

Location:

branches/2017/dev_merge_2017/DOC/tex_main

Files:

• . (added)
• NEMO_manual.sty (copied) (copied from branches/2017/dev_merge_2017/DOC/texfiles/styles/NEMO_manual.sty) (3 diffs)

branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.sty

@@ -1 +1 @@
 %% ==============================================================================
-%% macros.sty: 
+%% NEMO_manual.sty: all customizations (packages, )
 %% ==============================================================================
 
+
+%% LaTeX packages
+%% ==============================================================================
+
+\usepackage{natbib}     % bib
+\usepackage{caption}    % caption
+\usepackage{xcolor}     % color
+\usepackage{silence}    % compilation
+\usepackage{times}      % font
+\usepackage{hyperref}   % hyper
+\usepackage{enumitem}   % list
+\usepackage{minted}     % listing
+\usepackage{amsmath}    % maths
+\usepackage{fancyhdr}   % page
+\usepackage{minitoc}    % toc
+\usepackage{subfiles}   % subdocs
+
+
+%% Extensions in bundle package
+
+\usepackage{amssymb, graphicx, longtable, makeidx, xspace}
+
+
+%% Configuration
+
+\captionsetup{margin=10pt, font={small}, labelsep=colon, labelfont={bf}}
+\graphicspath{{../figures/}}
+\hypersetup{
+   pdftitle={NEMO ocean engine}, pdfauthor={Gurvan Madec, and the NEMO team},
+   colorlinks
+}
+
+
+%% Styles
+%% ==============================================================================
+
+%% Additionnal fonts
+
+\DeclareMathAlphabet{\mathpzc}{OT1}{pzc}{m}{it}
+
+
+%% Page layout
+
+\fancyhf{}
+\fancyhead[LE,RO]{\bfseries\thepage}
+\fancyhead[LO]{\bfseries\hspace{-0em}\rightmark}
+\renewcommand{\sectionmark}[1]{\markright{\thesection.\ #1}}
+\fancyhead[RE]{\bfseries\leftmark}
+\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
+\renewcommand{\headrulewidth}{0.5pt}
+\renewcommand{\footrulewidth}{0pt  }
+\addtolength{\headheight}{2.6pt}
+
+
+%% Catcodes
+
+\makeatletter
+\def\LigneVerticale{\vrule height 5cm depth 2cm\hspace{0.1cm}\relax}
+\def\LignesVerticales{\let\LV\LigneVerticale\LV\LV\LV\LV\LV\LV\LV\LV\LV\LV}
+\def\GrosCarreAvecUnChiffre#1{%
+   \rlap{\vrule height 0.8cm width 1cm depth 0.2cm}%
+   \rlap{\hbox to 1cm{\hss\mbox{\color{white} #1}\hss}}%
+   \vrule height 0pt width 1cm depth 0pt%
+}
+\def\@makechapterhead#1{
+   \hbox{
+      \huge\LignesVerticales
+      \hspace{-0.5cm}
+      \GrosCarreAvecUnChiffre{\thechapter}
+      \hspace{0.2cm}
+      \hbox{#1}
+   }
+   \par\vskip
+1cm
+}
+\def\@makeschapterhead#1{
+   \hbox{
+      \huge\LignesVerticales
+      \hbox{#1}
+   }
+   \par\vskip
+2cm
+}
+\def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else
+  \hbox{}
+  \vspace*{\fill}
+  \vspace{\fill}
+  \thispagestyle{empty}
+  \newpage
+  \if@twocolumn\hbox{}\newpage\fi\fi\fi}
+\def\@seccntformat#1{\protect\makebox[0pt][r]{\csname the#1\endcsname\quad}}
+\makeatother
+
+
+%% Macros (to check)
 
 \def\deg{$^{\circ}$}
@@ -22 +117 @@
 \def\rdt{\Delta t}
 
+
+%% New commands
+
 \newcommand{ \gmcomment}[1]{}
 \newcommand{ \sfcomment}[1]{}
@@ -29 +127 @@
 \newcommand{\NEMO}{\textit{NEMO}\xspace}
 
-\newcommand{    \ifile}[1]{\textit{  #1.nc}\index{Input NetCDF files!#1.nc}}
-\newcommand{       \jp}[1]{\textit{     #1}\index{     Model parameters!#1}}
-\newcommand{       \hf}[1]{\textit{ #1.h90}\index{             h90 file!#1}}
-\newcommand{      \key}[1]{\textbf{key\_#1}\index{        CPP keys!key\_#1}}
-\newcommand{      \mdl}[1]{\textit{ #1.F90}\index{              Modules!#1}}
-\newcommand{      \ngn}[1]{\textit{     #1}\index{  Namelist Group Name!#1}}
-\newcommand{       \np}[1]{\textit{     #1}\index{   Namelist variables!#1}}
-\newcommand{       \pp}[1]{\textit{     #1}\index{     Model parameters!#1}}
-\newcommand{      \rou}[1]{\textit{     #1}\index{             Routines!#1}}
+\newcommand{\ifile}[1]{\textit{  #1.nc}\index{Input NetCDF files!#1.nc}}
+\newcommand{   \jp}[1]{\textit{     #1}\index{     Model parameters!#1}}
+\newcommand{   \hf}[1]{\textit{ #1.h90}\index{             h90 file!#1}}
+\newcommand{  \key}[1]{\textbf{key\_#1}\index{        CPP keys!key\_#1}}
+\newcommand{  \mdl}[1]{\textit{ #1.F90}\index{              Modules!#1}}
+\newcommand{  \ngn}[1]{\textit{     #1}\index{  Namelist Group Name!#1}}
+\newcommand{   \np}[1]{\textit{     #1}\index{   Namelist variables!#1}}
+\newcommand{   \pp}[1]{\textit{     #1}\index{     Model parameters!#1}}
+\newcommand{  \rou}[1]{\textit{     #1}\index{             Routines!#1}}
 
 \newcommand{\grad}{\nabla}