polytechnique.dtx

% \iffalse meta-comment
%
% For explanation on this file, see http://texdoc.net/texmf-dist/doc/latex/dtxtut/dtxtut.pdf
%
% Copyright (C) 2015 i by Denis Merigoux
%
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.2 of this license or (at your option) any later
% version. The latest version of this license is in:
%
% http://www.latex-project.org/lppl.txt
%
% and version 1.2 or later is part of all distributions of
% LaTeX version 1999/12/01 or later.
%
% \fi
%
% \iffalse
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{polytechnique}
%<package> [2015/04/29 v1.3.0, standard scientific documents layout for Ecole polytechnique (Palaiseau,France).]
%
%<*batchfile>
\begingroup
\input docstrip.tex
\keepsilent
\usedir{tex/latex/polytechnique}

\preamble
This is a generated file.

Copyright (C) 2015 by Denis Merigoux

This file may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.2 of this license or (at your option) any later
version. The latest version of this license is in:

http://www.latex-project.org/lppl.txt

and version 1.2 or later is part of all distributions of
LaTeX version 1999/12/01 or later.
\endpreamble

\askforoverwritefalse
\generate{\file{polytechnique.sty}{\from{polytechnique.dtx}{package}}}

\obeyspaces

\endgroup
%</batchfile>
%%\CharacterTable
%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%% Digits \0\1\2\3\4\5\6\7\8\9
%% Exclamation \! Double quote \" Hash (number) \#
%% Dollar \$ Percent \% Ampersand \&
%% Acute accent \' Left paren \( Right paren \)
%% Asterisk \* Plus \+ Comma \,
%% Minus \- Point \. Solidus \/
%% Colon \: Semicolon \; Less than \<
%% Equals \= Greater than \> Question mark \?
%% Commercial at \@ Left bracket \[ Backslash \\
%% Right bracket \] Circumflex \^ Underscore \_
%% Grave accent \` Left brace \{ Vertical bar \|
%% Right brace \} Tilde \~}
%%
%<*driver>
\documentclass[a4paper,11pt]{ltxdoc}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[french]{babel}
\usepackage[hidelinks]{hyperref}
\usepackage[fancysections,titlepage,sectionmark]{polytechnique}
\makeatletter
\renewcommand{\index@prologue}{\section*{Index}%Redéfinit le texte avant l'index
                %Commande issue de tex/latex/base/doc.sty
                Les nombre en italique se réfèrent à la page où l'entrée correspondante est documentée ; les nombres soulignés se réfèrent à la ligne de code où l'entrée correspondante est définie. Enfin, les autres nombres correspondent aux lignes de code où l'entrée correspondante est utilisée.
                 }
\makeatother
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{polytechnique.dtx}
\end{document}
%</driver>
% \fi
%
%\changes{v1.3.2}{2015/05/27}{Code réorganisé et installation facilitée}
%\changes{v1.3.0}{2015/04/29}{Ajout des options oneside, twoside, sectionmark, chaptermark, markboth, pagenumber}
%\changes{v1.2.2}{2015/02/18}{Recadrage du logo horizontal}
%\changes{v1.2.1}{2015/02/16}{Correction du bug title vide ou author vide}
%\changes{v1.2.0}{2015/01/25}{Dimensionnement des logos conforme à la charte graphique}
%\changes{v1.1.0}{2015/01/20}{Ajout formatage chapter et subsubsection avec l'option fancysections}
%\changes{v1.0.0}{2015/01/15}{Version initiale}
% \GetFileInfo{polytechnique.sty}
%
%\DoNotIndex{\#,\$,\%,\&,\@,\\,\{,\},\^,\_,\~,\ }
%\DoNotIndex{\@ne}
%\DoNotIndex{\advance,\begingroup,\catcode,\closein}
%\DoNotIndex{\closeout,\day,\def,\edef,\else,\empty,\endgroup}
%\DoNotIndex{\newcommand,\renewcommand,\newlength,
%    \setlength,\RequirePackage,\PassOptionsToPackage}
%
%
%\title{Le package \textsf{polytechnique}}
%\subtitle{\fileversion{} datée du \filedate.}
%\author{Denis \textsc{Merigoux}}
%\logo{typographix.pdf}
%
%\maketitle
%
%Le but du package est d'offrir un moyen efficace et rapide aux élèves de mettre en forme leurs documents \LaTeX{} destinés à être rendus à l'administration de l'École ou aux professeurs : rapports de stage, rapports de MODAL, devoirs à la maison, etc. La DIRCOM a établi la maquette en accord avec la charte graphique donc le package peut aussi être utilisé pour produire des documents diffusés à l'extérieur de l'École.
%
%En pratique, package redéfinit les marges et les en-têtes du document, ainsi que la commande |\maketitle| (voir plus bas). La compilation peut être faite avec \texttt{pdflatex} ou \texttt{latex}, les logos et images étant fournies en \texttt{.eps} et \texttt{.pdf}. Attention donc à ne pas utiliser les package \texttt{geometry} ou \texttt{fancyhdr} en parallèle avec ce package.
%
%Le package impose également la police du document par le package \texttt{lmodern}, version vectorielle de la police \emph{Computer Modern Roman} par défaut de \LaTeX.
%
%\renewcommand{\contentsname}{Sommaire}
%\tableofcontents
%\clearpage
%\section{Utilisation}
%
%\subsection{Chargement du package}
%Pour utiliser le package, il suffit d'inclure dans le préambule de son document la ligne :
%\begin{verbatim}
%    \usepackage{polytechnique}
%\end{verbatim}
%On se reportera à la section \ref{options} page \pageref{options} pour l'utilisation des options du package.
%
%\subsection{Métadonnées du document}
%
%La page de titre est gérée entièrement par le package. Pour la définir, il faut signaler dans le préambule les métadonnées du document qui apparaîtront sur la page de titre, avec deux nouveaux champs optionnels |\subtitle| et |\logo| par rapport au \LaTeX{} standard :
%\begin{itemize}
%\item |\subtitle|\marg{sous-titre} où \meta{sous-titre} peut être sur plusieurs lignes séparées par des |\\| ;
%\item |\logo|\marg{chemin} où \meta{chemin} est le chemin relatif vers le fichier d'un logo supplémentaire (entreprise, laboratoire, etc.) ; si le logo est dans le même dossier que le |.tex|, \meta{chemin} est le nom du fichier.
%\end{itemize}
%Il est recommandé de recadrer au mieux l'image du logo pour qu'elle prenne les meilleures dimensions possibles sur la page. Le deuxième logo apparaîtra sur les deux pages de titre différentes (option |titlepage| ou |notitlepage|) dont il modifiera la présentation en conséquence.
%Cela donne dans son préambule :
%\begin{verbatim}
%    \title{Le titre}
%    \subtitle{Le sous-titre (optionnel, enlever cette ligne sinon)}
%    \author{L'auteur Prénom \textsc{Nom}
%         (si plusieurs séparer par des \\)}
%    \date{La date, enlever la ligne pour avoir la date du jour}
%    %\logo{Chemin relatif vers le logo}
%\end{verbatim}

%Puis rajouter après |\begin{document}| la commande |\maketitle|. Les champs |\title|, |\subtitle|, |\author| et |\date| peuvent être sur plusieurs lignes, c'est par exemple utile pour une liste d'auteurs. On passera alors à la ligne avec la commande |\\|.
%
%Si un des champs est trop grand verticalement et nuit à la mise en page globale, on pourra réduire la taille des caractères à l'aide de |\large|, |\Large| ou |\normalsize| par exemple. On pourra aussi utiliser un tableau pour |\author| afin de gagner en place horizontalement :
%\begin{verbatim}
%\author{
%    \begin{tabular}{rlcrl}
%    Coordinateur :&Jean Dupont&---&Tuteur :&Paul Martin
%    \end{tabular}
%    \\[\baselineskip]
%    \begin{tabular}{cccc}
%    Nom1&Nom2&Nom3\\%    Nom4&Nom5&Nom6
%    \end{tabular}
%}
%\end{verbatim}
%
%\clearpage
%\section{Options}
%\label{options}
%
%\subsection{Options globales}
%
%Ces options peuvent être indiquées directement dans la déclaration de la classe du document, suivant la syntaxe habituelle : |\documentclass|\oarg{options globales}\marg{classe du document}. \meta{options globales} est une liste d'options séparées par des virgules, selon la syntaxe habituelle. Par exemple :
%\begin{verbatim}
%    \documenclass[titlepage,11pt,a4paper]{article}
%\end{verbatim}
%
%Voici la liste des options globales qui sont reprises par le package :
%\begin{description}
%\item[oneside]  C'est le comportement par défaut, les en-têtes et les marges seront les mêmes pour toutes les pages.
%\item[twoside]  Rend la marge intérieur plus grande que la marge extérieure et transforme les en-têtes gauche/droite en en-têtes intérieurs/extérieurs.
%\item[notitlepage]  Comportement par défaut pour la classe |article|. |\maketitle| produit son résultat sur un quart de page environ.
%\item[titlepage]  Comportement par défaut pour les classes |report| et |book|. 
%\item[a4paper]  Signifie à \LaTeX{} que le format de la feuille est A4. À inclure systématiquement pour éviter les mauvaises surprises.
%\end{description}
%
%\subsection{Options spécifiques}
%
%Ces options sont à appeler directement avec le package avec la syntaxe :
%\begin{center}
%|\usepackage|\oarg{options}|{polytechnique}|
%\end{center}
%En voici la liste :
%\begin{description}
%\item[fancysections]  Redéfinit les commandes |\chapter|, |\section|, |\subsection| et |\subsubsection| avec un style conforme à la charte graphique de l'École. Donne un aspect moins formel au document.
%\item[pagenumber]  Change la numérotation des pages dans le pied de page. Si l'option est activée, elle deviendra \meta{page en cours}/\meta{nombre total de pages}.
%\item[sectionmark]  Affiche en en-tête intérieur le titre de la section courante plutôt que le titre du document.
%\item[chaptermark]  Idem que l'option précédente avec le titre du chapitre courant. Ne peut être utilisé avec la classe |article|.
%\item[markboth]  Pensé pour les longs documents : affiche le titre de la section courante sur l'en-tête intérieur des pages paires et le titre du chapitre courant sur l'en-tête des pages impaires.
%\end{description}
%