imta_extra.sty

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% File Name:       imta_extra
%
% Description:     Enables advanced functionalities of the IMT Atlantique
%                  LaTeX Template.
%
% Note:            some functionalities require the Minted Package.
%                  This package further requires:
%                     1. To use the --shell-escape option when compiling 
%                        the document (with PDFLaTeX for instance)
%                     2. To have Pymentize installed (Having Python installed,
%                        you can simply run the command: pip install Pygments)
%
%                  Package options: nouppersectioninlof and nouppersectioninlot
%
% Limitations:     /
%
% Errors:          None known
%
% Dependencies:    imta_core
%                  anyfontsize
%                  mdframed
%                  minted
%
% Author:          A. Foucault - armand.foucault@telecom-bretagne.eu
% Contributors:    B. Porteboeuf - benoit.porteboeuf@telecom-bretagne.eu
%
% University :     IMT Atlantique, Brest (France)
%
% TeX Environment: TeXLive + pdfLaTeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Revision List:
% Version    Author   Date         Changes
% 1.0        BP       31.10.2017   Original imta.sty package split into
%                                  imt_core.sty and imta_extra.sty
% 1.1        BP       02.11.2017   \frontmatter & \mainmatter commands
%                                  introduced - support for uppersection
%                                  display in List of Tables/Figures
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\NeedsTeXFormat{LaTeX2e}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%      P A C K A G E S        %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Document geometry management
\RequirePackage{imta_core}

% Fancy code listings
\RequirePackage{minted}

% Arbitrary font size
\RequirePackage{anyfontsize}

% Fancy frames and boxes
\RequirePackage{mdframed}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%      D E F A U L T      E X P O R T       S E T T I N G S        %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Some export-related booleans are introduced
\makeatletter
    \newif\if@printuppersectioninLOF      \@printuppersectioninLOFtrue
    \newif\if@printuppersectioninLOT      \@printuppersectioninLOTtrue
\makeatother

\makeatletter
    \global\newif\if@uppersectionprintedinLOF  \global\@uppersectionprintedinLOFfalse
    \global\newif\if@uppersectionprintedinLOT  \global\@uppersectionprintedinLOTfalse
    \gdef\imtaUpperSectionTitle\doctitle
    \gdef\imtaUpperSectionNumber{ }
\makeatother



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           O P T I O N S          D E C L A R A T I O N           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\makeatletter
    % Disables the printing of the upper section in the List Of Figures
    \DeclareOption{nouppersectioninlof}{\@printuppersectioninLOFfalse} 
    % Disables the printing of the upper section in the List Of Tables
    \DeclareOption{nouppersectioninlot}{\@printuppersectioninLOTfalse}
\makeatother

\ExecuteOptions{}
\ProcessOptions\relax



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           C O L O R S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Colors related to code formatting
\definecolor{imtaCodeBackground}{RGB}{235, 235, 235}
\definecolor{imtaInlineCodeBackground}{RGB}{230, 230, 230}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           C O M M A N D S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% \imtaInlinecode
% Typeset inline code
% First parameter is the language of the text to typeset
% Second parameter is the text to typeset
\newcommand{\imtaInlinecode}[2]{%
    \setlength{\fboxsep}{2pt}\colorbox{imtaInlineCodeBackground}{\mintinline{#1}{#2}}%
}


% \imtaFrontMatter
% Resets the page counter and switches to roman numbers (useful for the preamble)
\makeatletter
\newif\if@mainmatter \@mainmattertrue

\def\imtaFrontMatter{%
    \@mainmatterfalse \pagenumbering{roman} \setcounter{page}{1}}

% \imtaMainMatter
% Resets the page counter and switches to arabic numbers (useful for the main content)
\def\imtaMainMatter{%
    \@mainmattertrue \pagenumbering{arabic} \setcounter{page}{1}}
\makeatother


% \chapter
% \chapter is redefined when relevant, in order to update the upper section informations
% \makeatletter
% \if@chapterdefined
%     \let\imtaExtraOldChapter\chapter
%     \renewcommand*{\chapter}{\@ifstar{\imtaStarChapter}{\@dblarg\imtaNoStarChapter}}
%     
%     \newcommand*\imtaExtraStarChapter[1]{%
%         \imtaExtraOldChapter*{#1}
%         \gdef\imtaUpperSectionTitle{#1} \gdef\imtaUpperSectionNumber{ } \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
%     
%     \def\imtaExtraNoStarChapter[#1]#2{%
%         \imtaExtraOldChapter[{#1}]{#2}
%         \gdef\imtaUpperSectionTitle{#1}  \gdef\imtaUpperSectionNumber{\thechapter. } \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
% 
% \else
%     \relax
% \fi
% \makeatother


% \section 
% \section is redefined, in order to update the upper section informations
% \makeatletter
%     \if@chapterdefined
%         \relax
%     \else
%         \let\imtaExtraOldSection\section
%         \renewcommand{\section}{\@ifstar{\imtaExtraStarSection}{\@dblarg\imtaExtraNoStarSection}}
%         \newcommand\imtaExtraStarSection[1]{%
%             \imtaExtraOldSection*{#1}  \gdef\imtaUpperSectionTitle{#1} \gdef\imtaUpperSectionNumber{ } \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
%         \def\imtaExtraNoStarSection[#1]#2{%
%             \imtaExtraOldSection[{#1}]{#2} \gdef\imtaUpperSectionTitle{#1} \gdef\imtaUpperSectionNumber{\thesection. } \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
%     \fi
% \makeatother




%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           E N V I R O N M E N T S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% imtaCode
% Format a listing of code
% The only argument of this environment is the language of the code to format
% This environment wraps around minted, and is therefore a verbatim environment
\newenvironment{imtaCode}[1]{%
    \VerbatimEnvironment%
    \renewcommand{\theFancyVerbLine}{\ttfamily \textcolor{gray!150}{\normalsize \oldstylenums{\arabic{FancyVerbLine}}}}%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeBackground, innerleftmargin=5pt]%
    \begin{minted}[linenos, breaklines]{#1}%
}{
    \end{minted}%
    \end{mdframed}%
}


% imtaConsole
% Format a console session
\newenvironment{imtaConsole}{%
    \VerbatimEnvironment%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeBackground, innerleftmargin=5pt]%
    \begin{minted}[breaklines]{text}%
}{
    \end{minted}%
    \end{mdframed}%
}



%\figure
% The figure environment is redefined to update the LOF with the upper section title when relevant
% \makeatletter
%     \def\printuppersectioninlof{%
%         \if@uppersectionprintedinLOF
%             \relax
%         \else
%             \if@printuppersectioninLOF
%                 \addcontentsline{lof}{chapter}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
%             \fi
%         \fi
%         \global\@uppersectionprintedinLOFtrue}
%     
%     \let\oldfigure\figure
%     
%     \def\figure{\@ifnextchar{[}{\figurewarg}{\figurewotarg}}
%     
%     
%     \def\figurewarg[#1]{%        
%         \oldfigure[#1]\printuppersectioninlof}
%     
%     \def\figurewotarg{%
%         \oldfigure\printuppersectioninlof}
% \makeatother


% \table
% The table environment is redefined to update the LOT with the upper section title when relevant
\makeatletter
    \def\printuppersectioninlot{%
        \if@uppersectionprintedinLOT
            \relax
        \else
            \if@printuppersectioninLOT
                \addcontentsline{lot}{chapter}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
            \fi
        \fi
        \global\@uppersectionprintedinLOTtrue}
    
    \let\oldtable\table
    
    \def\table{\@ifnextchar{[}{\tablewarg}{\tablewotarg}}    
    
    \def\tablewarg[#1]{%        
        \oldtable[#1]\printuppersectioninlot}
    
    \def\tablewotarg{%
        \oldtable\printuppersectioninlot}
\makeatother