Changeset 14257 for NEMO/trunk/doc/latex/global/styles.tex

Timestamp:

2021-01-04T16:13:36+01:00 (3 years ago)

Author:

nicolasmartin

Message:

Overall review of LaTeX sources (not tested completely as of now):

• Reworking global files: main document.tex, add glossary.tex, cosmetic changes...
• Ignore missing namelists (namsbc_isf, namsbc_iscpl and namptr)
• Removal of references for unused indices (\hfile, \ifile and \jp)
• Update of .svnignore and svn:ignore properties accordingly
• Split of manual abstract into a common NEMO abs for all and a specific one for each engine
• Shrinking variables names used in the frontmatter

Location:

NEMO/trunk/doc/latex/global

Files:

• . (modified) (1 prop)
• styles.tex (modified) (2 diffs)

NEMO/trunk/doc/latex/global/styles.tex

@@ -1 @@
-
+%% =================================================================================================
 %% Styles
-%% ==============================================================================
+%% =================================================================================================
 
 %% Colors
-\setmanualcolor
-\colorlet{manualcolorshaded}{manualcolor!60}
-\definecolor{orcidcolor}{HTML}{A6CE39}
+\definecolor{orcidclr}{HTML}{A6CE39}
+\definecolor{manclr}{cmyk}{\clr} %% \clr defined for each manual from local settings.tex
+\colorlet{manclrshd}{manclr!60} %% Derived color for chapter heading, see below
+
+%% Cover page
+\backgroundsetup{
+   firstpage=true,scale  =1,
+   angle    =0   ,opacity=1,
+   contents ={
+      \begin{tikzpicture}[remember picture,overlay]
+         \path[fill=manclr] (-0.5\paperwidth,7) rectangle (0.5\paperwidth,10);
+      \end{tikzpicture}
+    }
+}
 
 %% Page layout
-\pagestyle{scrheadings}
+%\pagestyle{scrheadings}
+%\renewcommand{\chapterpagestyle}{empty}
+\renewcommand{\chaptermark}[1]{ \markboth{#1}{}} %% Convert mark to lowercase
+\renewcommand{\sectionmark}[1]{\markright{#1}{}} %%    "     ""  ""     "  
+\ohead{} %% Clear default headings
+\lohead{Chap. \thechapter\  \leftmark}
+\rehead{Sect. \thesection\ \rightmark}
+\ifoot{Page \thepage\ of \pageref*{LastPage}}
+%\ifoot[\pagemark]{Page \thepage\ of \lastpageref*{pagesLTS.arabic}}
+\ofoot{\eng\ Reference Manual}
 \addtokomafont{pagehead}{  \sffamily              }
 \addtokomafont{pagefoot}{  \sffamily \footnotesize}
 \addtokomafont{pagenumber}{\sffamily \slshape     }
-\addtokomafont{chapter}{\color{white}}
-\ohead{} \ofoot{}   %% Clear defaults
+%\addtokomafont{chapter}{\color{white}}
 
-%% Caption
-\captionsetup{font = footnotesize, justification = justified}
+%% Cross-referencing
+\hypersetup{
+   pdftitle=\hdg                                          ,
+   pdfauthor=Gurvan Madec and NEMO System Team            ,
+   pdfsubject=Reference manual of NEMO modelling framework,
+   pdfkeywords=ocean circulation modelling                ,
+   colorlinks                                             ,
+   allcolors=manclr
+}
+\renewcommand{\appendixautorefname}{appendix}          %% `\autoref` uncapitalization
+\renewcommand{\equationautorefname}{equation}          %%     ""            ""
+\renewcommand{\figureautorefname  }{figure}            %%     ""            ""
+\renewcommand{\listingname        }{namelist}          %%     ""            ""
+\renewcommand{\listlistingname    }{List of Namelists} %%     ""            ""
+\renewcommand{\tableautorefname   }{table}             %%     ""            ""
 
-%% Footnote
+%% Misc. (caption and footnote)
+\captionsetup{font=footnotesize,justification=justified}
 \renewcommand{\thefootnote}{\fnsymbol{footnote}}
 
@@ -28 +61 @@
 \renewcommand{\bibpostamble}{  \end{multicols}   }
 
-%% Catcodes
+%% Catcodes (between `\makeatletter` and `\makeatother`)
 \makeatletter
 
-%% Prevent error with tikz and namelist inclusion
-\global\let\tikz@ensure@dollar@catcode=\relax
+%\global\let\tikz@ensure@dollar@catcode=\relax %% Prevent error with tikz and namelist inclusion
 
-%% First page
-\backgroundsetup{
-  firstpage = true,
-  scale = 1, angle = 0, opacity = 1,
-  contents = {
-    \begin{tikzpicture}[remember picture, overlay]
-      \path [fill = manualcolor] (-0.5\paperwidth, 7) rectangle (0.5\paperwidth, 10);
-    \end{tikzpicture}
-  }
+%% Apply manual color for chap. headings (original snippets from fncychap.sty)
+%% !!! Let trailing percent sign to avoid space insertion
+\renewcommand{\DOCH}{% %% Upper box with chapter number
+   \settowidth{\py}{\CNoV\thechapter}%
+   \addtolength{\py}{-10pt}% %% Amount of space by which the number is shifted right
+   \fboxsep=0pt%
+   \colorbox{manclr}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}%
+   \kern-\py\raise20pt%
+   \hbox{\color{manclrshd}\CNoV\thechapter}\\
+}
+\renewcommand{\DOTI}[1]{% %% Lower box with chapter title
+   \nointerlineskip\raggedright%
+   \fboxsep=\myhi%
+   \vskip-1ex%
+   \colorbox{manclr}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak%
+   \vskip 40\p@%
+}
+\renewcommand{\DOTIS}[1]{% %% Box for unumbered chapter
+   \fboxsep=0pt%
+   \colorbox{manclr}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\
+   \nointerlineskip\raggedright%
+   \fboxsep=\myhi%
+   \vskip-1ex% %% Remove white 1pt line
+   \colorbox{manclr}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak%
+   \vskip 40\p@%
 }
 
-%% Apply engine color for chapter headings: tweaking snippets from fncychap.sty
-\renewcommand{\DOCH}{%
-  \settowidth{\py}{\CNoV\thechapter}
-  \addtolength{\py}{-10pt}      % Amount of space by which the
-%                                  % number is shifted right
-  \fboxsep=0pt%
-  \colorbox{manualcolor}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}%
-  \kern-\py\raise20pt%
-  \hbox{\color{manualcolorshaded}\CNoV\thechapter}\\%
-}
-\renewcommand{\DOTI}[1]{%
-  \nointerlineskip\raggedright%
-  \fboxsep=\myhi%
-  \vskip-1ex%
-  \colorbox{manualcolor}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak%
-  \vskip 40\p@%
-}
-\renewcommand{\DOTIS}[1]{%
-  \fboxsep=0pt
-  \colorbox{manualcolor}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\%
-  \nointerlineskip\raggedright%
-  \fboxsep=\myhi%
-  \vskip-1ex% Remove white 1pt line
-  \colorbox{manualcolor}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak%
-  \vskip 40\p@%
-}
-
-%% Temporary fix
-\def\set@curr@file#1{%
-  \begingroup
-    \escapechar\m@ne
-    \xdef\@curr@file{\expandafter\string\csname #1\endcsname}%
-  \endgroup
-}
-\def\quote@name#1{"\quote@@name#1\@gobble""}
-\def\quote@@name#1"{#1\quote@@name}
-\def\unquote@name#1{\quote@@name#1\@gobble"}
+%% Temporary fix?
+%\def\set@curr@file#1{
+%  \begingroup
+%    \escapechar\m@ne
+%    \xdef\@curr@file{\expandafter\string\csname #1\endcsname}
+%  \endgroup
+%}
+%\def\quote@name#1{"\quote@@name#1\@gobble""}
+%\def\quote@@name#1"{#1\quote@@name}
+%\def\unquote@name#1{\quote@@name#1\@gobble"}
 
 \makeatother