.gitattributes

-guide/installation.pdf filter=lfs diff=lfs merge=lfs -text

.gitignore

 *.aux
-*.fdb_latexmk
-*.fls
-*.log
-*.out
-*.synctex.gz
-source/polytechnique.pdf
-guide/installation.pdf
-*.zip
 *.glo
+*.hd
 *.idx
+*.log
+*.out
+*.out
 *.toc
-*.dvi
-*.ind
-*.ilg
+*.fdb_latexmk
+*.fls

.gitlab-ci.yml

+#global variables
+variables:
+  IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
+
+stages:
+  - ship
+  - test
+
+test:
+  stage: test
+  image: $IMAGE_TAG
+  script:
+    - cd source
+    - latex polytechnique.ins
+    - latexmk -pdf polytechnique.dtx
+    - cp * ../guide/
+    - cd ../guide
+    - latexmk -pdf installation.tex
+  artifacts:
+    paths:
+      - "source/polytechnique.sty"
+      - "source/polytechnique.pdf"
+      - "guide/installation.pdf"
+
+
+ship:docker:
+  stage: ship
+  image: docker:stable
+  services:
+    - docker:dind
+  cache: {}
+  variables:
+    DOCKER_HOST: tcp://docker:2375/
+    DOCKER_DRIVER: overlay2
+    # For disabling TLS in docker-in-docker (not needed)
+    DOCKER_TLS_CERTDIR: ''
+  script:
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker build --pull -t $IMAGE_TAG .
+    - docker push $IMAGE_TAG
+

CONTRIBUTORS

+2022 Copyright Thomas Fourier
+2022 Copyright Antoine Bak
+2020 Copyright Alexis Roger
+2019-2020 Copyright Sosthène Guédon
+2020 Copyright Louis Cousturian
+2019 Copyright Olivér Facklam
+2019 Copyright Hadrien Renaud
+2019 Copyright Mael Madon
+2016-2019 Copyright Clément Durand
+2018 Copyright Wilson Jallet 
+2018 Copyright Guangshuo Chen
+2015-2016 Copyright Denis Merigoux

Dockerfile

+FROM debian:latest
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -q \
+    && apt-get install -qy build-essential wget libfontconfig1 rsync \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install TexLive with scheme-basic
+RUN wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz; \
+    mkdir /install-tl-unx; \
+    tar -xvf install-tl-unx.tar.gz -C /install-tl-unx --strip-components=1; \
+    echo "selected_scheme scheme-basic" >> /install-tl-unx/texlive.profile; \
+    /install-tl-unx/install-tl -profile /install-tl-unx/texlive.profile; \
+    rm -r /install-tl-unx; \
+    rm install-tl-unx.tar.gz
+
+ENV PATH="/usr/local/texlive/2024/bin/x86_64-linux:${PATH}"
+RUN . /etc/profile
+
+WORKDIR /data
+
+# Install latex packages
+RUN tlmgr install latexmk babel-french csquotes xcolor titlesec lastpage hypdoc
+
+VOLUME ["/data"]
+COPY source ./source
+COPY install ./install
+RUN cd install; ./unix.sh
+

LICENSE.txt

@@ -2,10 +2,10 @@ 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 1.3c 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
+and version 1.3c or later is part of all distributions of
 LaTeX version 1999/12/01 or later.

Makefile

-.PHONY:all %.all install %.install clean %.clean cleandist %.cleandist release
-
-SUBMAKE:=make -s -C
-SUBMAKABLE:=$(shell find . -mindepth 2 -name '[Mm]akefile' | sed 's%^./%%;s%/[^/]*%%')
-define submake
-	@tput setaf 3
-	@echo make[$1] $2
-	@tput sgr0
-	@$3 $(SUBMAKE) $1 $2
-endef
-
-all: $(patsubst %,%.all,$(SUBMAKABLE))
-
-%.all:
-	$(call submake,$*,,)
-
-install: $(patsubst %,%.install,$(SUBMAKABLE))
-
-%.install:
-	$(call submake,$*,install,sudo)
-
-clean: $(patsubst %,%.clean,$(SUBMAKABLE))
-
-%.clean:
-	$(call submake,$*,clean,)
-
-cleandist: $(patsubst %,%.cleandist,$(SUBMAKABLE))
-
-%.cleandist:
-	$(call submake,$*,cleandist,)
-
-release:
-	$(call submake,.,,)
-	$(call submake,.,clean,)

README.md

 # polytechnique-LaTeX
-Code du package LaTeX de l'École polytechnique.
 
-Pour l'installation de LaTeX et du package, se reporter au fichier `guide/installation.pdf`.
+Code du package LaTeX de l'École polytechnique.
 
-Il est aussi simple d'installer le package sous linux depuis le dépôt avec le `Makefile`, après l'avoir téléchargé (avec `git clone` ou en téléchargeant un `.zip` ou `.tar.gz`) :
-
-```bash
-cd polytechnique
-make && make install
-```
+Pour l'installation de LaTeX et du paquet, tout est détaillé dans guide/installation.pdf. Télécharge le repository, et lis ce guide pour tout comprendre de l'installation.
 
 ## Test
 
@@ -18,3 +12,7 @@ Vous pouvez essayer le code sur l'exemple du guide :
 cd guide/
 pdflatex installation.tex
 ```
+
+## Pour Overleaf
+
+Rends toi sur [le site typographix](https://typographix.binets.fr/help/?hl=fr) pour télécharger le patron, et l'utiliser avec overleaf.

guide/installation.tex

@@ -5,12 +5,12 @@
 \usepackage[french]{babel}
 \usepackage{url,csquotes}
 \usepackage[hidelinks,hyperfootnotes=false]{hyperref}
-\usepackage[titlepage,fancysections,pagenumber]{polytechnique}
+\usepackage[titlepage,fancysections,pagenumber, oneside]{polytechnique}
 
 
 \title{De la mise en page à l'École}
-\subtitle{Petit guide à l'installation de \textrm{\LaTeX}\\et du package \textup{\texttt{polytechnique v1.3.6}}}
-\author{Denis \textsc{Merigoux}}
+\subtitle{Petit guide à l'installation de \textrm{\LaTeX}\\et du package \textup{\texttt{polytechnique v1.3.9}}}
+\author{Denis \textsc{Merigoux}, Sosthène \textsc{Guédon}, \textsc{Oliver Facklam}}
 \logo{logo.pdf}
 
 \begin{document}
@@ -34,8 +34,9 @@ Ce document a pour objet de documenter l'utilisation de ce package mais avant to
 \begin{enumerate}
 	\item Télécharge la dernière version de MiKTeX sur \url{http://miktex.org/download}.
 	\item Lance l'installation. \textbf{Attention !} Lorsqu'un menu déroulant te propose de choisir pour \emph{Install missing packages on-the-fly}, clique sur \emph{Yes} et non pas \emph{Ask me first} comme sélectionné par défaut.
-	\item Une fois l'installation terminée, cherche dans \enquote{Tous les programmes} l'utilitaire \emph{Update (Admin)}, puis lance-le. Quand la liste apparaît, coche tout et lance la mise à jour des packages.
-	\item Lance l'utilitaire \emph{Settings (Admin)} puis clique tour à tour sur les boutons \emph{Refresh FNDB} et \emph{Update formats}. Il faudra répéter cette dernière opération à chaque fois que vous installerez de nouveaux packages.
+	\item Une fois l'installation terminée, lance le programme \emph{MiKTeX Console}. Choisis \emph{Switch to MiKTeX administrator mode}
+	\item Va dans l'onglet \emph{Updates} puis clique sur le bouton \emph{Check for updates}. Quand la liste apparaît, lance la mise à jour des packages avec \emph{Update now}.
+	\item Ouvre le menu déroulant \emph{Tasks} puis clique sur \emph{Refresh File Name Database}. Il faudra répéter cette dernière opération à chaque fois que vous installerez de nouveaux packages.
 \end{enumerate}
 
 Il faut ensuite installer un éditeur de code source, par exemple TeXmaker qui est disponible sur toutes les plate-formes.
@@ -48,7 +49,9 @@ Il faut ensuite installer un éditeur de code source, par exemple TeXmaker qui e
 
 \subsection{GNU/Linux}
 
-Le paquet à installer est \texttt{texlive-full} ou \texttt{texlive}. Tu auras peut-être aussi besoin d'installer d'autres paquets pour manipuler les fichiers produits par LaTex mais comme tu es sous Linux, on va supposer que tu sais chercher de l'aide en ligne. Il existe d'excellents éditeurs LaTeX sous GNU/Linux, par exemple Kile (pour KDE), TeXmaker ...
+Tu as deux possibilités, tu peux installer ta distribution \texttt{texlive} depuis un gestionnaire de paquets (la plupart le proposent, en particulier \texttt{apt}). Cependant, ils ont souvent plusieurs versions de retard, ce qui peut poser des problèmes sur l'installation de paquets supplémentaires. C'est pourquoi nous conseillons plutôt de l'installer via le script d'installation disponible ici : \url{https://www.tug.org/texlive/quickinstall.html}. Tu auras besoin d'installer \texttt{perl}, qui est présent sur tous les gestionnaires de paquets. Tu peux ensuite installer \texttt{texlive} en suivant le guide. Nous conseillons d'utiliser l'interface graphique en remplaçant à l'étape 5 du guide \texttt{--no-interaction} par \texttt{--gui}, ou si tu est un méga-chad, tu peux le faire tourner sans argument (ce n'est vraiment pas pratique).
+
+Il existe d'excellents éditeurs \LaTeX sous GNU/Linux, par exemple Kile (pour KDE), TeXmaker… Il existe même des extensions pour VSCod.e.ium, ou Atom. Si tu veux te lançer un challenge, \texttt{vim} fonctionne aussi. Pour information, j'édite ces quelques mots sur TeXstudio.
 
 \section{Installation du package}
 
@@ -70,42 +73,36 @@ Sélectionne le ou les packages à installer dans la liste (tu peux rechercher l
 
 \paragraph{Mac} Pour mettre à jour ou installer des packages, il faut utiliser l'application \emph{Tex Live utility}, dont un tutoriel en français très bien fourni est disponible à l'adresse suivante : \url{http://www.cuk.ch/articles/4466}. Voici des instructions succintes : dans le dossier \emph{Applications/TeX}, lancer l'utilitaire \emph{TeX Live Utility}. Dans l'onglet \emph{Manage Packages}, sélectionner le package à installer et cliquer sur le bouton \emph{Install}.
 
-\paragraph{Linux} Dans un terminal, exécuter la commande 
+\paragraph{Linux} Dans un terminal, exécuter la commande  : 
 \begin{verbatim}
 tlmgr install <nom du package>
 \end{verbatim}
 
+Cette commande peut fonctionner, si les dieux du \LaTeX le veulent bien, et c'est rarement le cas si tu as installé texlive par ton gestionnaire de paquets. Pour ne pas avoir de problème, l'installation par le script d'installation fonctionne souvent. La version texlive-full contient tous les paquets, tu n'auras besoin d'installer aucune dépendance supplémentaire.
+
 
 \subsection{Installation du package \texttt{polytechnique}}
 
 \subsubsection{Méthode automatique}
 
-\textbf{Avertissement.} Les instructions de la méthode automatique sont pour la plupart anciennes. Se référer au fichier \texttt{README.md} pour Unix, et à la méthode manuelle pour Windows.
+\paragraph{Avertissement :} Les scripts maison que nous avons écrit ne fonctionnent pas toujours. En particulier, ils n'ont pas été beaucoup testés sur \texttt{windows}.
 
-Extraire le dossier \texttt{polytechnique-LaTeX} à la racine de l'archive quelque part sur son ordinateur. Entrer dans le dossier et effectuer l'action suivante :
+Extraire le dossier \texttt{polytechnique-LaTeX} à la racine de l'archive quelque part sur ton ordinateur. Entrer dans le dossier et effectuer l'action suivante :
 \begin{description}
-\item[Windows] double-cliquer sur \texttt{makefile\_windows.bat} ;
-\item[Linux ou Mac] ouvrir un terminal dans le dossier et y entrer la commande
+\item[Windows] va dans le dossier install et clique droit sur \texttt{windows.bat} pour exécuter le script en tant qu'administrateur. 
+\item[Linux ou Mac] Tu auras besoin d'installer \texttt{rsync}. Ouvres un terminal dans le dossier et y entre la commande
 \begin{verbatim}
-make && make install
+install/unix.sh
 \end{verbatim}
 \end{description}
 Après exécution du script, le message affiché sur la console devrait être :
 \begin{verbatim}
-************************************************
-* Le package a ete installe ! La documentation *
-* se trouve a l'emplacement suivant :          *
-<chemin qui dépend de votre ordinateur>
-* Les fichiers sources et resources a          *
-* l'endroit suivant :                          *
-<chemin qui dépend de votre ordinateur>
-* Et le .sty a l'endroit suivant :             *
-<chemin qui dépend de votre ordinateur>
-* Bonne utilisation !                          *
-************************************************
+> Installing source files...
+> Updating database...
+DONE !
 \end{verbatim}
 
-Si ce message ne s'affiche pas ou si l'installation semble ne pas fonctionner quand vous essayez d'utiliser le package, se reporter à la méthode manuelle.
+Si ce message ne s'affiche pas ou si l'installation semble ne pas fonctionner quand tu essayes d'utiliser le package, se reporte-toi à la méthode manuelle.
 \subsubsection{Méthode manuelle}
 
 Il faut chercher où se trouve le répertoire de ton installation LaTeX. Pour cela (et quelque soit ton système d'exploitation), ouvre une ligne de commandes et tape :
@@ -114,7 +111,7 @@ kpsewhich -var-value TEXMFMAIN
 \end{verbatim}
 Rends-toi alors dans le répertoire indiqué que l'on nommera par la suite \emph{INSTALL}. Dans une autre fenêtre de ton explorateur de fichiers, extrais l'archive téléchargée et ouvre le dossier \emph{source}. Il suffit ensuite de copier tous les fichiers \texttt{.pdf}, \texttt{.eps} et \texttt{polytechnique.sty} vers le dossier \emph{INSTALL/tex/latex/polytechnique}. 
 
-Il te faut enfin mettre à jour la la liste de package de ta distribution. Pour Linux, ouvre un terminal et entre \texttt{sudo texhash}. Pour Mac, ouvre un terminal et entre \texttt{sudo mktexlsr}. Pour Windows, ouvre dans tous les programmes l'utilitaire \emph{Settings (Admin)} et clique sur \emph{Refresh FNDB}.
+Il te faut enfin mettre à jour la la liste de package de ta distribution. Pour Linux, ouvre un terminal et entre \texttt{sudo texhash}. Pour Mac, ouvre un terminal et entre \texttt{sudo mktexlsr}. Pour Windows, lance  \emph{MiKTeX Console} et clique sur \emph{Tasks > Refresh file name database}.
 
 De cette manière, l'installation n'est pas complète mais le package marchera très bien en utilisation. Il te manquera par contre les fichiers source commentés si tu veux le modifier.
 
@@ -122,4 +119,8 @@ De cette manière, l'installation n'est pas complète mais le package marchera t
 
 La documentation du package est le fichier \texttt{polytechnique.pdf} qui se trouve entre autres dans le dossier \emph{source} de l'archive extraite.
 
+\section{Utilisation sans installation (overleaf par exemple)}
+Tu peux utiliser le package sans l'installer, pour cela, rien de plus simple, rends toi sur \href{https://typographix.binets.fr/help/}{le site de typographix}, télécharge le patron, extrais le .zip, dans le dossier, tu peux modifier, puis compiler le \texttt{main.tex}.
+
+
 \end{document}

install/.exclude

+polytechnique.dtx
+polytechnique.ins
\ No newline at end of file

install/unix.sh

+#!/bin/bash
+#cd "$(readlink -m "$0/../../")" # chdir to the root directory of the package archive
+
+if pdflatex --version &>> /dev/null ; then
+	echo "begening installation"
+else
+	echo -e "\033[0;31m ERROR"
+	echo "Make sure that your texlive installation is complete and working"
+	exit 1
+fi
+
+cd $(dirname $0)
+cd ..
+
+TEXMFLOCALS="$(kpsewhich -var-value TEXMFLOCAL)"
+IFS=':' TEXMFLOCALTOKENS=( $TEXMFLOCALS )
+TEXMFLOCAL="${TEXMFLOCALTOKENS[0]}" #Sometimes TEXMFLOCAL is the concatenation of multiple paths, we choose the first
+PACKAGE="$TEXMFLOCAL/tex/latex/polytechnique/"
+PERMS="Dg+s,ug+w,o-w,+X,+r"
+mkdir -p "$PACKAGE"
+printf "%s> Installing source files...%s\n" "$(tput setaf 2)" "$(tput sgr0)"
+rsync --recursive --exclude-from=install/.exclude --delete-excluded --chmod=$PERMS source/ $PACKAGE/
+printf "%s> Updating database...%s\n" "$(tput setaf 2)" "$(tput sgr0)"
+{ texhash || mktexlsr; } >/dev/null
+printf "%sDONE !%s\n" "$(tput setaf 2)" "$(tput sgr0)"

install/windows.bat

+@ECHO OFF
+CD ..
+FOR /F %%i IN ('kpsewhich -var-value TEXMFLOCAL') DO SET TEXMFLOCAL=%%i
+SET PACKAGEFOLDER=%TEXMFLOCAL%/tex/latex/beamerx
+SET FONTSFOLDER=%TEXMFLOCAL%/fonts
+XCOPY "source" "%PACKAGEFOLDER%" /S /I /R /Y
+texhash
+PAUSE

makearchive_windows.bat

-@echo off
-7z a -tzip polytechnique-LaTeX.zip makefile_windows.bat makefile_unix.sh README.md source/*.pdf source/*.eps source/polytechnique.sty source/polytechnique.dtx guide/installation.pdf guide/installation.tex guide/logo.pdf
-pause
\ No newline at end of file

makefile_windows.bat

-@echo off
-cd source
-pdflatex polytechnique.dtx
-makeindex -s gind.ist -o polytechnique.ind polytechnique.idx
-pdflatex polytechnique.dtx
-del *.aux
-del *.glo
-del *.idx
-del *.ilg
-del *.ind
-del *.log
-del *.toc
-del *.out
-kpsewhich -var-value TEXMFLOCAL > temp.txt
-set /p installdir=<temp.txt
-del temp.txt
-md "%installdir%/tex/latex/polytechnique"
-md "%installdir%/tex/latex/polytechnique/resources
-md "%installdir%/source/latex/polytechnique"
-md "%installdir%/source/latex/polytechnique/resources"
-md "%installdir%/doc/latex/polytechnique"
-copy polytechnique.dtx "%installdir%/source/latex/polytechnique"
-copy polytechnique.sty "%installdir%/tex/latex/polytechnique"
-copy polytechnique.pdf "%installdir%/doc/latex/polytechnique"
-copy *.eps "%installdir%/source/latex/polytechnique/resources"
-copy *.pdf "%installdir%/source/latex/polytechnique/resources"
-copy *.eps "%installdir%/tex/latex/polytechnique/resources"
-copy *.pdf "%installdir%/tex/latex/polytechnique/resources"
-echo ************************************************
-echo * La base de donnees des packages est en train *
-echo * d'etre mise a jour. Cela peut prendre un peu *
-echo * de temps. Merci de patienter.                *
-echo ************************************************
-initexmf --update-fndb
-echo ************************************************
-echo * Le package a ete installe ! La documentation *
-echo * se trouve a l'emplacement suivant :          *
-echo %installdir%/doc/latex/polytechnique
-echo * Les fichiers sources et resources  a         *
-echo * l'endroit suivant :                          *
-echo %installdir%/source/latex/polytechnique
-echo * Et le .sty a l'endroit suivant :             *
-echo %installdir%/tex/latex/polytechnique
-echo * Bonne utilisation !                          *
-echo ************************************************
-pause
\ No newline at end of file

source/Makefile

-.PHONY: package install clean cleandist
-
-V:=1
-
-ifeq ("$V","1")
-define say
-	@tput setaf 4
-	@echo $1
-	@tput sgr0
-endef
-else
-define say
-endef
-endif
-
-define installed
-	@tput setaf 2
-	@tput bold
-	@echo "SUCCESS : installed in '"$1"'."
-endef
-
-PDFLATEX:=pdflatex -interaction=nonstopmode
-MAKEINDEX:=makeindex -q -s gind.ist -o
-OUTPUT:=>/dev/null 2>&1
-PKGDIR:=$(shell kpsewhich --show-path=ls-R | tr : '\n' | grep texmf | grep local | head -n1)
-POLYPKGDIR:=$(PKGDIR)/tex/latex/polytechnique
-DTXFILES:=$(shell find . -name '*.dtx')
-GENFILES:=$(patsubst %.dtx,%.pdf,$(DTXFILES)) $(patsubst %.dtx,%.sty,$(DTXFILES))
-
-all: package
-
-package: polytechnique.sty
-
-%.sty: %.dtx
-	$(call say,creating package file $@)
-	@$(PDFLATEX) $*.dtx $(OUTPUT)
-	@$(MAKEINDEX) $*.ind $*.idx $(OUTPUT)
-	@$(PDFLATEX) $*.dtx $(OUTPUT)
-
-install: package clean
-	$(call say,creating destination $(POLYPKGDIR))
-	@mkdir -p $(POLYPKGDIR)
-	$(call say,copying files to $(POLYPKGDIR))
-	@cp -r . $(POLYPKGDIR)
-	@rm -f $(POLYPKGDIR)/Makefile
-	@texhash || mktexlsr
-	$(call installed,$(POLYPKGDIR))
-
-clean:
-	$(call say,cleaning files)
-	@rm -f polytechnique.aux polytechnique.glo polytechnique.idx polytechnique.log polytechnique.out polytechnique.toc polytechnique.ind polytechnique.ilg
-
-cleandist: clean
-	$(call say,removing doc and package files)
-	@rm -f $(GENFILES)
-
-%.pdf: %.eps
-	ps2pdf -dEPSCrop -dCompressPages=false $< - | \
-		sed '/^..*g$$/ s/^./%/' > $@